X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Fbe%2Fbegnuas.h;h=9b6f2973e6e17b4ad8b8b430c5b8a8efdfb1855c;hb=dfc341ac6f54b4b0922d605e28333be76f487c68;hp=9c4b896dd80ed34a936eced7725de5a235d246a8;hpb=4d5c3365a58cba59993045a9e08e686d8ae079a7;p=libfirm

diff --git a/ir/be/begnuas.h b/ir/be/begnuas.h
index 9c4b896dd..9b6f2973e 100644
--- a/ir/be/begnuas.h
+++ b/ir/be/begnuas.h
@@ -18,12 +18,14 @@
  */
 
 /**
- * Header for ia32 assembler declarations dumper.
- * @author Christian Wuerdig, Matthias Braun
- * $Id$
+ * @file
+ * @brief       Dumps global variables and constants as gas assembler.
+ * @author      Christian Wuerdig, Matthias Braun
+ * @date        04.11.2005
+ * @version     $Id$
  */
-#ifndef _BE_GEN_DECLS_H_
-#define _BE_GEN_DECLS_H_
+#ifndef FIRM_BE_BEGNUAS_H
+#define FIRM_BE_BEGNUAS_H
 
 #include "be.h"
 #include "beemitter.h"
@@ -41,21 +43,35 @@ typedef enum section_t {
 	GAS_SECTION_MAX    = 6
 } be_gas_section_t;
 
+/**
+ * Support for some GAS "dialects".
+ */
 typedef enum asm_flavour_t {
-	GAS_FLAVOUR_NORMAL = 0,  /**< normal gas */
-	GAS_FLAVOUR_MINGW  = 1,  /**< MinGW variant */
+	GAS_FLAVOUR_NORMAL = 0,  /**< normal gas (ELF) */
+	GAS_FLAVOUR_MINGW  = 1,  /**< MinGW variant (no-ELF) */
 	GAS_FLAVOUR_MAX    = 2
 } be_gas_flavour_t;
 
+/** The variable where the GAS dialect is stored. */
 extern be_gas_flavour_t be_gas_flavour;
 
-
 /**
  * Generate all entities.
+ * @param env               the emitter environment
+ * @param main_env          the main backend environment
+ * @param emit_commons      if non-zero, emit commons (non-local uninitialized entities)
+ * @param only_emit_marked  if non-zero, external allocated entities that do not have
+ *                          its visited flag set are ignored
  */
 void be_gas_emit_decls(be_emit_env_t *env, const be_main_env_t *main_env,
                        int only_emit_marked_entities);
 
+/**
+ * Switch the current output section to the given out.
+ *
+ * @param env      the emitter environment
+ * @param section  the new output section
+ */
 void be_gas_emit_switch_section(be_emit_env_t *env, be_gas_section_t section);
 
-#endif
+#endif /* FIRM_BE_BEGNUAS_H */