aboutsummaryrefslogtreecommitdiff
path: root/src/include/taler_amount_lib.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/include/taler_amount_lib.h')
-rw-r--r--src/include/taler_amount_lib.h25
1 files changed, 13 insertions, 12 deletions
diff --git a/src/include/taler_amount_lib.h b/src/include/taler_amount_lib.h
index e3f39cbb7..f088d89b4 100644
--- a/src/include/taler_amount_lib.h
+++ b/src/include/taler_amount_lib.h
@@ -113,42 +113,43 @@ struct TALER_Amount
/**
- * Parse denomination description, in the format "T:V.F".
+ * Parse monetary amount, in the format "T:V.F".
*
- * @param str denomination description
- * @param[out] denom denomination to write the result to
- * @return #GNUNET_OK if the string is a valid denomination specification,
+ * @param str amount string
+ * @param[out] amount amount to write the result to
+ * @return #GNUNET_OK if the string is a valid monetary amount specification,
* #GNUNET_SYSERR if it is invalid.
*/
int
TALER_string_to_amount (const char *str,
- struct TALER_Amount *denom);
+ struct TALER_Amount *amount);
/**
- * Parse denomination description, in the format "T:V.F".
+ * Parse monetary amount, in the format "T:V.F".
+ * The result is stored in network byte order (NBO).
*
- * @param str denomination description
- * @param[out] denom denomination to write the result to, in NBO
- * @return #GNUNET_OK if the string is a valid denomination specification,
+ * @param str amount string
+ * @param[out] amount_nbo amount to write the result to
+ * @return #GNUNET_OK if the string is a valid amount specification,
* #GNUNET_SYSERR if it is invalid.
*/
int
TALER_string_to_amount_nbo (const char *str,
- struct TALER_AmountNBO *denom);
+ struct TALER_AmountNBO *amount_nbo);
/**
* Get the value of "zero" in a particular currency.
*
* @param cur currency description
- * @param[out] denom denomination to write the result to
+ * @param[out] amount amount to write the result to
* @return #GNUNET_OK if @a cur is a valid currency specification,
* #GNUNET_SYSERR if it is invalid.
*/
int
TALER_amount_get_zero (const char *cur,
- struct TALER_Amount *denom);
+ struct TALER_Amount *amount);
/**