X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=include%2Flibfirm%2Fbe.h;h=41d5454eb8d879b921b4a84defda565b70240ee2;hb=d217f68a9e53ec6e800ae31ca3af8ed8b6f9ece9;hp=77c952e8f5a3ff9350bbff21cf2c27a7585e3f6c;hpb=2413c90193696a4d31ea883954386dc32c0ae550;p=libfirm

diff --git a/include/libfirm/be.h b/include/libfirm/be.h
index 77c952e8f..41d5454eb 100644
--- a/include/libfirm/be.h
+++ b/include/libfirm/be.h
@@ -21,7 +21,6 @@
  * @file
  * @brief       Generic backend types and interfaces.
  * @author      Sebastian Hack
- * @version     $Id$
  */
 #ifndef FIRM_BE_MAIN_H
 #define FIRM_BE_MAIN_H
@@ -32,18 +31,40 @@
 #include "iroptimize.h"
 #include "begin.h"
 
-typedef enum {
-	ASM_CONSTRAINT_FLAG_NONE                  = 0,
+/**
+ * @defgroup be  Code Generation
+ *
+ * Code Generation (backend) produces machine-code.
+ * @{
+ */
+
+/**
+ * flags categorizing assembler constraint specifications
+ */
+typedef enum asm_constraint_flags_t {
+	ASM_CONSTRAINT_FLAG_NONE                  = 0, /**< no constraints */
+	/** input/output can be in a register */
 	ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER     = 1u << 0,
+	/** input/output can be read/written to/from a memory address */
 	ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP        = 1u << 1,
+	/** input can be encoded as an immediate number */
 	ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE    = 1u << 2,
+	/** the constraint is not supported yet by libFirm */
 	ASM_CONSTRAINT_FLAG_NO_SUPPORT            = 1u << 3,
+	/** The input is also written to */
 	ASM_CONSTRAINT_FLAG_MODIFIER_WRITE        = 1u << 4,
+	/** the input is not written to */
 	ASM_CONSTRAINT_FLAG_MODIFIER_NO_WRITE     = 1u << 5,
+	/** the input is read */
 	ASM_CONSTRAINT_FLAG_MODIFIER_READ         = 1u << 6,
+	/** the input is not read */
 	ASM_CONSTRAINT_FLAG_MODIFIER_NO_READ      = 1u << 7,
+	/** the value is modified before all inputs to the asm block
+	 * are handled. */
 	ASM_CONSTRAINT_FLAG_MODIFIER_EARLYCLOBBER = 1u << 8,
+	/** This operand and the following operand are commutative */
 	ASM_CONSTRAINT_FLAG_MODIFIER_COMMUTATIVE  = 1u << 9,
+	/** invalid constraint (due to parse error) */
 	ASM_CONSTRAINT_FLAG_INVALID               = 1u << 10
 } asm_constraint_flags_t;
 ENUM_BITSET(asm_constraint_flags_t)
@@ -126,18 +147,13 @@ typedef struct backend_params {
 	unsigned stack_param_align;
 } backend_params;
 
-/**
- * Register the Firm backend command line options.
- */
-FIRM_API void be_opt_register(void);
-
 /**
  * Parse one backend argument.
  */
 FIRM_API int be_parse_arg(const char *arg);
 
 /**
- * Return the backend configuration parameter.
+ * Returns the backend configuration parameter.
  *
  * @return libFirm configuration parameters for the selected
  *         backend
@@ -177,6 +193,8 @@ FIRM_API asm_constraint_flags_t be_parse_asm_constraints(const char *constraints
  */
 FIRM_API int be_is_valid_clobber(const char *clobber);
 
+/** @} */
+
 #include "end.h"
 
 #endif