doxygen comments added

[libfirm] / ir / common / firm_common.h

diff --git a/ir/common/firm_common.h b/ir/common/firm_common.h
index d994d45..090a19f 100644 (file)
--- 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
+* All rights reserved.
 */
 
+/**
+ * @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_ */