X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Ftr%2Ftypegmod.h;h=bfdd7c22127288235c2ff3ea1e21efe14b3a3333;hb=ec68b2aaadb9504d101e6cbc4a58c69f3897f489;hp=256f20cc431efac8c24e851ea53c4d65c15089b0;hpb=070c584503510c8181cc4ac3f20b42ac7b0d4bc1;p=libfirm

diff --git a/ir/tr/typegmod.h b/ir/tr/typegmod.h
index 256f20cc4..bfdd7c221 100644
--- a/ir/tr/typegmod.h
+++ b/ir/tr/typegmod.h
@@ -1,55 +1,51 @@
+/*
+ * Project:     libFIRM
+ * File name:   ir/tr/typegmod.h
+ * Purpose:     Functionality to modify the type graph.
+ * Author:      Goetz Lindenmaier
+ * Modified by:
+ * Created:
+ * CVS-ID:      $Id$
+ * Copyright:   (c) 2001-2003 Universität Karlsruhe
+ * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ */
+
 
 # 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
+/** 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.
+ *  All referenced to this memory will be lost after a certain while.
+ *  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.
  *
- * 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
- *   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.
- *   All referenced to this memory will be lost after a certain while.
- *   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.
- ***
  */
-inline void exchange_types(type *old_type, type *new_type);
+void exchange_types(type *old_type, type *new_type);
 
-/****f* tpop/skip_tid
+/** Skip id types until a useful type is reached.
+ *
+ *  @param tp - A type of arbitrary kind.
  *
- * 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
- *   tp if it is not an id type.
- *   If tp is an id type retruns the real type it stands for.
- ***
+ *  @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);
+type *skip_tid(type *tp);
 
 # endif /*_TYPEGMOD_H_ */