added doxygen comments, credited backend to Oliver Richter and Tobias Gneist

[r13578]

diff --git a/ir/be/arm/arm_emitter.c b/ir/be/arm/arm_emitter.c
index 7afd3d1..5249089 100644 (file)
--- a/ir/be/arm/arm_emitter.c
+++ b/ir/be/arm/arm_emitter.c
@@ -17,9 +17,13 @@
  * PURPOSE.
  */
 
+/**
+ * @file
+ * @brief   arm emitter
+ * @author  Oliver Richter, Tobias Gneist
+ * @version $Id$
+ */
 #define SILENCER
-/* arm emitter */
-/* $Id$ */
 
 #ifdef HAVE_CONFIG_H
 #include "config.h"

diff --git a/ir/be/arm/arm_emitter.h b/ir/be/arm/arm_emitter.h
index c063997..3fd526f 100644 (file)
--- a/ir/be/arm/arm_emitter.h
+++ b/ir/be/arm/arm_emitter.h
@@ -17,8 +17,14 @@
  * PURPOSE.
  */
 
-#ifndef _ARM_EMITTER_H_
-#define _ARM_EMITTER_H_
+/**
+ * @file
+ * @brief   declarations for arm emitter
+ * @author  Oliver Richter, Tobias Gneis
+ * @version $Id$
+ */
+#ifndef FIRM_BE_ARM_ARM_EMITTER_H
+#define FIRM_BE_ARM_ARM_EMITTER_H
 
 #include "firm_types.h"
 #include "irargs_t.h"
