From 1ece3f8b1ce67197844084009fd0ac022b266450 Mon Sep 17 00:00:00 2001 From: John Wiegley Date: Sat, 31 Jan 2009 15:28:23 -0400 Subject: Added documentation stubs for all include files and classes. --- src/entry.h | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) (limited to 'src/entry.h') 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(); -- cgit v1.2.3