adjust doxygen comments

[r13566]

diff --git a/ir/be/TEMPLATE/TEMPLATE_emitter.c b/ir/be/TEMPLATE/TEMPLATE_emitter.c
index 90719e9..a82a454 100644 (file)
--- a/ir/be/TEMPLATE/TEMPLATE_emitter.c
+++ b/ir/be/TEMPLATE/TEMPLATE_emitter.c
@@ -17,8 +17,11 @@
  * PURPOSE.
  */
 
-/* TEMPLATE emitter */
-/* $Id$ */
+/**
+ * @file
+ * @brief   emit assembler for a backend graph
+ * @version $Id$
+ */
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif

diff --git a/ir/be/TEMPLATE/TEMPLATE_emitter.h b/ir/be/TEMPLATE/TEMPLATE_emitter.h
index 4ec1067..c124b63 100644 (file)
--- a/ir/be/TEMPLATE/TEMPLATE_emitter.h
+++ b/ir/be/TEMPLATE/TEMPLATE_emitter.h
@@ -17,8 +17,13 @@
  * PURPOSE.
  */
 
-#ifndef _TEMPLATE_EMITTER_H_
-#define _TEMPLATE_EMITTER_H_
+/**
+ * @file
+ * @brief    declarations for emit functions
+ * @version  $Id$
+ */
+#ifndef FIRM_BE_TEMPLATE_TEMPLATE_EMITTER_H
+#define FIRM_BE_TEMPLATE_TEMPLATE_EMITTER_H
 
 #include "irargs_t.h"  // this also inlucdes <libcore/lc_print.h>
 #include "irnode.h"
@@ -46,4 +51,4 @@ const char *get_TEMPLATE_in_reg_name(ir_node *irn, int pos);
 
 void TEMPLATE_gen_routine(const TEMPLATE_code_gen_t *cg, ir_graph *irg);
 
-#endif /* _TEMPLATE_EMITTER_H_ */
+#endif

diff --git a/ir/be/TEMPLATE/TEMPLATE_map_regs.h b/ir/be/TEMPLATE/TEMPLATE_map_regs.h
index 686e6a0..a27794a 100644 (file)
--- a/ir/be/TEMPLATE/TEMPLATE_map_regs.h
+++ b/ir/be/TEMPLATE/TEMPLATE_map_regs.h
@@ -17,8 +17,13 @@
  * PURPOSE.
  */
 
-#ifndef _TEMPLATE_MAP_REGS_H_
-#define _TEMPLATE_MAP_REGS_H_
+/**
+ * @file
+ * @brief   declarations for the register allocation interface
+ * @version $Id$
+ */
+#ifndef FIRM_BE_TEMPLATE_TEMPLATE_MAP_REGS_H
+#define FIRM_BE_TEMPLATE_TEMPLATE_MAP_REGS_H
 
 #include "irnode.h"
 #include "set.h"
@@ -32,4 +37,4 @@ const arch_register_t *TEMPLATE_get_firm_reg(const ir_node *irn, set *reg_set);
 
 long TEMPLATE_translate_proj_pos(const ir_node *proj);
 
-#endif /* _TEMPLATE_MAP_REGS_H_ */
+#endif

diff --git a/ir/be/TEMPLATE/TEMPLATE_new_nodes.c b/ir/be/TEMPLATE/TEMPLATE_new_nodes.c
index ebc356a..5c5b1d5 100644 (file)
--- a/ir/be/TEMPLATE/TEMPLATE_new_nodes.c
+++ b/ir/be/TEMPLATE/TEMPLATE_new_nodes.c
@@ -18,9 +18,11 @@
  */
 
 /**
- * This file implements the creation of the achitecture specific firm opcodes
- * and the coresponding node constructors for the TEMPLATE assembler irg.
- * $Id$
+ * @file
+ * @brief   This file implements the creation of the achitecture specific firm
+ *          opcodes and the coresponding node constructors for the TEMPLATE
+ *          assembler irg.
+ * @version $Id$
  */
 #ifdef HAVE_CONFIG_H
 #include "config.h"

diff --git a/ir/be/TEMPLATE/TEMPLATE_new_nodes.h b/ir/be/TEMPLATE/TEMPLATE_new_nodes.h
index 12dac72..05cfe6a 100644 (file)
--- a/ir/be/TEMPLATE/TEMPLATE_new_nodes.h
+++ b/ir/be/TEMPLATE/TEMPLATE_new_nodes.h
@@ -17,13 +17,13 @@
  * PURPOSE.
  */
 
