From 7e989cfcf5ed8e74b41107d8a2baa6a1a1db215e Mon Sep 17 00:00:00 2001
From: Matthias Braun <matze@braunis.de>
Date: Wed, 2 May 2007 08:20:21 +0000
Subject: [PATCH] added doxygen comments, credited backend to Moritz Kroll and
 Jens Mueller

[r13576]
---
 ir/be/ppc32/bearch_ppc32.c         |  8 ++++++--
 ir/be/ppc32/bearch_ppc32.h         | 12 +++++++++---
 ir/be/ppc32/bearch_ppc32_t.h       | 13 +++++++++----
 ir/be/ppc32/ppc32_emitter.c        |  9 ++++++---
 ir/be/ppc32/ppc32_emitter.h        | 12 +++++++++---
 ir/be/ppc32/ppc32_gen_decls.h      | 12 +++++++++---
 ir/be/ppc32/ppc32_map_regs.c       |  6 ++++--
 ir/be/ppc32/ppc32_map_regs.h       | 12 +++++++++---
 ir/be/ppc32/ppc32_new_nodes.c      |  9 ++++++---
 ir/be/ppc32/ppc32_new_nodes.h      | 13 +++++++------
 ir/be/ppc32/ppc32_transform.c      |  9 ++++++---
 ir/be/ppc32/ppc32_transform.h      | 12 +++++++++---
 ir/be/ppc32/ppc32_transform_conv.c |  9 ++++++---
 ir/be/ppc32/ppc32_transform_conv.h | 12 +++++++++---
 14 files changed, 104 insertions(+), 44 deletions(-)

diff --git a/ir/be/ppc32/bearch_ppc32.c b/ir/be/ppc32/bearch_ppc32.c
index a0b7eb82e..9503396fe 100644
--- a/ir/be/ppc32/bearch_ppc32.c
+++ b/ir/be/ppc32/bearch_ppc32.c
@@ -17,8 +17,12 @@
  * PURPOSE.
  */
 
-/* The main ppc backend driver file. */
-/* $Id$ */
+/**
+ * @file
+ * @brief   The main ppc backend driver file.
+ * @author  Moritz Kroll, Jens Mueller
+ * @version $Id$
+ */
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/ir/be/ppc32/bearch_ppc32.h b/ir/be/ppc32/bearch_ppc32.h
index d8bc131d6..57047cb3c 100644
--- a/ir/be/ppc32/bearch_ppc32.h
+++ b/ir/be/ppc32/bearch_ppc32.h
@@ -17,11 +17,17 @@
  * PURPOSE.
  */
 
-#ifndef _BEARCH_PPC32_H_
-#define _BEARCH_PPC32_H_
+/**
+ * @file
+ * @brief   declarations for ppc32 backend
+ * @author  Moritz Kroll, Jens Mueller
+ * @version $Id$
+ */
+#ifndef FIRM_BE_PPC32_BEARCH_PPC32_H
+#define FIRM_BE_PPC32_BEARCH_PPC32_H
 
 #include "../bearch_t.h"
 
 extern const arch_isa_if_t ppc32_isa_if;
 
-#endif /* _BEARCH_PPC32_H_ */
+#endif
diff --git a/ir/be/ppc32/bearch_ppc32_t.h b/ir/be/ppc32/bearch_ppc32_t.h
index 8a9c0d6e2..9a8bf1429 100644
--- a/ir/be/ppc32/bearch_ppc32_t.h
+++ b/ir/be/ppc32/bearch_ppc32_t.h
@@ -17,8 +17,14 @@
  * PURPOSE.
  */
 
-#ifndef _BEARCH_PPC32_T_H_
-#define _BEARCH_PPC32_T_H_
+/**
+ * @file
+ * @brief   declarations for arm backend -- private header
+ * @author  Moritz Kroll, Jens Mueller
+ * @version $Id$
+ */
+#ifndef FIRM_BE_PPC32_BEARCH_PPC32_T_H
+#define FIRM_BE_PPC32_BEARCH_PPC32_T_H
 
 #include "debug.h"
 #include "bearch_ppc32.h"
@@ -71,5 +77,4 @@ typedef struct _ppc32_transform_env_t {
 	DEBUG_ONLY(firm_dbg_module_t *mod;) /**< The firm debugger */
 } ppc32_transform_env_t;
 
-
-#endif /* _BEARCH_PPC32_T_H_ */
+#endif
diff --git a/ir/be/ppc32/ppc32_emitter.c b/ir/be/ppc32/ppc32_emitter.c
index 91a0a0a53..7a532d5d7 100644
--- a/ir/be/ppc32/ppc32_emitter.c
+++ b/ir/be/ppc32/ppc32_emitter.c
@@ -17,9 +17,12 @@
  * PURPOSE.
  */
 
