sfos/ledger
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added documentation stubs for all include files and classes.

Browse source
This commit is contained in:
John Wiegley 2009-01-31 15:28:23 -04:00
parent d1d5fc7551
commit 1ece3f8b1c
47 changed files with 1014 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
src/account.h
View file

@ -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:

2
src/amount.h
View file

@ -30,7 +30,7 @@
*/
/**
* @defgroup math Core numerical objects
* @defgroup math Mathematical objects
*/
/**

5
src/balpair.h
View file

@ -60,6 +60,11 @@
namespace ledger {
/**
* @brief Brief
*
* Long.
*/
class balance_pair_t
: public balance_t,
public equality_comparable<balance_pair_t,

1
src/binary.h
View file

@ -41,7 +41,6 @@
*
* @brief General binary object streaming.
*/
#ifndef BINARY_H
#define BINARY_H

19
src/cache.h
View file

@ -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;

30
src/commodity.h
View file

@ -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
{
/**

19
src/compare.h
View file

@ -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
{

19
src/csv.h
View file

@ -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();

14
src/derive.h
View file

@ -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

19
src/emacs.h
View file

@ -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();

49
src/entry.h
View file

@ -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();

14
src/error.h
View file

@ -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

19
src/expr.h
View file

@ -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;

149
src/filters.h
View file

@ -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();

29
src/flags.h
View file

@ -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
{

23
src/format.h
View file

@ -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

19
src/gnucash.h
View file

@ -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:

19
src/handler.h
View file

@ -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
{

14
src/help.h
View file

@ -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

19
src/hooks.h
View file

@ -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
{

19
src/item.h
View file

@ -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:

54
src/iterators.h
View file

@ -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;

19
src/journal.h
View file

@ -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:

14
src/ledger.h
View file

@ -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

6
src/mask.h
View file

@ -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:

19
src/ofx.h
View file

@ -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:

19
src/op.h
View file

@ -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;

14
src/option.h
View file

@ -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

34
src/output.h
View file

@ -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;

19
src/parser.h
View file

@ -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:

19
src/predicate.h
View file

@ -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
{

13
src/pushvar.h
View file

@ -29,17 +29,26 @@
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/**
* @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
{

19
src/qif.h
View file

@ -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:

19
src/quotes.h
View file

@ -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;

19
src/reconcile.h
View file

@ -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;

19
src/report.h
View file

@ -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();

44
src/scope.h
View file

@ -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
{

19
src/session.h
View file

@ -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();

1
src/stream.h
View file

@ -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

14
src/system.hh
View file

@ -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

19
src/textual.h
View file

@ -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:

24
src/timelog.h
View file

@ -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;

6
src/times.h
View file

@ -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;

19
src/token.h
View file

@ -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 {

3
src/utils.h
View file

@ -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.
*/

19
src/xact.h
View file

@ -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
src/xml.h
View file

@ -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;