-#ifndef _TEMPLATE_NEW_NODES_H_
-#define _TEMPLATE_NEW_NODES_H_
-
 /**
- * Function prototypes for the assembler ir node constructors.
- * $Id$
+ * @file
+ * @brief   Function prototypes for the assembler ir node constructors.
+ * @version $Id$
  */
+#ifndef FIRM_BE_TEMPALTE_TEMPLATE_NEW_NODES_H
+#define FIRM_BE_TEMPLATE_TEMPLATE_NEW_NODES_H
 
 #include "TEMPLATE_nodes_attr.h"
 
@@ -117,4 +117,4 @@ int get_TEMPLATE_n_res(const ir_node *node);
 /* Include the generated headers */
 #include "gen_TEMPLATE_new_nodes.h"
 
-#endif /* _TEMPLATE_NEW_NODES_H_ */
+#endif

diff --git a/ir/be/TEMPLATE/TEMPLATE_nodes_attr.h b/ir/be/TEMPLATE/TEMPLATE_nodes_attr.h
index 78b9227..bb47353 100644 (file)
--- a/ir/be/TEMPLATE/TEMPLATE_nodes_attr.h
+++ b/ir/be/TEMPLATE/TEMPLATE_nodes_attr.h
@@ -17,12 +17,20 @@
  * PURPOSE.
  */
 
-#ifndef _TEMPLATE_NODES_ATTR_H_
-#define _TEMPLATE_NODES_ATTR_H_
+/**
+ * @file
+ * @brief   attributes attached to all TEMPLATE nodes
+ * @version $Id$
+ */
+#ifndef FIRM_BE_TEMPLATE_TEMPLATE_NODES_ATTR_H
+#define FIRM_BE_TEMPLATE_TEMPLATE_NODES_ATTR_H
 
 #include "../bearch_t.h"
 
