Commenting IF default flags and stuffs

rpn_if.h

@@ -23,6 +23,13 @@
 
 #include "rpn_jit.h"
 
+/**@file rpn_if.h
+ * @ingroup ifs_if
+ * @brief Iterated functions headers
+ *
+ * Iterated functions structure + API definition
+ */
+
 /**@defgroup ifs_if Iterated function
  * @ingroup ifs
  * @brief Iterated RPN expression
@@ -95,8 +102,6 @@ struct rpn_if_s
  * @param rpn list of RPN expresions of params->rpn_sz size
  * @param memmap A suitable memory map. If NULL given, a new mmap is used
  * @return A pointer on an allocated @ref rpn_if_s
- * @todo Delete rpn argument : rpn expressions are initialized and
- * have to be compiled later
  */
 rpn_if_t* rpn_if_new(const rpn_if_param_t *params, rpn_value_t *memmap);
 

rpn_if_default.h

@@ -21,6 +21,7 @@
 
 /**@file rpn_if_default.h Defines default IF
  * @ingroup ifs_if_default
+ * @ingroup ifs_if
  * @brief Default IF definitions
  */
 
@@ -35,21 +36,30 @@
 #include "config.h"
 #include "rpn_if.h"
 
-#define RPN_IF_POSITION_LINEAR 0 // One expr for position
-#define RPN_IF_POSITION_XY 1 // two expr for poisition
-#define RPN_IF_POSITION_XDIM 2 // X expr for position
+/**@weakgroup ifs_if_default_posflag Default IF position flags
+ * @ingroup ifs_if_default
+ * @{ */
+#define RPN_IF_POSITION_LINEAR 0 ///< One expr for position
+#define RPN_IF_POSITION_XY 1 ///< two expr for position
+#define RPN_IF_POSITION_XDIM 2 ///< X expr for position
 
-#define RPN_IF_POSITION_OF_LOOP 0 // Loop on position overflow
-#define RPN_IF_POSITION_OF_ERR 16 // Trigger error on position overflow
+#define RPN_IF_POSITION_OF_LOOP 0 ///< Loop on position overflow
+#define RPN_IF_POSITION_OF_ERR 16 ///< Trigger error on position overflow
+/**@}*/
 
-#define RPN_IF_RES_BOOL 0 // Set to one when position occurs
-#define RPN_IF_RES_CONST 1 // Set to a constant value
-#define RPN_IF_RES_CONST_RGBA 2 // Set to a constant RGB using alpha channel
-#define RPN_IF_RES_COUNT 3 // Count number of time position occurs
-#define RPN_IF_RES_XFUN 4 // Set to result of rpn_expr
-#define RPN_IF_RES_RGB 5 // Set result to RGB color from rpn_expr
-#define RPN_IF_RES_RGBA 6 // Set result to RGB using alpha channel from rpn_expr
+/**@weakgroup ifs_if_default_resflag Default IF position flags
+ * @ingroup ifs_if_default
+ * @{ */
+#define RPN_IF_RES_BOOL 0 ///< Set to one when position occurs
+#define RPN_IF_RES_CONST 1 ///< Set to a constant value
+#define RPN_IF_RES_CONST_RGBA 2 ///< Set to a constant RGB using alpha channel
+#define RPN_IF_RES_COUNT 3 ///< Count number of time position occurs
+#define RPN_IF_RES_XFUN 4 ///< Set to result of rpn_expr
+#define RPN_IF_RES_RGB 5 ///< Set result to RGB color from rpn_expr
+#define RPN_IF_RES_RGBA 6 ///< Set result to RGB using alpha channel from rpn_expr
+/**@}*/
 
+/**@brief Alias for struct @ref rpn_if_default_data_s */
 typedef struct rpn_if_default_data_s rpn_if_default_data_t;
 
 /**@brief Stores default IF data
@@ -58,7 +68,9 @@ typedef struct rpn_if_default_data_s rpn_if_default_data_t;
  */
 struct rpn_if_default_data_s
 {
+	/**@brief Flag defining position coordinate handling */
 	short pos_flag;
+	/**@brief Flag defining result handling */
 	short res_flag;
 	/**@brief Stores size limits given pos_flag
 	 *
@@ -76,7 +88,22 @@ struct rpn_if_default_data_s
 	rpn_value_t *const_val;
 };
 
+/**@brief Create a new @ref rpn_if_s corresponding to given flags
+ * @ingroup ifs_if_default
+ *
+ * @param pos_flag Binary OR combination of RPN_IF_POSITION_*
+ *     (@ref ifs_if_default_posflag )
+ * @param pos_flag Binary OR combination of RPN_IF_RES_*
+ *     (@ref ifs_if_default_posflag )
+ * @returns A new @ref rpn_if_t (see @ref rpn_if_new ) or NULL on
+ * error
+ * @todo Implementation/testing
+ */
+rpn_if_t* rpn_if_new_default(short pos_flag, short res_flag);
+
+/**@brief Default argf function ( see @ref rpn_if_param_s.arg_f ) */
 int rpn_if_argf_default(rpn_if_t *rif, size_t pos, rpn_value_t *args);
+/**@brief Default result function ( see @ref rpn_if_param_s.res_f ) */
 int rpn_if_resf_default(rpn_if_t *rif, size_t *pos, rpn_value_t *data);
 
 /**@brief Set the first expression argument from position