From 16eb5aad86dbc0ff0d4bf0c59bd2ad15109b29ff Mon Sep 17 00:00:00 2001
From: Michael Beck <beck@ipd.info.uni-karlsruhe.de>
Date: Fri, 31 Jan 2003 17:25:42 +0000
Subject: [PATCH] doxygen comments added

[r711]
---
 ir/common/firm_common.h   | 29 ++++++++++++++++++-----------
 ir/common/firm_common_t.h | 23 +++++++++++++----------
 ir/tr/type_or_entity.h    | 18 +++++++++++-------
 3 files changed, 42 insertions(+), 28 deletions(-)

diff --git a/ir/common/firm_common.h b/ir/common/firm_common.h
index 233efc3db..090a19f97 100644
--- a/ir/common/firm_common.h
+++ b/ir/common/firm_common.h
@@ -1,12 +1,15 @@
 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
 * All rights reserved.
-*
-* Authors: Martin Trapp, Christian Schaefer &
-*          Goetz Lindenmaier
-*
-* firm_common.h: common firm declarations
 */
 
+/**
+ * @file firm_common.h
+ *
+ * common firm declarations
+ *
+ * @author Martin Trapp, Christian Schaefer & Goetz Lindenmaier
+ */
+
 /* $Id$ */
 
 # ifndef _FIRM_COMMON_H_
@@ -20,18 +23,22 @@
 #endif
 #endif
 
-/* a list of firm kinds */
+/** a list of firm kinds */
 typedef enum {
-  k_entity,
-  k_type,
-  k_ir_node,
+  k_entity,     /**< an entity */
+  k_type,       /**< a type */
+  k_ir_node,    /**< an ir node */
   k_ir_loop
 } firm_kind;
 
-/* returns the kind of the thing */
+/**
+ * Returns the kind of a thing.
+ *
+ * @param firm_thing  pointer repraesenting a firm object
+ */
 firm_kind get_kind(void *firm_thing);
 
-/* returns a string. */
+/** Returns the kind of a thing as a string. */
 const char* print_firm_kind(void *firm_thing);
 
 # endif /*_FIRM_COMMON_H_ */
diff --git a/ir/common/firm_common_t.h b/ir/common/firm_common_t.h
index 60bb59a2e..2510450fa 100644
--- a/ir/common/firm_common_t.h
+++ b/ir/common/firm_common_t.h
@@ -1,12 +1,15 @@
 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
 * All rights reserved.
-*
-* Authors: Martin Trapp, Christian Schaefer &
-*          Goetz Lindenmaier
-*
-* firm_common_t.h: preprocessor flags
 */
 
+/**
+ * @file firm_common_t.h
+ *
+ * preprocessor flags
+ *
+ * @author Martin Trapp, Christian Schaefer & Goetz Lindenmaier
+ */
+
 /* $Id$ */
 
 # ifndef _COMMON_T_H_
@@ -14,21 +17,21 @@
 
 #include "firm_common.h"
 
-/** Global flags.  Set these by autoconf?? **/
+/* --- Global flags.  Set these by autoconf?? --- */
 
-/* When set Phi node construction uses the values valid when the fragile
+/** When set Phi node construction uses the values valid when the fragile
    operation is executed.  Else it uses the values valid at the end of the
    block with the fragile operation. */
 #define PRECISE_EXC_CONTEXT 1
 
-/* There are two implementations of the Phi node construction.  The first
+/** There are two implementations of the Phi node construction.  The first
    is faster, but does not work for blocks with more than 2 predecessors.
    The second works always but is slower and causes more unnecessary Phi
    nodes.
    Select the implementations by the following preprocessor flag: */
 #define USE_FAST_PHI_CONSTRUCTION 0
 
-/* Further there are two versions of the fast Phi node construction.
+/** Further there are two versions of the fast Phi node construction.
    If the following flag is set, new_r_Phi_in uses an explicit stack for
    allocating and deallocating Phi nodes.  Else it uses the obstack
    as a stack! */
@@ -44,7 +47,7 @@
 # include <config.h>
 #endif
 
-/* If this and DEBUG_libfirm are defined irdump uses the nodeid numbers as
+/** If this and DEBUG_libfirm are defined irdump uses the nodeid numbers as
    labels for the vcg nodes.  This makes the vcg graph better readable.
    Sometimes it's useful to see the pointer values, though. */
 #define NODEID_AS_LABEL 1
diff --git a/ir/tr/type_or_entity.h b/ir/tr/type_or_entity.h
index ef4a12f14..4d3fc762f 100644
--- a/ir/tr/type_or_entity.h
+++ b/ir/tr/type_or_entity.h
@@ -1,21 +1,25 @@
 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
-
 * All rights reserved.
-*
-* Author: Goetz Lindenmaier
-*
 */
 
+/**
+ * @file type_or_entity.h
+ *
+ * Provides a datatype to treat types and entities as the same.
+ *
+ * @author Goetz Lindenmaier
+ */
+
 /* $Id$ */
 
-/* A datatype to treat types and entities as the same. */
 
 # ifndef _TYPE_OR_ENTITY_H_
 # define _TYPE_OR_ENTITY_H_
 
+/** A datatype to treat types and entities as the same. */
 typedef union {
-  struct type   *typ;
-  struct entity *ent;
+  struct type   *typ;     /**< points to a type */
+  struct entity *ent;     /**< points to an entity */
 } type_or_ent;
 
 
-- 
2.20.1