-typedef struct _TEMPLATE_attr_t {
+typedef struct TEMPLATE_attr_t  TEMPLATE_attr_t;
+
+struct TEMPLATE_attr_t
+{
        arch_irn_flags_t flags;     /**< indicating if spillable, rematerializeable ... etc. */
        int              n_res;     /**< number of results for this node */
 
@@ -31,6 +39,6 @@ typedef struct _TEMPLATE_attr_t {
 
        /* must be last, dynamically allocated */
        const arch_register_t *slots[1];         /**< register slots for assigned registers */
-} TEMPLATE_attr_t;
+};
 
-#endif /* _TEMPLATE_NODES_ATTR_H_ */
+#endif

diff --git a/ir/be/TEMPLATE/TEMPLATE_transform.c b/ir/be/TEMPLATE/TEMPLATE_transform.c
index 5e6e8d9..f502b8f 100644 (file)
--- a/ir/be/TEMPLATE/TEMPLATE_transform.c
+++ b/ir/be/TEMPLATE/TEMPLATE_transform.c
@@ -17,8 +17,11 @@
  * PURPOSE.
  */
 
-/* The codegenrator (transform FIRM into TEMPLATE FIRM */
-/* $Id$ */
+/**
+ * @file
+ * @brief   code selection (transform FIRM into TEMPLATE FIRM)
+ * @version $Id$
+ */
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif

diff --git a/ir/be/TEMPLATE/TEMPLATE_transform.h b/ir/be/TEMPLATE/TEMPLATE_transform.h
index dd541d6..7ebb682 100644 (file)
--- a/ir/be/TEMPLATE/TEMPLATE_transform.h
+++ b/ir/be/TEMPLATE/TEMPLATE_transform.h
@@ -17,9 +17,14 @@
  * PURPOSE.
  */
 
-#ifndef _TEMPLATE_TRANSFORM_H_
-#define _TEMPLATE_TRANSFORM_H_
+/**
+ * @file
+ * @brief   declaration for the transform function (code selection)
+ * @version $Id$
+ */
+#ifndef FIRM_BE_TEMPLATE_TEMPLATE_TRANSFORM_H
+#define FIRM_BE_TEMPLATE_TEMPLATE_TRANSFORM_H
 
 void TEMPLATE_transform_node(ir_node *node, void *env);
 
-#endif /* _TEMPLATE_TRANSFORM_H_ */
+#endif

diff --git a/ir/be/TEMPLATE/bearch_TEMPLATE.c b/ir/be/TEMPLATE/bearch_TEMPLATE.c
index 5c4a6bc..e7b09b4 100644 (file)
--- a/ir/be/TEMPLATE/bearch_TEMPLATE.c
+++ b/ir/be/TEMPLATE/bearch_TEMPLATE.c
@@ -17,8 +17,11 @@
  * PURPOSE.
  */
 
-/* The main TEMPLATE backend driver file. */
-/* $Id$ */
+/**
+ * @file
+ * @brief    The main TEMPLATE backend driver file.
+ * @version  $Id$
+ */
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif

diff --git a/ir/be/TEMPLATE/bearch_TEMPLATE.h b/ir/be/TEMPLATE/bearch_TEMPLATE.h
index 5e070fd..cc4aa36 100644 (file)
--- a/ir/be/TEMPLATE/bearch_TEMPLATE.h
+++ b/ir/be/TEMPLATE/bearch_TEMPLATE.h
@@ -16,12 +16,11 @@
  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  * PURPOSE.
  */
-
-#ifndef _BEARCH_TEMPLATE_H_
-#define _BEARCH_TEMPLATE_H_
+#ifndef FIRM_BE_TEMPLATE_BEARCH_TEMPLATE_H
+#define FIRM_BE_TEMPLATE_BEARCH_TEMPLATE_H
 
 #include "../bearch_t.h"
 
 extern const arch_isa_if_t TEMPLATE_isa_if;
 
-#endif /* _BEARCH_TEMPLATE_H_ */
+#endif

diff --git a/ir/be/TEMPLATE/bearch_TEMPLATE_t.h b/ir/be/TEMPLATE/bearch_TEMPLATE_t.h
index 0dd580f..259f1d5 100644 (file)
--- a/ir/be/TEMPLATE/bearch_TEMPLATE_t.h
+++ b/ir/be/TEMPLATE/bearch_TEMPLATE_t.h
@@ -16,9 +16,8 @@
  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  * PURPOSE.
  */
-
-#ifndef _BEARCH_TEMPLATE_T_H_
-#define _BEARCH_TEMPLATE_T_H_
+#ifndef FIRM_BE_IA32_BEARCH_TEMPLATE_T_H
+#define FIRM_BE_IA32_BEARCH_TEMPLATE_T_H
 
 #include "debug.h"
 #include "bearch_TEMPLATE.h"
@@ -27,9 +26,12 @@
 #include "../beemitter.h"
 #include "set.h"
 
-typedef struct _TEMPLATE_isa_t TEMPLATE_isa_t;
+typedef struct TEMPLATE_isa_t            TEMPLATE_isa_t;
+typedef struct TEMPLATE_code_gen_t       TEMPLATE_code_gen_t;
+typedef struct TEMPLATE_irn_ops_t        TEMPLATE_irn_ops_t;
+typedef struct TEMPLATE_transform_env_t  TEMPLATE_transform_env_t;
 
-typedef struct _TEMPLATE_code_gen_t {
+struct TEMPLATE_code_gen_t {
        const arch_code_generator_if_t *impl;           /**< implementation */
        ir_graph                       *irg;            /**< current irg */
        const arch_env_t               *arch_env;       /**< the arch env */
@@ -37,30 +39,29 @@ typedef struct _TEMPLATE_code_gen_t {
        TEMPLATE_isa_t                 *isa;            /**< the isa instance */
        const be_irg_t                 *birg;           /**< The be-irg (contains additional information about the irg) */
        DEBUG_ONLY(firm_dbg_module_t   *mod;)           /**< debugging module */
-} TEMPLATE_code_gen_t;
+};
 
-struct _TEMPLATE_isa_t {
+struct TEMPLATE_isa_t {
        arch_isa_t             arch_isa;      /**< must be derived from arch_isa */
        be_emit_env_t          emit;          /**< emit datastructure */
 };
 
-
-typedef struct _TEMPLATE_irn_ops_t {
+struct TEMPLATE_irn_ops_t {
        const arch_irn_ops_if_t *impl;
        TEMPLATE_code_gen_t     *cg;
-} TEMPLATE_irn_ops_t;
-
+};
 
-/* this is a struct to minimize the number of parameters
-   for transformation walker */
-typedef struct _TEMPLATE_transform_env_t {
+/**
+ * this is a struct to minimize the number of parameters
+ * for transformation walker
+ */
+struct TEMPLATE_transform_env_t {
        dbg_info          *dbg;      /**< The node debug info */
        ir_graph          *irg;      /**< The irg, the node should be created in */
        ir_node           *block;    /**< The block, the node should belong to */
        ir_node           *irn;      /**< The irn, to be transformed */
        ir_mode           *mode;     /**< The mode of the irn */
        DEBUG_ONLY(firm_dbg_module_t *mod;)      /**< The firm debugger */
-} TEMPLATE_transform_env_t;
-
+};
 
-#endif /* _BEARCH_TEMPLATE_T_H_ */
+#endif