-/* ppc emitter */
-/* $Id$ */
-
+/**
+ * @file
+ * @brief   ppc emitter
+ * @author  Moritz Kroll, Jens Mueller
+ * @version $Id$
+ */
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/ir/be/ppc32/ppc32_emitter.h b/ir/be/ppc32/ppc32_emitter.h
index 8f8dd08a6..551025658 100644
--- a/ir/be/ppc32/ppc32_emitter.h
+++ b/ir/be/ppc32/ppc32_emitter.h
@@ -17,8 +17,14 @@
  * PURPOSE.
  */
 
-#ifndef _PPC32_EMITTER_H_
-#define _PPC32_EMITTER_H_
+/**
+ * @file
+ * @brief   declarations for ppc32 emitter
+ * @author  Moritz Kroll, Jens Mueller
+ * @version $Id$
+ */
+#ifndef FIRM_BE_PPC32_PPC32_EMITTER_H
+#define FIRM_BE_PPC32_PPC32_EMITTER_H
 
 #include "irargs_t.h"  // this also inlucdes <libcore/lc_print.h>
 #include "irnode.h"
@@ -47,4 +53,4 @@ void ppc32_gen_routine(FILE *F, ir_graph *irg, const ppc32_code_gen_t *cg);
 const char *ppc32_rlwimi_emit_helper(const ir_node *n, ppc32_emit_env_t *env);
 
 
-#endif /* _PPC32_EMITTER_H_ */
+#endif
diff --git a/ir/be/ppc32/ppc32_gen_decls.h b/ir/be/ppc32/ppc32_gen_decls.h
index 77e263337..8002ebbbe 100644
--- a/ir/be/ppc32/ppc32_gen_decls.h
+++ b/ir/be/ppc32/ppc32_gen_decls.h
@@ -17,12 +17,18 @@
  * PURPOSE.
  */
 
-#ifndef _PPC32_GEN_DECLS_H_
-#define _PPC32_GEN_DECLS_H_
+/**
+ * @file
+ * @brief   declarations for ppc global iniitializer emitter
+ * @author  Moritz Kroll, Jens Mueller
+ * @version $Id$
+ */
+#ifndef FIRM_BE_PPC32_PPC32_GEN_DECLS_H
+#define FIRM_BE_PPC32_PPC32_GEN_DECLS_H
 
 /**
  * Generate all entities.
  */
 void ppc32_gen_decls(FILE *out);
 
-#endif /* _PPC32_GEN_DECLS_H_ */
+#endif
diff --git a/ir/be/ppc32/ppc32_map_regs.c b/ir/be/ppc32/ppc32_map_regs.c
index ca3471e47..606e0ad08 100644
--- a/ir/be/ppc32/ppc32_map_regs.c
+++ b/ir/be/ppc32/ppc32_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  Moritz Kroll, Jens Mueller
+ * @version $Id$
  */
 #ifdef HAVE_CONFIG_H
 #include "config.h"
diff --git a/ir/be/ppc32/ppc32_map_regs.h b/ir/be/ppc32/ppc32_map_regs.h
index 800d8dd4b..d2f61b021 100644
--- a/ir/be/ppc32/ppc32_map_regs.h
+++ b/ir/be/ppc32/ppc32_map_regs.h
@@ -17,8 +17,14 @@
  * PURPOSE.
  */
 
-#ifndef _PPC32_MAP_REGS_H_
-#define _PPC32_MAP_REGS_H_
+/**
+ * @file
+ * @brief   declarations for register allocation interface of ppc32
+ * @author  Moritz Kroll, Jens Mueller
+ * @version $Id$
+ */
+#ifndef FIRM_BE_PPC32_PPC32_MAP_REGS_H
+#define FIRM_BE_PPC32_PPC32_MAP_REGS_H
 
 #include "irnode.h"
 #include "set.h"
@@ -32,4 +38,4 @@ const arch_register_t *ppc32_get_firm_reg(const ir_node *irn, set *reg_set);
 
 long ppc32_translate_proj_pos(const ir_node *proj);
 
-#endif /* _PPC32_MAP_REGS_H_ */
+#endif
diff --git a/ir/be/ppc32/ppc32_new_nodes.c b/ir/be/ppc32/ppc32_new_nodes.c
index 93e83e0dd..af0734c9c 100644
--- a/ir/be/ppc32/ppc32_new_nodes.c
+++ b/ir/be/ppc32/ppc32_new_nodes.c
@@ -18,9 +18,12 @@
  */
 
 /**
- * This file implements the creation of the achitecture specific firm opcodes
- * and the coresponding node constructors for the ppc assembler irg.
- * $Id$
+ * @file
+ * @brief  This file implements the creation of the achitecture specific firm
+ *         opcodes and the coresponding node constructors for the ppc assembler
+ *         irg.
+ * @author  Moritz Kroll, Jens Mueller
+ * @version $Id$
  */
 #ifdef HAVE_CONFIG_H
 #include "config.h"
