aboutsummaryrefslogtreecommitdiff
path: root/src/io
diff options
context:
space:
mode:
authorJ08nY2017-10-08 20:00:10 +0200
committerJ08nY2017-10-08 20:00:10 +0200
commitd06df483bc75871a3046885c41ae96751a32cec8 (patch)
tree0d892e8387f581fa8b78ef9a1a61a9a9547e8887 /src/io
parent39aa16cf47e7b85b936f56a3256c1b547ed1bb68 (diff)
downloadecgen-d06df483bc75871a3046885c41ae96751a32cec8.tar.gz
ecgen-d06df483bc75871a3046885c41ae96751a32cec8.tar.zst
ecgen-d06df483bc75871a3046885c41ae96751a32cec8.zip
Document more files.
Diffstat (limited to 'src/io')
-rw-r--r--src/io/input.h18
-rw-r--r--src/io/output.h28
2 files changed, 23 insertions, 23 deletions
diff --git a/src/io/input.h b/src/io/input.h
index eb836e2..bdc86ec 100644
--- a/src/io/input.h
+++ b/src/io/input.h
@@ -12,37 +12,37 @@
#include "util/random.h"
/**
- *
+ * @brief Input a prime, upto <code>bits</code> long.
* @param prompt
* @param bits
- * @return
+ * @return the prime as t_INT, or <code>-1</code> if a composite was given.
*/
GEN input_prime(const char *prompt, unsigned long bits);
/**
- *
+ * @brief Input an unsigned integer, upto <code>bits</code> long.
* @param prompt
* @param bits
- * @return
+ * @return the int as t_INT, or <code>-1</code> if invalid input was given.
*/
GEN input_int(const char *prompt, unsigned long bits);
/**
- *
+ * @brief Input a short unsigned integer. (16 bits wide).
* @param prompt
- * @return
+ * @return the short as t_INT, or <code>-1</code> if invalid input was given.
*/
GEN input_short(const char *prompt);
/**
- *
+ * @brief Input a string.
* @param prompt
- * @return
+ * @return the string as a t_STR
*/
GEN input_string(const char *prompt);
/**
- *
+ * @brief The input FILE * to read all input from, can be <code>stdin</code>.
*/
extern FILE *in;
diff --git a/src/io/output.h b/src/io/output.h
index 6c241d5..8bf95e4 100644
--- a/src/io/output.h
+++ b/src/io/output.h
@@ -23,7 +23,7 @@
clock_gettime(CLOCK_MONOTONIC, &ts); \
fprintf(verbose, "%" PRIdMAX ".%.9ld ", ts.tv_sec, ts.tv_nsec);
-#define debug(...) pari_fprintf(verbose, __VA_ARGS__)
+#define debug(...) fprintf(verbose, __VA_ARGS__)
#define debug_log(...) \
do { \
_debug_print(" - "); \
@@ -58,7 +58,7 @@
#define output_log(...) fprintf(out, __VA_ARGS__)
/**
- * @brief Output curve to a pari_malloc'ed string in CSV format.
+ * @brief Output curve to a malloc'ed string in CSV format.
* @param curve
* @param config
* @return
@@ -66,7 +66,7 @@
char *output_scsv(curve_t *curve, const config_t *cfg);
/**
- * @brief Output CSV separator(newline) to a pari_malloc'ed string in CSV
+ * @brief Output CSV separator(newline) to a malloc'ed string in CSV
* format.
* @param cfg
* @return
@@ -74,21 +74,21 @@ char *output_scsv(curve_t *curve, const config_t *cfg);
char *output_scsv_separator(const config_t *cfg);
/**
- * @brief Output CSV output header to a pari_malloc'ed string in CSV format.
+ * @brief Output CSV output header to a malloc'ed string in CSV format.
* @param cfg
* @return
*/
char *output_scsv_begin(const config_t *cfg);
/**
- * @brief Output CSV output footer to a pari_malloc'ed string in CSV format.
+ * @brief Output CSV output footer to a malloc'ed string in CSV format.
* @param cfg
* @return
*/
char *output_scsv_end(const config_t *cfg);
/**
- * @brief Output curve to a pari_malloc'ed string in JSON format.
+ * @brief Output curve to a malloc'ed string in JSON format.
* @param curve
* @param config
* @return
@@ -96,7 +96,7 @@ char *output_scsv_end(const config_t *cfg);
char *output_sjson(curve_t *curve, const config_t *cfg);
/**
- * @brief Output JSON separator(a ",\n") to a pari_malloc'ed string in CSV
+ * @brief Output JSON separator(a ",\n") to a malloc'ed string in CSV
* format.
* @param cfg
* @return
@@ -104,7 +104,7 @@ char *output_sjson(curve_t *curve, const config_t *cfg);
char *output_sjson_separator(const config_t *cfg);
/**
- * @brief Output JSON output header(a "[") to a pari_malloc'ed string in CSV
+ * @brief Output JSON output header(a "[") to a malloc'ed string in CSV
* format.
* @param cfg
* @return
@@ -112,7 +112,7 @@ char *output_sjson_separator(const config_t *cfg);
char *output_sjson_begin(const config_t *cfg);
/**
- * @brief Output JSON output footer(a "]") to a pari_malloc'ed string in CSV
+ * @brief Output JSON output footer(a "]") to a malloc'ed string in CSV
* format.
* @param cfg
* @return
@@ -120,7 +120,7 @@ char *output_sjson_begin(const config_t *cfg);
char *output_sjson_end(const config_t *cfg);
/**
- * @brief Output curve to a pari_malloc'ed string in configured format.
+ * @brief Output curve to a malloc'ed string in configured format.
* @param curve
* @param config
* @return
@@ -143,7 +143,7 @@ void output_f(FILE *out, curve_t *curve, const config_t *cfg);
void output_o(curve_t *curve, const config_t *cfg);
/**
- * @brief Output separator to a pari_malloc'ed string in configured format.
+ * @brief Output separator to a malloc'ed string in configured format.
* @param cfg
* @return
*/
@@ -163,7 +163,7 @@ void output_f_separator(FILE *out, const config_t *cfg);
void output_o_separator(const config_t *cfg);
/**
- * @brief Output header to a pari_malloc'ed string in configured format.
+ * @brief Output header to a malloc'ed string in configured format.
* @param cfg
* @return
*/
@@ -183,7 +183,7 @@ void output_f_begin(FILE *out, const config_t *cfg);
void output_o_begin(const config_t *cfg);
/**
- * @brief Output footer to a pari_malloc'ed string in configured format.
+ * @brief Output footer to a malloc'ed string in configured format.
* @param cfg
* @return
*/
@@ -208,7 +208,7 @@ void output_o_end(const config_t *cfg);
extern FILE *out;
/**
- * @brief
+ * @brief Configured error output FILE*.
*/
extern FILE *err;