@@ -74,4 +80,4 @@ typedef enum sections {
  */
 void arm_switch_section(FILE *f, sections sec);
 
-#endif /* _ARM_EMITTER_H_ */
+#endif

diff --git a/ir/be/arm/arm_gen_decls.c b/ir/be/arm/arm_gen_decls.c
index 46fa546..d49cf28 100644 (file)
--- a/ir/be/arm/arm_gen_decls.c
+++ b/ir/be/arm/arm_gen_decls.c
@@ -18,8 +18,10 @@
  */
 
 /**
- * Dumps global variables and constants as arm assembler.
- * @date 14.02.2006
+ * @file
+ * @brief   dumps global variables and constants as arm assembler.
+ * @author  Oliver Richter, Tobias Gneist
+ * @date    14.02.2006
  * @version $Id$
  */
 #ifdef HAVE_CONFIG_H

diff --git a/ir/be/arm/arm_gen_decls.h b/ir/be/arm/arm_gen_decls.h
index c55e4a5..9876d56 100644 (file)
--- a/ir/be/arm/arm_gen_decls.h
+++ b/ir/be/arm/arm_gen_decls.h
@@ -17,12 +17,18 @@
  * PURPOSE.
  */
 
-#ifndef _ARM_GEN_DECLS_H_
-#define _ARM_GEN_DECLS_H_
+/**
+ * @file
+ * @brief   declarations for arm initializer generation
+ * @author  Oliver Richter, Tobias Gneist
+ * @version $Id$
+ */
+#ifndef FIRM_BE_ARM_ARM_GEN_DECLS_H
+#define FIRM_BE_ARM_ARM_GEN_DECLS_H
 
 /**
  * Generate all entities.
  */
 void arm_gen_decls(FILE *out);
 
-#endif /* _ARM_GEN_DECLS_H_ */
+#endif

diff --git a/ir/be/arm/arm_map_regs.c b/ir/be/arm/arm_map_regs.c
index e30924b..be81948 100644 (file)
--- a/ir/be/arm/arm_map_regs.c
+++ b/ir/be/arm/arm_map_regs.c
@@ -18,8 +18,10 @@
  */
 
 /**
- * Register mapping for firm nodes. Stolen from bearch_firm :)
- * $Id$
+ * @file
+ * @brief   Register mapping for firm nodes. Stolen from bearch_firm :)
+ * @author  Oliver Richter, Tobias Gneist
+ * @version $Id$
  */
 #ifdef HAVE_CONFIG_H
 #include "config.h"

diff --git a/ir/be/arm/arm_map_regs.h b/ir/be/arm/arm_map_regs.h
index 85cb2b7..4a59c3a 100644 (file)
--- a/ir/be/arm/arm_map_regs.h
+++ b/ir/be/arm/arm_map_regs.h
@@ -17,38 +17,27 @@
  * PURPOSE.
  */
 
-#ifndef _arm_MAP_REGS_H_
-
-#define _arm_MAP_REGS_H_
-
-
+/**
+ * @file
+ * @brief  declarations for arm register allocation
+ * @author Oliver Richter, Tobias Gneist
+ * @version $Id$
+ */
+#ifndef FIRM_BE_ARM_ARM_MAP_REGS_H
+#define FIRM_BE_ARM_ARM_MAP_REGS_H
 
 #include "irnode.h"
-
 #include "set.h"
 
-
-
 #include "../bearch_t.h"
-
 #include "arm_nodes_attr.h"
 
-
-
 const arch_register_t *arm_get_RegParam_reg(int n);
 
-
-
 int  arm_cmp_irn_reg_assoc(const void *a, const void *b, size_t len);
-
 void arm_set_firm_reg(ir_node *irn, const arch_register_t *reg, set *reg_set);
-
 const arch_register_t *arm_get_firm_reg(const ir_node *irn, set *reg_set);
 
-
-
 long arm_translate_proj_pos(const ir_node *proj);
 
-
-
-#endif /* _arm_MAP_REGS_H_ */
+#endif

diff --git a/ir/be/arm/arm_new_nodes.c b/ir/be/arm/arm_new_nodes.c
index 4e3802f..f0b677b 100644 (file)
--- a/ir/be/arm/arm_new_nodes.c
+++ b/ir/be/arm/arm_new_nodes.c
@@ -18,9 +18,12 @@
  */
 
 /**
- * This file implements the creation of the architecture specific firm opcodes
- * and the corresponding node constructors for the arm assembler irg.
- * $Id$
+ * @file
+ * @brief  This file implements the creation of the architecture specific firm
+ *         opcodes and the corresponding node constructors for the arm
+ *         assembler irg.
+ * @author Oliver Richter, Tobias Gneist
+ * @version $Id$
  */
 #ifdef HAVE_CONFIG_H
 #include "config.h"
@@ -621,6 +624,5 @@ void arm_set_optimizers(void) {
        */
 }
 
-
 /* Include the generated constructor functions */
 #include "gen_arm_new_nodes.c.inl"

diff --git a/ir/be/arm/arm_new_nodes.h b/ir/be/arm/arm_new_nodes.h
index 691c7d6..4fe2b9e 100644 (file)
--- a/ir/be/arm/arm_new_nodes.h
+++ b/ir/be/arm/arm_new_nodes.h
@@ -17,13 +17,14 @@
  * PURPOSE.
  */
 
-#ifndef _ARM_NEW_NODES_H_
-#define _ARM_NEW_NODES_H_
-
 /**
- * Function prototypes for the assembler ir node constructors.
- * $Id$
+ * @file
+ * @brief   Function prototypes for the assembler ir node constructors.
+ * @author  Oliver Richter, Tobias Gneist
+ * @version $Id$
  */
+#ifndef FIRM_BE_ARM_ARM_NEW_NODES_H
+#define FIRM_BE_ARM_ARM_NEW_NODES_H
 
 #include "arm_nodes_attr.h"
 #include "bearch_arm_t.h"
@@ -184,4 +185,4 @@ unsigned int arm_decode_imm_w_shift(tarval *tv);
 /* Include the generated headers */
 #include "gen_arm_new_nodes.h"
 
-#endif /* _ARM_NEW_NODES_H_ */
+#endif

diff --git a/ir/be/arm/arm_nodes_attr.h b/ir/be/arm/arm_nodes_attr.h
index 3610181..86a95f9 100644 (file)
--- a/ir/be/arm/arm_nodes_attr.h
+++ b/ir/be/arm/arm_nodes_attr.h
@@ -17,8 +17,14 @@
  * PURPOSE.
  */
 
-#ifndef _ARM_NODES_ATTR_H_
-#define _ARM_NODES_ATTR_H_
+/**
+ * @file
+ * @brief   declarations for arm node attributes
+ * @author  Oliver Richter, Tobias Gneist
+ * @version $Id$
+ */
+#ifndef FIRM_BE_ARM_ARM_NODES_ATTR_H
+#define FIRM_BE_ARM_ARM_NODES_ATTR_H
 
 #include "../bearch_t.h"
 #include "../../common/firm_types.h"
@@ -98,4 +104,4 @@ typedef struct _arm_attr_t {
  */
 const char *arm_shf_mod_name(arm_shift_modifier mod);
 
-#endif /* _ARM_NODES_ATTR_H_ */
+#endif

diff --git a/ir/be/arm/arm_transform.c b/ir/be/arm/arm_transform.c
index 75c820c..3981d01 100644 (file)
--- a/ir/be/arm/arm_transform.c
+++ b/ir/be/arm/arm_transform.c
@@ -17,9 +17,12 @@
  * PURPOSE.
  */
 
-/* The codegenerator (transform FIRM into arm FIRM */
-/* $Id$ */
-
+/**
+ * @file
+ * @brief   The codegenerator (transform FIRM into arm FIRM
+ * @author  Oliver Richter, Tobias Gneist
+ * @version $Id$
+ */
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif

diff --git a/ir/be/arm/arm_transform.h b/ir/be/arm/arm_transform.h
index 5708d10..352d629 100644 (file)
--- a/ir/be/arm/arm_transform.h
+++ b/ir/be/arm/arm_transform.h
@@ -17,8 +17,14 @@
  * PURPOSE.
  */
 
-#ifndef _ARM_TRANSFORM_H_
-#define _ARM_TRANSFORM_H_
+/**
+ * @file
+ * @brief   declarations for transform functions (code selection)
+ * @author  Oliver Richter, Tobias Gneist
+ * @version $Id$
+ */
+#ifndef FIRM_BE_ARM_ARM_TRANSFORM_H
+#define FIRM_BE_ARM_ARM_TRANSFORM_H
 
 void arm_move_consts(ir_node *node, void *env);
 void arm_move_symconsts(ir_node *node, void *env);
@@ -26,4 +32,4 @@ void arm_move_symconsts(ir_node *node, void *env);
 void arm_register_transformers(void);
 void arm_transform_node(ir_node *node, void *env);
 
-#endif /* _ARM_TRANSFORM_H_ */
+#endif

diff --git a/ir/be/arm/bearch_arm.c b/ir/be/arm/bearch_arm.c
index f9bb46a..3740a83 100644 (file)
--- a/ir/be/arm/bearch_arm.c
+++ b/ir/be/arm/bearch_arm.c
@@ -17,9 +17,12 @@
  * PURPOSE.
  */
 
-/* The main arm backend driver file. */
-/* $Id$ */
-
+/**
+ * @file
+ * @brief   The main arm backend driver file.
+ * @author  Oliver Richter, Tobias Gneist
+ * @version $Id$
+ */
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif

diff --git a/ir/be/arm/bearch_arm.h b/ir/be/arm/bearch_arm.h
index 35069dd..bc41ccd 100644 (file)
--- a/ir/be/arm/bearch_arm.h
+++ b/ir/be/arm/bearch_arm.h
@@ -17,11 +17,17 @@
  * PURPOSE.
  */
 
-#ifndef _BEARCH_ARM_H_
-#define _BEARCH_ARM_H_
+/**
+ * @file
+ * @brief   declarations for arm backend
+ * @author  Oliver Richter, Tobias Gneist
+ * @version $Id$
+ */
+#ifndef FIRM_BE_ARM_BEARCH_ARM_H
+#define FIRM_BE_ARM_BEARCH_ARM_H
 
 #include "../bearch_t.h"
 
 extern const arch_isa_if_t arm_isa_if;
 
-#endif /* _BEARCH_ARM_H_ */
+#endif

diff --git a/ir/be/arm/bearch_arm_t.h b/ir/be/arm/bearch_arm_t.h
index 5ec88d5..d956c14 100644 (file)
--- a/ir/be/arm/bearch_arm_t.h
+++ b/ir/be/arm/bearch_arm_t.h
@@ -17,8 +17,14 @@
  * PURPOSE.
  */
 
-#ifndef _BEARCH_ARM_T_H_
-#define _BEARCH_ARM_T_H_
+/**
+ * @file
+ * @brief   declarations for arm backend -- private header
+ * @author  Oliver Richter, Tobias Gneist
+ * @version $Id$
+ */
+#ifndef FIRM_BE_ARM_BEARCH_ARM_T_H
+#define FIRM_BE_ARM_BEARCH_ARM_T_H
 
 #include <stdio.h>
 
@@ -161,4 +167,4 @@ typedef struct _arm_irn_ops_t {
 } arm_irn_ops_t;
 
 
-#endif /* _BEARCH_ARM_T_H_ */
+#endif