summaryrefslogtreecommitdiff
path: root/src/commodity.h
diff options
context:
space:
mode:
authorJohn Wiegley <johnw@newartisans.com>2009-01-31 15:28:23 -0400
committerJohn Wiegley <johnw@newartisans.com>2009-01-31 15:28:23 -0400
commit1ece3f8b1ce67197844084009fd0ac022b266450 (patch)
tree6b54f87df9003021188e28837aae712743a14d5a /src/commodity.h
parentd1d5fc75511aeae760b43bd40aa7abfdbb7e6fa3 (diff)
downloadfork-ledger-1ece3f8b1ce67197844084009fd0ac022b266450.tar.gz
fork-ledger-1ece3f8b1ce67197844084009fd0ac022b266450.tar.bz2
fork-ledger-1ece3f8b1ce67197844084009fd0ac022b266450.zip
Added documentation stubs for all include files and classes.
Diffstat (limited to 'src/commodity.h')
-rw-r--r--src/commodity.h30
1 files changed, 30 insertions, 0 deletions
diff --git a/src/commodity.h b/src/commodity.h
index 6e5d644f..058d32fe 100644
--- a/src/commodity.h
+++ b/src/commodity.h
@@ -51,12 +51,22 @@ namespace ledger {
DECLARE_EXCEPTION(commodity_error, std::runtime_error);
+/**
+ * @brief Brief
+ *
+ * Long.
+ */
struct price_point_t
{
datetime_t when;
amount_t price;
};
+/**
+ * @brief Brief
+ *
+ * Long.
+ */
class commodity_t
: public delegates_flags<>,
public equality_comparable1<commodity_t, noncopyable>
@@ -369,6 +379,11 @@ inline std::ostream& operator<<(std::ostream& out, const commodity_t& comm) {
return out;
}
+/**
+ * @brief Brief
+ *
+ * Long.
+ */
struct annotation_t : public equality_comparable<annotation_t>
{
optional<amount_t> price;
@@ -418,6 +433,11 @@ inline std::ostream& operator<<(std::ostream& out, const annotation_t& details)
return out;
}
+/**
+ * @brief Brief
+ *
+ * Long.
+ */
class annotated_commodity_t
: public commodity_t,
public equality_comparable<annotated_commodity_t,
@@ -472,10 +492,20 @@ as_annotated_commodity(const commodity_t& commodity) {
}
+/**
+ * @brief Brief
+ *
+ * Long.
+ */
struct compare_amount_commodities {
bool operator()(const amount_t * left, const amount_t * right) const;
};
+/**
+ * @brief Brief
+ *
+ * Long.
+ */
class commodity_pool_t : public noncopyable
{
/**