summaryrefslogtreecommitdiff
path: root/amount.h
diff options
context:
space:
mode:
Diffstat (limited to 'amount.h')
-rw-r--r--amount.h13
1 files changed, 13 insertions, 0 deletions
diff --git a/amount.h b/amount.h
index c6160c93..8c4a612d 100644
--- a/amount.h
+++ b/amount.h
@@ -52,6 +52,19 @@ extern bool do_cleanup;
class commodity_t;
+/** @class amount_t
+
+ @brief Encapsulates infinite precision commoditized amounts.
+
+ The amount_t class can be used for commoditized infinite precision
+ math, and also for uncommoditized math. In the commoditized case,
+ commodities will keep track of how they are used, so that they
+ always display back to the user in the same fashion as their use.
+ However, in all cases precision is kept to an excessive degree
+ internally. For uncommoditized numbers, no display truncation is
+ ever done.
+*/
+
class amount_t
{
public: