diff options
| -rw-r--r-- | src/account.h | 19 | ||||
| -rw-r--r-- | src/amount.h | 2 | ||||
| -rw-r--r-- | src/balpair.h | 5 | ||||
| -rw-r--r-- | src/binary.h | 1 | ||||
| -rw-r--r-- | src/cache.h | 19 | ||||
| -rw-r--r-- | src/commodity.h | 30 | ||||
| -rw-r--r-- | src/compare.h | 19 | ||||
| -rw-r--r-- | src/csv.h | 19 | ||||
| -rw-r--r-- | src/derive.h | 14 | ||||
| -rw-r--r-- | src/emacs.h | 19 | ||||
| -rw-r--r-- | src/entry.h | 49 | ||||
| -rw-r--r-- | src/error.h | 14 | ||||
| -rw-r--r-- | src/expr.h | 19 | ||||
| -rw-r--r-- | src/filters.h | 149 | ||||
| -rw-r--r-- | src/flags.h | 29 | ||||
| -rw-r--r-- | src/format.h | 23 | ||||
| -rw-r--r-- | src/gnucash.h | 19 | ||||
| -rw-r--r-- | src/handler.h | 19 | ||||
| -rw-r--r-- | src/help.h | 14 | ||||
| -rw-r--r-- | src/hooks.h | 19 | ||||
| -rw-r--r-- | src/item.h | 19 | ||||
| -rw-r--r-- | src/iterators.h | 54 | ||||
| -rw-r--r-- | src/journal.h | 19 | ||||
| -rw-r--r-- | src/ledger.h | 14 | ||||
| -rw-r--r-- | src/mask.h | 6 | ||||
| -rw-r--r-- | src/ofx.h | 19 | ||||
| -rw-r--r-- | src/op.h | 19 | ||||
| -rw-r--r-- | src/option.h | 14 | ||||
| -rw-r--r-- | src/output.h | 34 | ||||
| -rw-r--r-- | src/parser.h | 19 | ||||
| -rw-r--r-- | src/predicate.h | 19 | ||||
| -rw-r--r-- | src/pushvar.h | 13 | ||||
| -rw-r--r-- | src/qif.h | 19 | ||||
| -rw-r--r-- | src/quotes.h | 19 | ||||
| -rw-r--r-- | src/reconcile.h | 19 | ||||
| -rw-r--r-- | src/report.h | 19 | ||||
| -rw-r--r-- | src/scope.h | 44 | ||||
| -rw-r--r-- | src/session.h | 19 | ||||
| -rw-r--r-- | src/stream.h | 1 | ||||
| -rw-r--r-- | src/system.hh | 14 | ||||
| -rw-r--r-- | src/textual.h | 19 | ||||
| -rw-r--r-- | src/timelog.h | 24 | ||||
| -rw-r--r-- | src/times.h | 6 | ||||
| -rw-r--r-- | src/token.h | 19 | ||||
| -rw-r--r-- | src/utils.h | 3 | ||||
| -rw-r--r-- | src/xact.h | 19 | ||||
| -rw-r--r-- | src/xml.h | 29 |
47 files changed, 1014 insertions, 9 deletions
diff --git a/src/account.h b/src/account.h index e9413bc1..0dba02e2 100644 --- a/src/account.h +++ b/src/account.h @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup data + */ + +/** + * @file account.h + * @author John Wiegley + * + * @ingroup data + * + * @brief Brief + * + * Long. + */ #ifndef _ACCOUNT_H #define _ACCOUNT_H @@ -42,6 +56,11 @@ class session_t; typedef std::map<const string, account_t *> accounts_map; +/** + * @brief Brief + * + * Long. + */ class account_t : public scope_t { public: diff --git a/src/amount.h b/src/amount.h index d5c759db..d3101f13 100644 --- a/src/amount.h +++ b/src/amount.h @@ -30,7 +30,7 @@ */ /** - * @defgroup math Core numerical objects + * @defgroup math Mathematical objects */ /** diff --git a/src/balpair.h b/src/balpair.h index 6777edb7..d96792f0 100644 --- a/src/balpair.h +++ b/src/balpair.h @@ -60,6 +60,11 @@ namespace ledger { +/** + * @brief Brief + * + * Long. + */ class balance_pair_t : public balance_t, public equality_comparable<balance_pair_t, diff --git a/src/binary.h b/src/binary.h index 4bb1ac00..37dc857d 100644 --- a/src/binary.h +++ b/src/binary.h @@ -41,7 +41,6 @@ * * @brief General binary object streaming. */ - #ifndef BINARY_H #define BINARY_H diff --git a/src/cache.h b/src/cache.h index 3d41f791..b7766660 100644 --- a/src/cache.h +++ b/src/cache.h @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup parse + */ + +/** + * @file cache.h + * @author John Wiegley + * + * @ingroup parse + * + * @brief Brief + * + * Long. + */ #ifndef CACHE_H #define CACHE_H @@ -41,6 +55,11 @@ namespace ledger { DECLARE_EXCEPTION(cache_error, std::runtime_error); +/** + * @brief Brief + * + * Long. + */ class binary_cache_t { static const unsigned long binary_magic_number = 0xFFEED765; 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 { /** diff --git a/src/compare.h b/src/compare.h index 4383bd00..09abbd2a 100644 --- a/src/compare.h +++ b/src/compare.h @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup data + */ + +/** + * @file compare.h + * @author John Wiegley + * + * @ingroup data + * + * @brief Brief + * + * Long. + */ #ifndef _COMPARE_H #define _COMPARE_H @@ -38,6 +52,11 @@ namespace ledger { +/** + * @brief Brief + * + * Long. + */ template <typename T> class compare_items { @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup parse + */ + +/** + * @file csv.h + * @author John Wiegley + * + * @ingroup parse + * + * @brief Brief + * + * Long. + */ #ifndef _CSV_H #define _CSV_H @@ -37,6 +51,11 @@ namespace ledger { +/** + * @brief Brief + * + * Long. + */ class format_csv_xacts : public item_handler<xact_t> { format_csv_xacts(); diff --git a/src/derive.h b/src/derive.h index f0629d51..dd05e615 100644 --- a/src/derive.h +++ b/src/derive.h @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup extra + */ + +/** + * @file derive.h + * @author John Wiegley + * + * @ingroup extra + * + * @brief Brief + * + * Long. + */ #ifndef _DERIVE_H #define _DERIVE_H diff --git a/src/emacs.h b/src/emacs.h index 3a1d9514..fdb554ed 100644 --- a/src/emacs.h +++ b/src/emacs.h @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup parse + */ + +/** + * @file emacs.h + * @author John Wiegley + * + * @ingroup parse + * + * @brief Brief + * + * Long. + */ #ifndef _EMACS_H #define _EMACS_H @@ -37,6 +51,11 @@ namespace ledger { +/** + * @brief Brief + * + * Long. + */ class format_emacs_xacts : public item_handler<xact_t> { format_emacs_xacts(); diff --git a/src/entry.h b/src/entry.h index 1ffe9b68..5246ab4f 100644 --- a/src/entry.h +++ b/src/entry.h @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup data + */ + +/** + * @file entry.h + * @author John Wiegley + * + * @ingroup data + * + * @brief Brief + * + * Long. + */ #ifndef _ENTRY_H #define _ENTRY_H @@ -39,6 +53,11 @@ namespace ledger { class journal_t; +/** + * @brief Brief + * + * Long. + */ class entry_base_t : public item_t { public: @@ -61,6 +80,11 @@ public: virtual bool valid() const = 0; }; +/** + * @brief Brief + * + * Long. + */ class entry_t : public entry_base_t { public: @@ -83,11 +107,21 @@ public: virtual bool valid() const; }; +/** + * @brief Brief + * + * Long. + */ struct entry_finalizer_t { virtual ~entry_finalizer_t() {} virtual bool operator()(entry_t& entry, bool post) = 0; }; +/** + * @brief Brief + * + * Long. + */ class auto_entry_t : public entry_base_t { public: @@ -116,6 +150,11 @@ public: } }; +/** + * @brief Brief + * + * Long. + */ struct auto_entry_finalizer_t : public entry_finalizer_t { journal_t * journal; @@ -137,6 +176,11 @@ struct auto_entry_finalizer_t : public entry_finalizer_t virtual bool operator()(entry_t& entry, bool post); }; +/** + * @brief Brief + * + * Long. + */ class period_entry_t : public entry_base_t { public: @@ -164,6 +208,11 @@ class period_entry_t : public entry_base_t } }; +/** + * @brief Brief + * + * Long. + */ class func_finalizer_t : public entry_finalizer_t { func_finalizer_t(); diff --git a/src/error.h b/src/error.h index 6730ce17..0f128b4e 100644 --- a/src/error.h +++ b/src/error.h @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup util + */ + +/** + * @file error.h + * @author John Wiegley + * + * @ingroup util + * + * @brief Brief + * + * Long. + */ #ifndef _ERROR_H #define _ERROR_H @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup expr + */ + +/** + * @file expr.h + * @author John Wiegley + * + * @ingroup expr + * + * @brief Brief + * + * Long. + */ #ifndef _EXPR_H #define _EXPR_H @@ -46,6 +60,11 @@ class call_scope_t; typedef function<value_t (call_scope_t&)> function_t; +/** + * @brief Brief + * + * Long. + */ class expr_t { struct token_t; diff --git a/src/filters.h b/src/filters.h index 6103f3f0..32f71b5a 100644 --- a/src/filters.h +++ b/src/filters.h @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup report + */ + +/** + * @file filters.h + * @author John Wiegley + * + * @ingroup report + * + * @brief Brief + * + * Long. + */ #ifndef _FILTERS_H #define _FILTERS_H @@ -43,12 +57,22 @@ namespace ledger { // Transaction filters // +/** + * @brief Brief + * + * Long. + */ class ignore_xacts : public item_handler<xact_t> { public: virtual void operator()(xact_t&) {} }; +/** + * @brief Brief + * + * Long. + */ class clear_xact_xdata : public item_handler<xact_t> { public: @@ -59,6 +83,11 @@ public: class xacts_iterator; +/** + * @brief Brief + * + * Long. + */ class pass_down_xacts : public item_handler<xact_t> { pass_down_xacts(); @@ -71,6 +100,11 @@ public: } }; +/** + * @brief Brief + * + * Long. + */ class push_to_xacts_list : public item_handler<xact_t> { push_to_xacts_list(); @@ -90,6 +124,11 @@ public: } }; +/** + * @brief Brief + * + * Long. + */ class truncate_entries : public item_handler<xact_t> { int head_count; @@ -119,6 +158,11 @@ public: } }; +/** + * @brief Brief + * + * Long. + */ class set_account_value : public item_handler<xact_t> { public: @@ -128,6 +172,11 @@ public: virtual void operator()(xact_t& xact); }; +/** + * @brief Brief + * + * Long. + */ class sort_xacts : public item_handler<xact_t> { typedef std::deque<xact_t *> xacts_deque; @@ -168,6 +217,11 @@ public: } }; +/** + * @brief Brief + * + * Long. + */ class sort_entries : public item_handler<xact_t> { sort_xacts sorter; @@ -207,6 +261,11 @@ public: } }; +/** + * @brief Brief + * + * Long. + */ class filter_xacts : public item_handler<xact_t> { item_predicate<xact_t> pred; @@ -239,6 +298,11 @@ public: } }; +/** + * @brief Brief + * + * Long. + */ class anonymize_xacts : public item_handler<xact_t> { std::list<entry_t> entry_temps; @@ -260,6 +324,11 @@ public: virtual void operator()(xact_t& xact); }; +/** + * @brief Brief + * + * Long. + */ class calc_xacts : public item_handler<xact_t> { xact_t * last_xact; @@ -278,6 +347,11 @@ public: virtual void operator()(xact_t& xact); }; +/** + * @brief Brief + * + * Long. + */ class invert_xacts : public item_handler<xact_t> { invert_xacts(); @@ -294,6 +368,11 @@ inline void clear_entries_xacts(std::list<entry_t>& entries_list) { entry.xacts.clear(); } +/** + * @brief Brief + * + * Long. + */ class collapse_xacts : public item_handler<xact_t> { value_t subtotal; @@ -330,6 +409,11 @@ public: virtual void operator()(xact_t& xact); }; +/** + * @brief Brief + * + * Long. + */ class component_xacts : public item_handler<xact_t> { item_predicate<xact_t> pred; @@ -356,6 +440,11 @@ public: virtual void operator()(xact_t& xact); }; +/** + * @brief Brief + * + * Long. + */ class related_xacts : public item_handler<xact_t> { xacts_list xacts; @@ -382,6 +471,11 @@ public: } }; +/** + * @brief Brief + * + * Long. + */ class changed_value_xacts : public item_handler<xact_t> { // This filter requires that calc_xacts be used at some point @@ -424,6 +518,11 @@ public: virtual void operator()(xact_t& xact); }; +/** + * @brief Brief + * + * Long. + */ class subtotal_xacts : public item_handler<xact_t> { class acct_value_t @@ -490,6 +589,11 @@ public: virtual void operator()(xact_t& xact); }; +/** + * @brief Brief + * + * Long. + */ class interval_xacts : public subtotal_xacts { interval_t interval; @@ -529,6 +633,11 @@ public: virtual void operator()(xact_t& xact); }; +/** + * @brief Brief + * + * Long. + */ class by_payee_xacts : public item_handler<xact_t> { typedef std::map<string, subtotal_xacts *> payee_subtotals_map; @@ -553,6 +662,11 @@ class by_payee_xacts : public item_handler<xact_t> virtual void operator()(xact_t& xact); }; +/** + * @brief Brief + * + * Long. + */ class set_comm_as_payee : public item_handler<xact_t> { std::list<entry_t> entry_temps; @@ -573,6 +687,11 @@ public: virtual void operator()(xact_t& xact); }; +/** + * @brief Brief + * + * Long. + */ class set_code_as_payee : public item_handler<xact_t> { std::list<entry_t> entry_temps; @@ -593,6 +712,11 @@ public: virtual void operator()(xact_t& xact); }; +/** + * @brief Brief + * + * Long. + */ class dow_xacts : public subtotal_xacts { xacts_list days_of_the_week[7]; @@ -615,6 +739,11 @@ public: } }; +/** + * @brief Brief + * + * Long. + */ class generate_xacts : public item_handler<xact_t> { generate_xacts(); @@ -643,6 +772,11 @@ public: virtual void add_xact(const interval_t& period, xact_t& xact); }; +/** + * @brief Brief + * + * Long. + */ class budget_xacts : public generate_xacts { #define BUDGET_NO_BUDGET 0x00 @@ -669,6 +803,11 @@ public: virtual void operator()(xact_t& xact); }; +/** + * @brief Brief + * + * Long. + */ class forecast_xacts : public generate_xacts { item_predicate<xact_t> pred; @@ -696,6 +835,11 @@ class forecast_xacts : public generate_xacts // Account filters // +/** + * @brief Brief + * + * Long. + */ class clear_account_xdata : public item_handler<account_t> { public: @@ -706,6 +850,11 @@ public: class accounts_iterator; +/** + * @brief Brief + * + * Long. + */ class pass_down_accounts : public item_handler<account_t> { pass_down_accounts(); diff --git a/src/flags.h b/src/flags.h index b4c1a37c..215de6b2 100644 --- a/src/flags.h +++ b/src/flags.h @@ -29,9 +29,28 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup util + */ + +/** + * @file flags.h + * @author John Wiegley + * + * @ingroup util + * + * @brief Brief + * + * Long. + */ #ifndef _FLAGS_H #define _FLAGS_H +/** + * @brief Brief + * + * Long. + */ template <typename T = boost::uint_least8_t, typename U = T> class supports_flags { @@ -76,6 +95,11 @@ public: } }; +/** + * @brief Brief + * + * Long. + */ template <typename T = boost::uint_least8_t, typename U = T> class basic_flags_t : public supports_flags<T, U> { @@ -127,6 +151,11 @@ public: } }; +/** + * @brief Brief + * + * Long. + */ template <typename T = boost::uint_least8_t> class delegates_flags : public boost::noncopyable { diff --git a/src/format.h b/src/format.h index 19b19eea..439cb70b 100644 --- a/src/format.h +++ b/src/format.h @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup expr + */ + +/** + * @file format.h + * @author John Wiegley + * + * @ingroup expr + * + * @brief Brief + * + * Long. + */ #ifndef _FORMAT_H #define _FORMAT_H @@ -45,6 +59,7 @@ namespace ledger { DECLARE_EXCEPTION(format_error, std::runtime_error); #if defined(SUPPORT_UNICODE) + /** * @class unistring * @@ -87,10 +102,16 @@ public: return utf8result; } }; -#endif + +#endif // SUPPORT_UNICODE class report_t; +/** + * @brief Brief + * + * Long. + */ class format_t : public noncopyable { struct element_t : public supports_flags<>, public noncopyable diff --git a/src/gnucash.h b/src/gnucash.h index 948e34fe..e813be40 100644 --- a/src/gnucash.h +++ b/src/gnucash.h @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup parse + */ + +/** + * @file gnucash.h + * @author John Wiegley + * + * @ingroup pares + * + * @brief Brief + * + * Long. + */ #ifndef _GNUCASH_H #define _GNUCASH_H @@ -36,6 +50,11 @@ namespace ledger { +/** + * @brief Brief + * + * Long. + */ class gnucash_parser_t : public journal_t::parser_t { public: diff --git a/src/handler.h b/src/handler.h index 0f37d355..8f4d71b9 100644 --- a/src/handler.h +++ b/src/handler.h @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup report + */ + +/** + * @file handler.h + * @author John Wiegley + * + * @ingroup report + * + * @brief Brief + * + * Long. + */ #ifndef _HANDLER_H #define _HANDLER_H @@ -38,6 +52,11 @@ namespace ledger { +/** + * @brief Brief + * + * Long. + */ template <typename T> struct item_handler : public noncopyable { @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup report + */ + +/** + * @file help.h + * @author John Wiegley + * + * @ingroup report + * + * @brief Brief + * + * Long. + */ #ifndef _HELP_H #define _HELP_H diff --git a/src/hooks.h b/src/hooks.h index df1e6c70..79c25e53 100644 --- a/src/hooks.h +++ b/src/hooks.h @@ -29,9 +29,28 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup util + */ + +/** + * @file hooks.h + * @author John Wiegley + * + * @ingroup util + * + * @brief Brief + * + * Long. + */ #ifndef _HOOKS_H #define _HOOKS_H +/** + * @brief Brief + * + * Long. + */ template <typename T, typename Data> class hooks_t : public boost::noncopyable { @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @defgroup data Data representation + */ + +/** + * @file item.h + * @author John Wiegley + * + * @ingroup data + * + * @brief Brief + * + * Long. + */ #ifndef _ITEM_H #define _ITEM_H @@ -37,6 +51,11 @@ namespace ledger { +/** + * @brief Brief + * + * Long. + */ class item_t : public supports_flags<>, public scope_t { public: diff --git a/src/iterators.h b/src/iterators.h index 03f84e9d..ded403d9 100644 --- a/src/iterators.h +++ b/src/iterators.h @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup data + */ + +/** + * @file iterators.h + * @author John Wiegley + * + * @ingroup data + * + * @brief Brief + * + * Long. + */ #ifndef _ITERATORS_H #define _ITERATORS_H @@ -38,6 +52,11 @@ namespace ledger { +/** + * @brief Brief + * + * Long. + */ class xacts_iterator : public noncopyable { public: @@ -45,6 +64,11 @@ public: virtual xact_t * operator()() = 0; }; +/** + * @brief Brief + * + * Long. + */ class entry_xacts_iterator : public xacts_iterator { xacts_list::iterator xacts_i; @@ -79,6 +103,11 @@ public: } }; +/** + * @brief Brief + * + * Long. + */ class entries_iterator : public noncopyable { ptr_list<journal_t>::iterator journals_i; @@ -110,6 +139,11 @@ public: entry_t * operator()(); }; +/** + * @brief Brief + * + * Long. + */ class session_xacts_iterator : public xacts_iterator { entries_iterator entries; @@ -132,6 +166,11 @@ public: virtual xact_t * operator()(); }; +/** + * @brief Brief + * + * Long. + */ class accounts_iterator : public noncopyable { public: @@ -139,6 +178,11 @@ public: virtual account_t * operator()() = 0; }; +/** + * @brief Brief + * + * Long. + */ class basic_accounts_iterator : public accounts_iterator { std::list<accounts_map::const_iterator> accounts_i; @@ -164,6 +208,11 @@ public: virtual account_t * operator()(); }; +/** + * @brief Brief + * + * Long. + */ class sorted_accounts_iterator : public accounts_iterator { expr_t sort_cmp; @@ -201,6 +250,11 @@ public: virtual account_t * operator()(); }; +/** + * @brief Brief + * + * Long. + */ class journals_iterator : public noncopyable { ptr_list<journal_t>::iterator journals_i; diff --git a/src/journal.h b/src/journal.h index 2a4a4d9d..f8f53ec4 100644 --- a/src/journal.h +++ b/src/journal.h @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup data + */ + +/** + * @file journal.h + * @author John Wiegley + * + * @ingroup data + * + * @brief Brief + * + * Long. + */ #ifndef _JOURNAL_H #define _JOURNAL_H @@ -43,6 +57,11 @@ typedef std::list<path> paths_list; class session_t; class account_t; +/** + * @brief Brief + * + * Long. + */ class journal_t : public noncopyable { public: diff --git a/src/ledger.h b/src/ledger.h index f020c456..5228c4b9 100644 --- a/src/ledger.h +++ b/src/ledger.h @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @defgroup extra Other facilities + */ + +/** + * @file ledger.h + * @author John Wiegley + * + * @ingroup extra + * + * @brief Brief + * + * Long. + */ #ifndef _LEDGER_H #define _LEDGER_H @@ -41,7 +41,6 @@ * * @brief Regular expression masking. */ - #ifndef _MASK_H #define _MASK_H @@ -49,6 +48,11 @@ namespace ledger { +/** + * @brief Brief + * + * Long. + */ class mask_t { public: @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup parse + */ + +/** + * @file ofx.h + * @author John Wiegley + * + * @ingroup parse + * + * @brief Brief + * + * Long. + */ #ifndef _OFX_H #define _OFX_H @@ -36,6 +50,11 @@ namespace ledger { +/** + * @brief Brief + * + * Long. + */ class ofx_parser_t : public journal_t::parser_t { public: @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup expr + */ + +/** + * @file op.h + * @author John Wiegley + * + * @ingroup expr + * + * @brief Brief + * + * Long. + */ #ifndef _OP_H #define _OP_H @@ -37,6 +51,11 @@ namespace ledger { +/** + * @brief Brief + * + * Long. + */ class expr_t::op_t : public noncopyable { friend class expr_t; diff --git a/src/option.h b/src/option.h index e758ee99..b02425a6 100644 --- a/src/option.h +++ b/src/option.h @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup expr + */ + +/** + * @file option.h + * @author John Wiegley + * + * @ingroup expr + * + * @brief Brief + * + * Long. + */ #ifndef _OPTION_H #define _OPTION_H diff --git a/src/output.h b/src/output.h index 0d4e2072..af8e9e82 100644 --- a/src/output.h +++ b/src/output.h @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup report + */ + +/** + * @file output.h + * @author John Wiegley + * + * @ingroup report + * + * @brief Brief + * + * Long. + */ #ifndef _OUTPUT_H #define _OUTPUT_H @@ -38,6 +52,11 @@ namespace ledger { +/** + * @brief Brief + * + * Long. + */ class format_xacts : public item_handler<xact_t> { protected: @@ -60,6 +79,11 @@ public: virtual void operator()(xact_t& xact); }; +/** + * @brief Brief + * + * Long. + */ class format_entries : public format_xacts { public: @@ -88,6 +112,11 @@ private: const string& prefix = ""); }; +/** + * @brief Brief + * + * Long. + */ class format_accounts : public item_handler<account_t> { protected: @@ -122,6 +151,11 @@ public: virtual void operator()(account_t& account); }; +/** + * @brief Brief + * + * Long. + */ class format_equity : public format_accounts { format_t first_line_format; diff --git a/src/parser.h b/src/parser.h index ecf1b275..ea165ebd 100644 --- a/src/parser.h +++ b/src/parser.h @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup expr + */ + +/** + * @file parser.h + * @author John Wiegley + * + * @ingroup expr + * + * @brief Brief + * + * Long. + */ #ifndef _PARSER_H #define _PARSER_H @@ -37,6 +51,11 @@ namespace ledger { +/** + * @brief Brief + * + * Long. + */ class expr_t::parser_t : public noncopyable { public: diff --git a/src/predicate.h b/src/predicate.h index 3d0ed968..c25ff915 100644 --- a/src/predicate.h +++ b/src/predicate.h @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup expr + */ + +/** + * @file predicate.h + * @author John Wiegley + * + * @ingroup expr + * + * @brief Brief + * + * Long. + */ #ifndef _PREDICATE_H #define _PREDICATE_H @@ -37,6 +51,11 @@ namespace ledger { +/** + * @brief Brief + * + * Long. + */ template <typename T> class item_predicate { diff --git a/src/pushvar.h b/src/pushvar.h index 4300dc83..a37d41db 100644 --- a/src/pushvar.h +++ b/src/pushvar.h @@ -30,16 +30,25 @@ */ /** + * @addtogroup util + */ + +/** * @file pushvar.h * @author John Wiegley - * @date Sun May 6 20:10:52 2007 + * + * @ingroup util * * @brief Adds a facility to C++ for handling "scoped yet global". */ - #ifndef _PUSHVAR_H #define _PUSHVAR_H +/** + * @brief Brief + * + * Long. + */ template <typename T> class push_variable : public boost::noncopyable { @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup parse + */ + +/** + * @file qif.h + * @author John Wiegley + * + * @ingroup parse + * + * @brief Brief + * + * Long. + */ #ifndef _QIF_H #define _QIF_H @@ -36,6 +50,11 @@ namespace ledger { +/** + * @brief Brief + * + * Long. + */ class qif_parser_t : public journal_t::parser_t { public: diff --git a/src/quotes.h b/src/quotes.h index 48fc23dd..60eac63b 100644 --- a/src/quotes.h +++ b/src/quotes.h @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup extra + */ + +/** + * @file quotes.h + * @author John Wiegley + * + * @ingroup extra + * + * @brief Brief + * + * Long. + */ #ifndef _QUOTES_H #define _QUOTES_H @@ -37,6 +51,11 @@ namespace ledger { #if 0 +/** + * @brief Brief + * + * Long. + */ class quotes_by_script : public noncopyable, public commodity_t::base_t::updater_t { string price_db; diff --git a/src/reconcile.h b/src/reconcile.h index e88d6871..7ca9e861 100644 --- a/src/reconcile.h +++ b/src/reconcile.h @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup extra + */ + +/** + * @file reconcile.h + * @author John Wiegley + * + * @ingroup extra + * + * @brief Brief + * + * Long. + */ #ifndef _RECONCILE_H #define _RECONCILE_H @@ -38,6 +52,11 @@ namespace ledger { +/** + * @brief Brief + * + * Long. + */ class reconcile_xacts : public item_handler<xact_t> { value_t balance; diff --git a/src/report.h b/src/report.h index 6fcdc3f7..b5103e72 100644 --- a/src/report.h +++ b/src/report.h @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup report + */ + +/** + * @file report.h + * @author John Wiegley + * + * @ingroup report + * + * @brief Brief + * + * Long. + */ #ifndef _REPORT_H #define _REPORT_H @@ -81,6 +95,11 @@ namespace ledger { // says that the formatter should be "flushed" after the entities are // iterated. This does not happen for the commodities iteration, however. +/** + * @brief Brief + * + * Long. + */ class report_t : public noncopyable, public scope_t { report_t(); diff --git a/src/scope.h b/src/scope.h index db74a45c..aef49e51 100644 --- a/src/scope.h +++ b/src/scope.h @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup expr + */ + +/** + * @file scope.h + * @author John Wiegley + * + * @ingroup expr + * + * @brief Brief + * + * Long. + */ #ifndef _SCOPE_H #define _SCOPE_H @@ -37,6 +51,11 @@ namespace ledger { +/** + * @brief Brief + * + * Long. + */ class scope_t { public: @@ -58,6 +77,11 @@ public: } }; +/** + * @brief Brief + * + * Long. + */ class child_scope_t : public noncopyable, public scope_t { public: @@ -98,6 +122,11 @@ inline T& find_scope(child_scope_t& scope, bool skip_this = true) return reinterpret_cast<T&>(scope); // never executed } +/** + * @brief Brief + * + * Long. + */ class symbol_scope_t : public child_scope_t { typedef std::map<const string, expr_t::ptr_op_t> symbol_map; @@ -126,6 +155,11 @@ public: virtual expr_t::ptr_op_t lookup(const string& name); }; +/** + * @brief Brief + * + * Long. + */ class call_scope_t : public child_scope_t { value_t args; @@ -170,6 +204,11 @@ public: } }; +/** + * @brief Brief + * + * Long. + */ template <typename T> class ptr_t : public noncopyable { @@ -194,6 +233,11 @@ public: T * operator->() { return value; } }; +/** + * @brief Brief + * + * Long. + */ template <typename T> class var_t : public noncopyable { diff --git a/src/session.h b/src/session.h index d2ce48dd..852f3281 100644 --- a/src/session.h +++ b/src/session.h @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @defgroup report Reporting + */ + +/** + * @file session.h + * @author John Wiegley + * + * @ingroup report + * + * @brief Brief + * + * Long. + */ #ifndef _SESSION_H #define _SESSION_H @@ -41,6 +55,11 @@ namespace ledger { class report_t; +/** + * @brief Brief + * + * Long. + */ class session_t : public noncopyable, public scope_t { static void initialize(); diff --git a/src/stream.h b/src/stream.h index c35eef23..4c4dd366 100644 --- a/src/stream.h +++ b/src/stream.h @@ -45,7 +45,6 @@ * child process, different cleanup is needed for each scenario. This * file abstracts those various needs. */ - #ifndef _STREAM_H #define _STREAM_H diff --git a/src/system.hh b/src/system.hh index 287ec1a6..ab1b310f 100644 --- a/src/system.hh +++ b/src/system.hh @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup util + */ + +/** + * @file system.hh + * @author John Wiegley + * + * @ingroup util + * + * @brief Brief + * + * Long. + */ #ifndef _SYSTEM_HH #define _SYSTEM_HH diff --git a/src/textual.h b/src/textual.h index 8aa3a684..4505d4ed 100644 --- a/src/textual.h +++ b/src/textual.h @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @defgroup parse Parsers + */ + +/** + * @file textual.h + * @author John Wiegley + * + * @ingroup parse + * + * @brief Brief + * + * Long. + */ #ifndef _TEXTUAL_H #define _TEXTUAL_H @@ -43,6 +57,11 @@ namespace ledger { class time_log_t; #endif +/** + * @brief Brief + * + * Long. + */ class textual_parser_t : public journal_t::parser_t { public: diff --git a/src/timelog.h b/src/timelog.h index 12de02d6..9e69cd65 100644 --- a/src/timelog.h +++ b/src/timelog.h @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup data + */ + +/** + * @file timelog.h + * @author John Wiegley + * + * @ingroup data + * + * @brief Brief + * + * Long. + */ #ifndef _TIMELOG_H #define _TIMELOG_H @@ -36,6 +50,11 @@ namespace ledger { +/** + * @brief Brief + * + * Long. + */ class time_entry_t { public: @@ -62,6 +81,11 @@ public: } }; +/** + * @brief Brief + * + * Long. + */ class time_log_t { std::list<time_entry_t> time_entries; diff --git a/src/times.h b/src/times.h index 8104a78f..375a2555 100644 --- a/src/times.h +++ b/src/times.h @@ -41,7 +41,6 @@ * * @brief datetime_t and date_t objects */ - #ifndef _TIMES_H #define _TIMES_H @@ -115,6 +114,11 @@ inline string format_date(const date_t& when, } } +/** + * @brief Brief + * + * Long. + */ struct interval_t { int years; diff --git a/src/token.h b/src/token.h index 904a2e52..30d2c0f4 100644 --- a/src/token.h +++ b/src/token.h @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @defgroup expr Value expressions + */ + +/** + * @file token.h + * @author John Wiegley + * + * @ingroup expr + * + * @brief Brief + * + * Long. + */ #ifndef _TOKEN_H #define _TOKEN_H @@ -36,6 +50,11 @@ namespace ledger { +/** + * @brief Brief + * + * Long. + */ struct expr_t::token_t : public noncopyable { enum kind_t { diff --git a/src/utils.h b/src/utils.h index 16bcd09d..319d6126 100644 --- a/src/utils.h +++ b/src/utils.h @@ -41,7 +41,6 @@ * * @brief General utility facilities used by Ledger */ - #ifndef _UTILS_H #define _UTILS_H @@ -168,6 +167,8 @@ void trace_dtor_func(void * ptr, const char * cls_name, std::size_t cls_size); void report_memory(std::ostream& out, bool report_all = false); /** + * @brief Brief + * * This string type is a wrapper around std::string that allows us to * trace constructor and destructor calls. */ @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup data + */ + +/** + * @file xact.h + * @author John Wiegley + * + * @ingroup data + * + * @brief Brief + * + * Long. + */ #ifndef _XACT_H #define _XACT_H @@ -42,6 +56,11 @@ class account_t; class xact_t; typedef std::list<xact_t *> xacts_list; +/** + * @brief Brief + * + * Long. + */ class xact_t : public item_t { public: @@ -29,6 +29,20 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * @addtogroup parse + */ + +/** + * @file xml.h + * @author John Wiegley + * + * @ingroup parse + * + * @brief Brief + * + * Long. + */ #ifndef _XML_H #define _XML_H @@ -38,6 +52,11 @@ namespace ledger { +/** + * @brief Brief + * + * Long. + */ class CStreamReadCallBack : public irr::io::IFileReadCallBack { std::istream& in; @@ -70,6 +89,11 @@ public: } }; +/** + * @brief Brief + * + * Long. + */ class xml_parser_t : public journal_t::parser_t { public: @@ -82,6 +106,11 @@ class xml_parser_t : public journal_t::parser_t const path * original_file = NULL); }; +/** + * @brief Brief + * + * Long. + */ class format_xml_entries : public format_entries { bool show_totals; |