diff --git a/ir/be/ppc32/ppc32_new_nodes.h b/ir/be/ppc32/ppc32_new_nodes.h
index fd623e2ae..631048e16 100644
--- a/ir/be/ppc32/ppc32_new_nodes.h
+++ b/ir/be/ppc32/ppc32_new_nodes.h
@@ -17,13 +17,14 @@
  * PURPOSE.
  */
 
-#ifndef _PPC32_NEW_NODES_H_
-#define _PPC32_NEW_NODES_H_
-
 /**
- * Function prototypes for the assembler ir node constructors.
- * $Id$
+ * @file
+ * @brief   Function prototypes for the ppc32 assembler ir node constructors.
+ * @author  Moritz Kroll, Jens Mueller
+ * @version $Id$
  */
+#ifndef FIRM_BE_PPC32_PPC32_NEW_NODES_H
+#define FIRM_BE_PPC32_PPC32_NEW_NODES_H
 
 #include "ppc32_nodes_attr.h"
 
@@ -146,4 +147,4 @@ void ppc32_register_additional_opcodes(int opcode_num);
 /* Include the generated headers */
 #include "gen_ppc32_new_nodes.h"
 
-#endif /* _PPC32_NEW_NODES_H_ */
+#endif
diff --git a/ir/be/ppc32/ppc32_transform.c b/ir/be/ppc32/ppc32_transform.c
index 7dc2157f6..9f6ed3018 100644
--- a/ir/be/ppc32/ppc32_transform.c
+++ b/ir/be/ppc32/ppc32_transform.c
@@ -17,9 +17,12 @@
  * PURPOSE.
  */
 
-/* The codegenerator (transform FIRM into ppc FIRM) */
-/* $Id$ */
-
+/**
+ * @file
+ * @brief   The codegenerator (transform FIRM into ppc FIRM)
+ * @author  Moritz Kroll, Jens Mueller
+ * @version $Id$
+ */
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/ir/be/ppc32/ppc32_transform.h b/ir/be/ppc32/ppc32_transform.h
index e918f3d34..20b7feadd 100644
--- a/ir/be/ppc32/ppc32_transform.h
+++ b/ir/be/ppc32/ppc32_transform.h
@@ -17,11 +17,17 @@
  * PURPOSE.
  */
 
-#ifndef _PPC32_TRANSFORM_H_
-#define _PPC32_TRANSFORM_H_
+/**
+ * @file
+ * @brief   declarations for transform functions (code selection)
+ * @author  Moritz Kroll, Jens Mueller
+ * @version $Id$
+ */
+#ifndef FIRM_BE_PPC32_PPC32_TRANSFORM_H
+#define FIRM_BE_PPC32_PPC32_TRANSFORM_H
 
 void ppc32_register_transformers(void);
 void ppc32_transform_node(ir_node *node, void *env);
 void ppc32_transform_const(ir_node *node, void *env);
 
-#endif /* _PPC32_TRANSFORM_H_ */
+#endif
diff --git a/ir/be/ppc32/ppc32_transform_conv.c b/ir/be/ppc32/ppc32_transform_conv.c
index e0b931e8f..3c730f6da 100644
--- a/ir/be/ppc32/ppc32_transform_conv.c
+++ b/ir/be/ppc32/ppc32_transform_conv.c
@@ -17,9 +17,12 @@
  * PURPOSE.
  */
 
-/* The codegenerator (transform FIRM Conv nodes into ppc FIRM) */
-/* $Id$ */
-
+/**
+ * @file
+ * @brief   The codegenerator (transform FIRM Conv nodes into ppc FIRM)
+ * @author  Moritz Kroll, Jens Mueller
+ * @version $Id$
+ */
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/ir/be/ppc32/ppc32_transform_conv.h b/ir/be/ppc32/ppc32_transform_conv.h
index 640a02130..c1dfcec7a 100644
--- a/ir/be/ppc32/ppc32_transform_conv.h
+++ b/ir/be/ppc32/ppc32_transform_conv.h
@@ -17,12 +17,18 @@
  * PURPOSE.
  */
 
-#ifndef _PPC32_TRANSFORM_CONV_H_
-#define _PPC32_TRANSFORM_CONV_H_
+/**
+ * @file
+ * @brief   declarations for conv transform functions
+ * @author  Moritz Kroll, Jens Mueller
+ * @version $Id$
+ */
+#ifndef FIRM_BE_PPC32_PPC32_TRANSFORM_CONV_H
+#define FIRM_BE_PPC32_PPC32_TRANSFORM_CONV_H
 
 void ppc32_init_conv_walk(void);
 
 void ppc32_conv_walk(ir_node *node, void *env);
 void ppc32_pretransform_walk(ir_node *node, void *env);
 
-#endif /* _PPC32_TRANSFORM_CONV_H_ */
+#endif
-- 
2.20.1