aboutsummaryrefslogtreecommitdiff
path: root/src/math/types.h
diff options
context:
space:
mode:
authorJ08nY2017-05-29 15:11:38 +0200
committerJ08nY2017-05-29 15:11:38 +0200
commitba8c1f2bc424205cbb167b3c65ce184912c6173a (patch)
treedb21c80b3e7ed411ddbdc4151f82b875b83f279e /src/math/types.h
parent03eedf3f3e69093af6fd2717bbad04ffdfc7c25a (diff)
downloadecgen-ba8c1f2bc424205cbb167b3c65ce184912c6173a.tar.gz
ecgen-ba8c1f2bc424205cbb167b3c65ce184912c6173a.tar.zst
ecgen-ba8c1f2bc424205cbb167b3c65ce184912c6173a.zip
Diffstat (limited to 'src/math/types.h')
-rw-r--r--src/math/types.h21
1 files changed, 12 insertions, 9 deletions
diff --git a/src/math/types.h b/src/math/types.h
index 5d9a5b7..a6494cf 100644
--- a/src/math/types.h
+++ b/src/math/types.h
@@ -85,17 +85,17 @@ typedef struct {
/**
* @brief A generator function type.
- * @param curve
- * @param cfg
- * @param args
- * @return
+ * @param curve A curve_t being generated
+ * @param cfg An application config
+ * @param args Current optional generator argument
+ * @return state diff
*/
#define GENERATOR(gen_name) \
int gen_name(curve_t *curve, const config_t *cfg, arg_t *args)
typedef GENERATOR((*gen_t));
/**
- * @brief
+ * @brief An unroll function type
* @param curve
* @param cfg
* @param from
@@ -108,15 +108,18 @@ typedef GENERATOR((*gen_t));
typedef UNROLL((*unroll_t));
/**
+ * GENERATOR(gen_t)
*
- * @param curve
- * @param config
- * @param args
- * @return
+ *
+ * @param curve A curve_t being generated
+ * @param cfg An application config
+ * @param args unused
+ * @return state diff
*/
int gen_skip(curve_t *curve, const config_t *cfg, arg_t *args);
/**
+ * UNROLL(unroll_t)
*
* @param curve
* @param cfg