-
-/* $Id$ */
+/*
+ * typegmod.h
+ *
+ * (C) 2001 by Universitaet Karlsruhe
+ * Goetz Lindenmaier
+ *
+ * $Id$
+ */
# ifndef _TYPEGMOD_H_
# define _TYPEGMOD_H_
# include "type.h"
-/****h* libfirm/typegmod
- *
- * NAME
- * file typegmod.h
- * COPYRIGHT
- * (C) 2001 by Universitaet Karlsruhe
- * AUTHORS
- * Goetz Lindenmaier
- * NOTES
+/**
+ *
+ * @file typegmod.h
* This module supplies routines that support changing the type graph.
- *****
*/
-/****f* tpop/exchange_types
- *
- * NAME
- * exchange_types -- replaces one type by the other.
- * SYNOPSIS
- * void exchange_types(type *old_type, type *new_type);
- * INPUTS
- * The old type that shall be replaced by the new type.
- * SIDE EFFECTS
+/**
+ * replaces one type by the other.
+ *
* Old type is replaced by new_type. All references to old_type
* now point to new_type. The memory for the old type is destroyed,
* but still used. Therefore it is not freed.
* An exception is the list of types in irp (irprog.h).
* In the future there might be a routine to recover the memory, but
* this will be at considerable runtime cost.
- ***
+ *
+ * @param old_type - The old type that shall be replaced by the new type.
+ * @param new_type - The new type that will replace old_type.
+ *
*/
INLINE void exchange_types(type *old_type, type *new_type);
-/****f* tpop/skip_tid
- *
- * NAME
- * skip_tid -- skip id types until a useful type is reached.
- * SYNOPSIS
- * type *skip_tid(type *tp)
- * INPUTS
- * A type of arbitrary kind.
- * RETURNS
+/**
+ * skip id types until a useful type is reached.
+ *
+ * @param tp - A type of arbitrary kind.
+ *
+ * @return
* tp if it is not an id type.
- * If tp is an id type retruns the real type it stands for.
- ***
+ * If tp is an id type returns the real type it stands for.
*/
INLINE type *skip_tid(type *tp);