From f1fba3a2d9ee8c73156919fb1f31177c5d7ab8bb Mon Sep 17 00:00:00 2001 From: Michael Beck Date: Tue, 14 Jan 2003 16:07:34 +0000 Subject: [PATCH] Fixed doxygen docu. [r622] --- ir/tr/typegmod.h | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/ir/tr/typegmod.h b/ir/tr/typegmod.h index 22d8719c3..38d468318 100644 --- a/ir/tr/typegmod.h +++ b/ir/tr/typegmod.h @@ -1,5 +1,11 @@ - -/* $Id$ */ +/* + * typegmod.h + * + * (C) 2001 by Universitaet Karlsruhe + * Goetz Lindenmaier + * + * $Id$ + */ # ifndef _TYPEGMOD_H_ # define _TYPEGMOD_H_ @@ -8,16 +14,13 @@ /** * - * 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. @@ -26,16 +29,20 @@ * 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); -- 2.20.1