removed warnings
[libfirm] / ir / tr / typegmod.h
index 22d8719..38d4683 100644 (file)
@@ -1,5 +1,11 @@
-
-/* $Id$ */
+/*
+ * typegmod.h
+ *
+ * (C) 2001 by Universitaet Karlsruhe
+ * Goetz Lindenmaier
+ *
+ * $Id$
+ */
 
 # ifndef _TYPEGMOD_H_
 # define _TYPEGMOD_H_
 
 /**
  *
- *  file typegmod.h
- *   (C) 2001 by Universitaet Karlsruhe
- *   Goetz Lindenmaier
+ * @file typegmod.h
  *  This module supplies routines that support changing the type graph.
  */
 
 /**
+ *   replaces one type by the other.
  *
- *   - replaces one type by the other.
- *   @param The old type that shall be replaced by the new type.
  *   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.
  *   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);
 
 /**
+ *   skip id types until a useful type is reached.
  *
- *   - skip id types until a useful type is reached.
- *   @param A type of arbitrary kind.
- *   tp if it is not an id type.
- *   If tp is an id type retruns the real type it stands for.
+ *   @param tp - A type of arbitrary kind.
  *
+ *   @return
+ *   tp if it is not an id type.
+ *   If tp is an id type returns the real type it stands for.
  */
 INLINE type *skip_tid(type *tp);