aboutsummaryrefslogtreecommitdiff
path: root/src/math/equation.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/math/equation.h')
-rw-r--r--src/math/equation.h86
1 files changed, 44 insertions, 42 deletions
diff --git a/src/math/equation.h b/src/math/equation.h
index 79fad48..741517c 100644
--- a/src/math/equation.h
+++ b/src/math/equation.h
@@ -16,9 +16,9 @@
* element from the curve field.
* Always succeeds.
*
- * @param curve
- * @param config
- * @param args
+ * @param curve A curve_t being generated
+ * @param cfg An application config
+ * @param args unused
* @return state diff
*/
GENERATOR(a_gen_random);
@@ -27,9 +27,9 @@ GENERATOR(a_gen_random);
* GENERATOR(gen_t)
* Creates a parameter by reading from input.
*
- * @param curve
- * @param config
- * @param args
+ * @param curve A curve_t being generated
+ * @param cfg An application config
+ * @param args unused
* @return state diff
*/
GENERATOR(a_gen_input);
@@ -38,10 +38,10 @@ GENERATOR(a_gen_input);
* GENERATOR(gen_t)
* Creates a parameter by reading once from input.
*
- * @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
*/
GENERATOR(a_gen_once);
@@ -49,9 +49,9 @@ GENERATOR(a_gen_once);
* GENERATOR(gen_t)
* Creates a parameter set to zero.
*
- * @param curve
- * @param config
- * @param args
+ * @param curve A curve_t being generated
+ * @param cfg An application config
+ * @param args unused
* @return state diff
*/
GENERATOR(a_gen_zero);
@@ -60,19 +60,20 @@ GENERATOR(a_gen_zero);
* GENERATOR(gen_t)
* Creates a parameter set to one.
*
- * @param curve
- * @param config
- * @param args
+ * @param curve A curve_t being generated
+ * @param cfg An application config
+ * @param args unused
* @return state diff
*/
GENERATOR(a_gen_one);
/**
- * @brief
- * @param curve
- * @param config
- * @param args
- * @return
+ * GENERATOR(gen_t)
+ *
+ * @param curve A curve_t being generated
+ * @param cfg An application config
+ * @param args unused
+ * @return state diff
*/
GENERATOR(a_gen_seed);
@@ -81,9 +82,9 @@ GENERATOR(a_gen_seed);
* Creates a random b parameter by selecting a random field
* element from the curve field.
*
- * @param curve
- * @param config
- * @param args
+ * @param curve A curve_t being generated
+ * @param cfg An application config
+ * @param args unused
* @return state diff
*/
GENERATOR(b_gen_random);
@@ -92,9 +93,9 @@ GENERATOR(b_gen_random);
* GENERATOR(gen_t)
* Creates b parameter by reading from input.
*
- * @param curve
- * @param config
- * @param args
+ * @param curve A curve_t being generated
+ * @param cfg An application config
+ * @param args unused
* @return state diff
*/
GENERATOR(b_gen_input);
@@ -103,10 +104,10 @@ GENERATOR(b_gen_input);
* GENERATOR(gen_t)
* Creates b parameter by reading once from input.
*
- * @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
*/
GENERATOR(b_gen_once);
@@ -114,9 +115,9 @@ GENERATOR(b_gen_once);
* GENERATOR(gen_t)
* Creates b parameter set to zero.
*
- * @param curve
- * @param config
- * @param args
+ * @param curve A curve_t being generated
+ * @param cfg An application config
+ * @param args unused
* @return state diff
*/
GENERATOR(b_gen_zero);
@@ -125,19 +126,20 @@ GENERATOR(b_gen_zero);
* GENERATOR(gen_t)
* Creates b parameter set to one.
*
- * @param curve
- * @param config
- * @param args
+ * @param curve A curve_t being generated
+ * @param cfg An application config
+ * @param args unused
* @return state diff
*/
GENERATOR(g_gen_one);
/**
- * @brief
- * @param curve
- * @param config
- * @param args
- * @return
+ * GENERATOR(gen_t)
+ *
+ * @param curve A curve_t being generated
+ * @param cfg An application config
+ * @param args unused
+ * @return state diff
*/
GENERATOR(b_gen_seed);