aboutsummaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorGavin Howard <gavin@yzena.com>2021-07-15 00:43:55 -0600
committerGavin Howard <gavin@yzena.com>2021-07-15 00:43:55 -0600
commit1930f9021c26937f6b0010b7d06ef145950d03c6 (patch)
tree0b6d75d4f2cba32986d5c0232db1d65f97107cae /include
parentf378c8b80af62743d75a959af1643e4f4a9762a2 (diff)
downloadplatform_external_bc-1930f9021c26937f6b0010b7d06ef145950d03c6.tar.gz
platform_external_bc-1930f9021c26937f6b0010b7d06ef145950d03c6.tar.bz2
platform_external_bc-1930f9021c26937f6b0010b7d06ef145950d03c6.zip
Do a lot of documentation work
This finishes the comments in the math code. Signed-off-by: Gavin Howard <gavin@yzena.com>
Diffstat (limited to 'include')
-rw-r--r--include/num.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/include/num.h b/include/num.h
index 6a7239eb..ebace9fa 100644
--- a/include/num.h
+++ b/include/num.h
@@ -377,9 +377,9 @@ typedef void (*BcNumBinaryOp)(BcNum* a, BcNum* b, BcNum* c, size_t scale);
* A function type for binary operators *after* @a c has been properly
* allocated. At this point, *nothing* should be pointing to @a c (in any way
* that matters, anyway).
- * @param a The first parameter.
- * @param b The second parameter.
- * @param c The return value.
+ * @param a The first operand.
+ * @param b The second operand.
+ * @param c The return parameter.
* @param scale The current scale.
*/
typedef void (*BcNumBinOp)(BcNum* a, BcNum* b, BcNum* restrict c, size_t scale);