gnucash maint: Multiple changes pushed

John Ralls jralls at code.gnucash.org
Thu Oct 15 18:58:51 EDT 2015


Updated	 via  https://github.com/Gnucash/gnucash/commit/9ac2bb81 (commit)
	 via  https://github.com/Gnucash/gnucash/commit/eac8aa34 (commit)
	 via  https://github.com/Gnucash/gnucash/commit/af45de8a (commit)
	from  https://github.com/Gnucash/gnucash/commit/aacef38d (commit)



commit 9ac2bb815892a9a898cd1fdbc2dc3a02642e0a59
Author: John Ralls <jralls at ceridwen.us>
Date:   Thu Oct 15 15:55:18 2015 -0700

    Add Business Ledger to Doxygen docs.

diff --git a/src/business/business-ledger/gncEntryLedger.h b/src/business/business-ledger/gncEntryLedger.h
index 3a7532d..f6a5a22 100644
--- a/src/business/business-ledger/gncEntryLedger.h
+++ b/src/business/business-ledger/gncEntryLedger.h
@@ -28,7 +28,13 @@
 #include "gncEntry.h"
 #include "gncOrder.h"
 #include "table-allgui.h"
-
+/** @ingroup Register
+ * @addtogroup BusinessRegister Business Register
+ * @brief A specialized register for Accounts Payable and Accounts Receivable.
+ * @{
+ */
+/** @file gncEntryLedger.h
+ */
 typedef enum
 {
     GNC_ENTRY_ORDER_NONE = -1, //Force clang to use int representation of enum.
@@ -72,31 +78,31 @@ typedef enum
 
 typedef struct GncEntryLedger_s GncEntryLedger;
 
-/** Prototypes ***************************************************/
+/* Prototypes ***************************************************/
 
-/* Create and return a new GncEntry Ledger */
+/** Create and return a new GncEntry Ledger */
 GncEntryLedger * gnc_entry_ledger_new (QofBook *book, GncEntryLedgerType type);
 
-/* Set the default order for this ledger */
+/** Set the default order for this ledger */
 void gnc_entry_ledger_set_default_order (GncEntryLedger *ledger,
         GncOrder *order);
 
-/* Set the default invoice for this ledger */
+/** Set the default invoice for this ledger */
 void gnc_entry_ledger_set_default_invoice (GncEntryLedger *ledger,
         GncInvoice *invoice);
 
-/* Destroy the GncEntry Ledger */
+/** Destroy the GncEntry Ledger */
 void gnc_entry_ledger_destroy (GncEntryLedger *ledger);
 
-/* Returns the Entry where the cursor is currently located. */
+/** Returns the Entry where the cursor is currently located. */
 GncEntry * gnc_entry_ledger_get_current_entry (GncEntryLedger *ledger);
 
-/* Copy GncEntry information from the list to the rows of the Ledger. */
+/** Copy GncEntry information from the list to the rows of the Ledger. */
 void gnc_entry_ledger_load (GncEntryLedger *ledger, GList *entry_list);
 
 void gnc_entry_ledger_display_refresh (GncEntryLedger *ledger);
 
-/* Get the Table */
+/** Get the Table */
 Table * gnc_entry_ledger_get_table (GncEntryLedger *ledger);
 
 void gnc_entry_ledger_set_parent (GncEntryLedger *ledger, GtkWidget *parent);
@@ -107,10 +113,10 @@ gboolean gnc_entry_ledger_changed (GncEntryLedger *ledger);
 
 void gnc_entry_ledger_cancel_cursor_changes (GncEntryLedger *ledger);
 
-/* This will act just like hitting 'return' to record an entry */
+/** This will act just like hitting 'return' to record an entry */
 gboolean gnc_entry_ledger_commit_entry (GncEntryLedger *ledger);
 
-/* This will ask the user if they really want to make a change */
+/** This will ask the user if they really want to make a change */
 gboolean gnc_entry_ledger_check_close (GtkWidget *parent, GncEntryLedger *ledger);
 
 void gnc_entry_ledger_reset_query (GncEntryLedger *ledger);
@@ -147,5 +153,5 @@ void gnc_entry_ledger_move_current_entry_updown (GncEntryLedger *ledger,
 QofQuery * gnc_entry_ledger_get_query (GncEntryLedger *ledger);
 
 void gnc_entry_ledger_set_prefs_group (GncEntryLedger *ledger, const gchar *string);
-
+/** @} */
 #endif /* GNC_ENTRY_LEDGER_H */
diff --git a/src/business/business-ledger/gncEntryLedgerControl.h b/src/business/business-ledger/gncEntryLedgerControl.h
index 59eb843..8be6a50 100644
--- a/src/business/business-ledger/gncEntryLedgerControl.h
+++ b/src/business/business-ledger/gncEntryLedgerControl.h
@@ -25,7 +25,12 @@
 #define GNC_ENTRY_LEDGER_CONTROL_H
 
 #include "gncEntryLedger.h"
-
+/** @ingroup Register
+ * @addtogroup BusinessRegister
+ * @{
+ */
+/** @file gncEntryLedgerControl.h
+ */
 TableControl * gnc_entry_ledger_control_new (void);
-
+/** @} */
 #endif /* GNC_ENTRY_LEDGER_CONTROL_H */
diff --git a/src/business/business-ledger/gncEntryLedgerLayout.h b/src/business/business-ledger/gncEntryLedgerLayout.h
index 87cf4c4..918889c 100644
--- a/src/business/business-ledger/gncEntryLedgerLayout.h
+++ b/src/business/business-ledger/gncEntryLedgerLayout.h
@@ -25,7 +25,12 @@
 #define GNC_ENTRY_LEDGER_LAYOUT_H
 
 #include "gncEntryLedger.h"
-
+/** @ingroup Register
+ * @addtogroup BusinessRegister
+ * @{
+ */
+/** @file gncEntryLedgerLayout.h
+ */
 TableLayout * gnc_entry_ledger_layout_new (GncEntryLedger *ledger);
-
+/** @} */
 #endif /* GNC_ENTRY_LEDGER_LAYOUT_H */
diff --git a/src/business/business-ledger/gncEntryLedgerModel.h b/src/business/business-ledger/gncEntryLedgerModel.h
index decc13a..7fabd23 100644
--- a/src/business/business-ledger/gncEntryLedgerModel.h
+++ b/src/business/business-ledger/gncEntryLedgerModel.h
@@ -25,7 +25,12 @@
 #define GNC_ENTRY_LEDGER_MODEL_H
 
 #include "gncEntryLedger.h"
-
+/** @ingroup Register
+ * @addtogroup BusinessRegister
+ * @{
+ */
+/** @file gncEntryLedgerModel.h
+ */
 TableModel * gnc_entry_ledger_model_new (GncEntryLedgerType type);
-
+/** @} */
 #endif /* GNC_ENTRY_LEDGER_MODEL_H */
diff --git a/src/business/business-ledger/gncEntryLedgerP.h b/src/business/business-ledger/gncEntryLedgerP.h
index c04f7c3..ad558f1 100644
--- a/src/business/business-ledger/gncEntryLedgerP.h
+++ b/src/business/business-ledger/gncEntryLedgerP.h
@@ -27,20 +27,25 @@
 #include "qof.h"
 #include "table-allgui.h"
 #include "gncEntryLedger.h"
-
+/** @ingroup Register
+ * @addtogroup BusinessRegister
+ * @{
+ */
+/** @file gncEntryLedgerP.h
+ */
 struct GncEntryLedger_s
 {
     GncGUID       blank_entry_guid;
     gboolean      blank_entry_edited;
     gboolean      traverse_to_new;
 
-    gboolean      loading;       /* To keep from recursing from events */
-    gboolean      full_refresh;  /* Is a full refresh ok? */
-    gint          component_id;  /* To register for events */
+    gboolean      loading;       /** To keep from recursing from events */
+    gboolean      full_refresh;  /** Is a full refresh ok? */
+    gint          component_id;  /** To register for events */
 
     GDate       last_date_entered;
 
-    GncEntry    * hint_entry;    /* A Hint for where to display */
+    GncEntry    * hint_entry;    /** A Hint for where to display */
 
     GtkWidget   * parent;
     QofBook     * book;
@@ -51,8 +56,8 @@ struct GncEntryLedger_s
 
     GncEntryLedgerType type;
 
-    gboolean   is_cust_doc;      /* is this document customer or vendor related ? */
-    gboolean   is_credit_note;   /* is this an invoice (or a bill)? */
+    gboolean   is_cust_doc;      /** is this document customer or vendor related ? */
+    gboolean   is_credit_note;   /** is this an invoice (or a bill)? */
 
     const gchar * prefs_group;
 };
@@ -88,5 +93,5 @@ void gnc_entry_ledger_display_fini (GncEntryLedger *ledger);
 void gnc_entry_ledger_compute_value (GncEntryLedger *ledger,
                                      gnc_numeric *value,
                                      gnc_numeric *tax_value);
-
+/** @} */
 #endif /* GNC_ENTRY_LEDGERP_H */

commit eac8aa34919c28b0215be9044aa1a6a56491e731
Author: John Ralls <jralls at ceridwen.us>
Date:   Thu Oct 15 15:38:45 2015 -0700

    Document the Register Core CellBlock class.

diff --git a/src/register/register-core/cellblock.h b/src/register/register-core/cellblock.h
index 6a276b9..f917412 100644
--- a/src/register/register-core/cellblock.h
+++ b/src/register/register-core/cellblock.h
@@ -64,14 +64,40 @@ typedef struct
 } CellBlock;
 
 
+/** Create a new CellBlock on the heap.
+ * @param rows Number of rows.
+ * @param cols Number of columns.
+ * @param cursor_name A string name for the CellBlock. It will be copied with a
+ * new string on the heap.
+ * @return a newly-allocated CellBlock which should be deleted with
+ * gnc_cellblock_destroy.
+ */
 CellBlock * gnc_cellblock_new (int rows, int cols, const char *cursor_name);
 
+/** Delete a CellBlock and its Cells.
+ * @param cellblock The CellBlock to destroy.
+ */
 void        gnc_cellblock_destroy (CellBlock *cellblock);
 
+/** Add a cell to the CellBlock at the specified coordinates. The CellBlock
+ * takes ownership of the Cell. If there's already a Cell at the location it
+ * will be leaked, so callers shoud first call gnc_cellblock_get_cell() and
+ * delete the result if it's not NULL.
+ * @param cellblock The CellBlock
+ * @param row The row at which to add the cell
+ * @param col The column at which to add the cell
+ * @param cell The cell to place at the coordinates.
+ */
 void        gnc_cellblock_set_cell (CellBlock *cellblock,
                                     int row, int col,
                                     BasicCell *cell);
 
+/** Retrieve the Cell at the specified coordinates.
+ * @param cellblock The CellBlock
+ * @param row The row of the requested Cell
+ * @param col The column of the requested Cell
+ * @return A pointer to the requested Cell.
+ */
 BasicCell * gnc_cellblock_get_cell (CellBlock *cellblock,
                                     int row, int col);
 
@@ -94,10 +120,17 @@ BasicCell * gnc_cellblock_get_cell_by_name(CellBlock *cellblock,
         const char *cell_name,
         int *row, int *col);
 
-/* Return number of changed cells. */
+/** Return number of changed cells.
+ * @param cursor The cellblock to query
+ * @param include_conditional If TRUE counts conditionally-changed cells
+ * @return The number of changed cells found.
+ */
 int         gnc_cellblock_changed (CellBlock *cursor,
                                    gboolean include_conditional);
 
+/** Sets all cells in the cellblock to not changed.
+ * @param cursor The cellblock.
+ */
 void        gnc_cellblock_clear_changes (CellBlock *cursor);
 
 #endif

commit af45de8a21fb74dc94689fb5ea5b3ee5770f5917
Author: John Ralls <jralls at ceridwen.us>
Date:   Thu Oct 15 14:26:17 2015 -0700

    Create a new Register2 group in Register and add the Reg2-specific files to it.
    
    To provide an easy way to identify the Register2 files.

diff --git a/src/gnome-utils/gnc-tree-control-split-reg.h b/src/gnome-utils/gnc-tree-control-split-reg.h
index 23a2470..76d92f5 100644
--- a/src/gnome-utils/gnc-tree-control-split-reg.h
+++ b/src/gnome-utils/gnc-tree-control-split-reg.h
@@ -31,6 +31,12 @@
 #include "gnc-tree-view-split-reg.h"
 
 G_BEGIN_DECLS
+/** @ingroup Register
+ * @addtogroup Register2
+ * @{
+ */
+/** @file gnc-tree-control-split-reg.h
+ */
 
 /*****************************************************************************/
 
@@ -120,7 +126,7 @@ void gnc_tree_control_split_reg_paste_trans (GncTreeViewSplitReg *view);
 void gnc_tree_control_auto_complete (GncTreeViewSplitReg *view, Transaction *trans,  const gchar *new_text);
 
 /*****************************************************************************/
-
+/** @} */
 G_END_DECLS
 
 #endif /* __GNC_TREE_CONTROL_SPLIT_REG_H */
diff --git a/src/gnome-utils/gnc-tree-model-split-reg.h b/src/gnome-utils/gnc-tree-model-split-reg.h
index c7b0451..c12556d 100644
--- a/src/gnome-utils/gnc-tree-model-split-reg.h
+++ b/src/gnome-utils/gnc-tree-model-split-reg.h
@@ -34,7 +34,12 @@
 
 
 G_BEGIN_DECLS
-
+/** @ingroup Register
+ * @addtogroup Register2
+ * @{
+ */
+/** @file gnc-tree-model-split-reg.h
+ */
 /* type macros */
 #define GNC_TYPE_TREE_MODEL_SPLIT_REG            (gnc_tree_model_split_reg_get_type ())
 #define GNC_TREE_MODEL_SPLIT_REG(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GNC_TYPE_TREE_MODEL_SPLIT_REG, GncTreeModelSplitReg))
@@ -128,7 +133,7 @@ typedef enum
 typedef struct GncTreeModelSplitRegPrivate GncTreeModelSplitRegPrivate;
 
 /** The instance data structure for an account tree model. */
-typedef struct 
+typedef struct
 {
     GncTreeModel                 gnc_tree_model;        /**< The parent object data. */
     GncTreeModelSplitRegPrivate *priv;
@@ -145,8 +150,8 @@ typedef struct
     GtkSortType                  sort_direction;        /**< This is the direction of sort */
 
     gboolean                     use_accounting_labels; /**< whether to use accounting Labels */
-    gboolean                     separator_changed;     /**< whether the separator has changed */ 
-    gboolean                     alt_colors_by_txn;     /**< whether to use alternative colors by transaction */ 
+    gboolean                     separator_changed;     /**< whether the separator has changed */
+    gboolean                     alt_colors_by_txn;     /**< whether to use alternative colors by transaction */
     gboolean                     use_theme_colors;      /**< whether to use theme colors */
 
     gboolean                     read_only;             /**< register is read only */
@@ -325,7 +330,7 @@ Split * gnc_tree_model_split_reg_trans_get_split_equal_to_ancestor (const Transa
 gint gnc_tree_model_split_reg_sort_iter_compare_func (GtkTreeModel *tm, GtkTreeIter *a, GtkTreeIter *b, gpointer user_data);
 
 /*****************************************************************************/
-
+/** @} */
 G_END_DECLS
 
 #endif /* __GNC_TREE_MODEL_SPLIT_REG_H */
diff --git a/src/gnome-utils/gnc-tree-util-split-reg.h b/src/gnome-utils/gnc-tree-util-split-reg.h
index a2b7def..d217958 100644
--- a/src/gnome-utils/gnc-tree-util-split-reg.h
+++ b/src/gnome-utils/gnc-tree-util-split-reg.h
@@ -31,7 +31,12 @@
 #include "gnc-tree-view-split-reg.h"
 
 G_BEGIN_DECLS
-
+/** @ingroup Register
+ * @addtogroup Register2
+ * @{
+ */
+/** @file gnc-tree-util-split-reg.h
+ */
 
 /*****************************************************************************/
 
@@ -83,7 +88,7 @@ gnc_numeric gnc_tree_util_get_rate_for (GncTreeViewSplitReg *view, Transaction *
                                         Split *split, gboolean is_blank);
 
 /*****************************************************************************/
-
+/** @} */
 G_END_DECLS
 
 #endif /* __GNC_TREE_UTIL_SPLIT_REG_H */
diff --git a/src/gnome-utils/gnc-tree-view-split-reg.h b/src/gnome-utils/gnc-tree-view-split-reg.h
index 16fe56d..071a266 100644
--- a/src/gnome-utils/gnc-tree-view-split-reg.h
+++ b/src/gnome-utils/gnc-tree-view-split-reg.h
@@ -35,7 +35,12 @@
 #include "gnc-ui-util.h"
 
 G_BEGIN_DECLS
-
+/** @ingroup Register
+ * @addtogroup Register2
+ * @{
+ */
+/** @file gnc-tree-view-split-reg.h
+ */
 #define GNC_TYPE_TREE_VIEW_SPLIT_REG            (gnc_tree_view_split_reg_get_type ())
 #define GNC_TREE_VIEW_SPLIT_REG(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GNC_TYPE_TREE_VIEW_SPLIT_REG, GncTreeViewSplitReg))
 #define GNC_TREE_VIEW_SPLIT_REG_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GNC_TYPE_TREE_VIEW_SPLIT_REG, GncTreeViewSplitRegClass))
@@ -181,7 +186,7 @@ void gnc_tree_view_split_reg_cancel_edit (GncTreeViewSplitReg *view, gboolean re
 
 void gnc_tree_view_split_reg_finish_edit (GncTreeViewSplitReg *view);
 
-
+/** @} */
 G_END_DECLS
 
 #endif /* __GNC_TREE_VIEW_SPLIT_REG_H */
diff --git a/src/gnome/gnc-plugin-page-register2.h b/src/gnome/gnc-plugin-page-register2.h
index 98ea5ee..caf92c3 100644
--- a/src/gnome/gnc-plugin-page-register2.h
+++ b/src/gnome/gnc-plugin-page-register2.h
@@ -22,16 +22,6 @@
  * Boston, MA  02110-1301,  USA       gnu at gnu.org                     *
  **********************************************************************/
 
-/** @addtogroup ContentPlugins
-    @{ */
-/** @addtogroup Register2Plugin Register2 Page
-    @{ */
-/** @file gnc-plugin-page-register.h
-    @brief  Functions providing a register page for the GnuCash UI
-    @author Copyright (C) 2003 Jan Arne Petersen <jpetersen at uni-bonn.de>
-    @author Copyright (C) 2003 David Hampton <hampton at employees.org>
-*/
-
 #ifndef __GNC_PLUGIN_PAGE_REGISTER2_H
 #define __GNC_PLUGIN_PAGE_REGISTER2_H
 
@@ -43,7 +33,12 @@
 #include "gnc-split-reg2.h"
 
 G_BEGIN_DECLS
-
+/** @ingroup Register
+ * @addtogroup Register2
+ * @{
+ */
+/** @file gnc-plugin-page-register2.h
+ */
 /* type macros */
 #define GNC_TYPE_PLUGIN_PAGE_REGISTER2            (gnc_plugin_page_register2_get_type ())
 #define GNC_PLUGIN_PAGE_REGISTER2(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GNC_TYPE_PLUGIN_PAGE_REGISTER2, GncPluginPageRegister2))
@@ -153,7 +148,5 @@ gnc_plugin_page_register2_get_account (GncPluginPageRegister2 *page);
 
 G_END_DECLS
 /** @} */
-/** @} */
 
 #endif /* __GNC_PLUGIN_PAGE_REGISTER2_H */
-
diff --git a/src/gnome/gnc-plugin-register2.h b/src/gnome/gnc-plugin-register2.h
index 319a227..7ca9ac0 100644
--- a/src/gnome/gnc-plugin-register2.h
+++ b/src/gnome/gnc-plugin-register2.h
@@ -28,7 +28,12 @@
 #include "gnc-plugin.h"
 
 G_BEGIN_DECLS
-
+/** @ingroup Register
+ * @addtogroup Register2
+ * @{
+ */
+/** @file gnc-plugin-register2.h
+ */
 /* type macros */
 #define GNC_TYPE_PLUGIN_REGISTER2            (gnc_plugin_register2_get_type ())
 #define GNC_PLUGIN_REGISTER2(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GNC_TYPE_PLUGIN_REGISTER2, GncPluginRegister2))
@@ -56,5 +61,6 @@ GType      gnc_plugin_register2_get_type (void);
 GncPlugin *gnc_plugin_register2_new      (void);
 
 G_END_DECLS
+/** @} */
 
 #endif /* __GNC_PLUGIN_REGISTER2_H */
diff --git a/src/gnome/gnc-split-reg2.h b/src/gnome/gnc-split-reg2.h
index d9f5270..5e00a2d 100644
--- a/src/gnome/gnc-split-reg2.h
+++ b/src/gnome/gnc-split-reg2.h
@@ -33,7 +33,12 @@
 #include "gnc-ledger-display2.h"
 #include "gnc-split-reg.h"
 #include "gnc-tree-view-split-reg.h"
-
+/** @ingroup Register
+ * @addtogroup Register2
+ * @{
+ */
+/** @file gnc-split-reg2.h
+ */
 #define GNC_SPLIT_REG2(obj)         G_TYPE_CHECK_INSTANCE_CAST( obj, gnc_split_reg2_get_type(), GNCSplitReg2 )
 #define GNC_SPLIT_REG2_CLASS(klass) G_TYPE_CHECK_CLASS_CAST( klass, gnc_split_reg2_get_type(), GNCSplitReg2Class )
 #define IS_GNC_SPLIT_REG2(obj)      G_TYPE_CHECK_INSTANCE_TYPE( obj, gnc_split_reg2_get_type() )
@@ -154,5 +159,5 @@ void gnc_split_reg2_balancing_entry (GNCSplitReg2 *gsr, Account *account,
 
 
 void gnc_split_reg2_set_moved_cb (GNCSplitReg2 *gsr, GFunc cb, gpointer cb_data);
-
+/** @} */
 #endif /* GNC_SPLIT_REG2_H */
diff --git a/src/register/ledger-core/gnc-ledger-display2.h b/src/register/ledger-core/gnc-ledger-display2.h
index e35b37c..27d60da 100644
--- a/src/register/ledger-core/gnc-ledger-display2.h
+++ b/src/register/ledger-core/gnc-ledger-display2.h
@@ -31,16 +31,24 @@
 #include "Account.h"
 #include "Query.h"
 
-#include "split-register.h" 
+#include "split-register.h"
 
 #include "SchedXaction.h"
 #include "Transaction.h"
 #include "gnc-tree-model-split-reg.h"
 #include "gnc-tree-view-split-reg.h"
 
-/** Definitions *****************************************************/
-
-/* The GNCLedgerDisplay2 struct describes a single register/ledger
+/** @ingroup Register
+ * @addtogroup Register2
+ * @brief Register2 is a reimplementation of the original Register with new
+ * classes based on GtkListView.
+ * @{
+ */
+/** @file gnc-ledger-display2.h
+ * @brief Public declarations for GncLedgerDisplay2 class.
+ */
+
+/**@brief Defines a single register/ledger
  * instance.  It has a SplitRegister specially configured for
  * displaying the results of a Query.  It also stores the Query.  */
 typedef struct gnc_ledger_display2 GNCLedgerDisplay2;
@@ -59,24 +67,22 @@ typedef enum
 } GNCLedgerDisplay2Type;
 
 
-/** Prototypes ******************************************************/
-
-/* returns the 'lead' account of a ledger display, or NULL if none. */
+/** returns the 'lead' account of a ledger display, or NULL if none. */
 Account * gnc_ledger_display2_leader (GNCLedgerDisplay2 *ld);
 
 GNCLedgerDisplay2Type gnc_ledger_display2_type (GNCLedgerDisplay2 *ld);
 
-/* get and set the user data associated with the ledger */
+/** get and set the user data associated with the ledger */
 void gnc_ledger_display2_set_user_data (GNCLedgerDisplay2 *ld,
                                        gpointer user_data);
 gpointer gnc_ledger_display2_get_user_data (GNCLedgerDisplay2 *ld);
 
-/* set the handlers used by the ledger display */
+/** set the handlers used by the ledger display */
 void gnc_ledger_display2_set_handlers (GNCLedgerDisplay2 *ld,
                                       GNCLedgerDisplay2Destroy destroy,
                                       GNCLedgerDisplay2GetParent get_parent);
 
-/* Set and Get the tree view used by the ledger display */
+/** Set and Get the tree view used by the ledger display */
 void gnc_ledger_display2_set_split_view_register (GNCLedgerDisplay2 *ld, GncTreeViewSplitReg *view);
 GncTreeViewSplitReg * gnc_ledger_display2_get_split_view_register (GNCLedgerDisplay2 *ld);
 
@@ -85,17 +91,17 @@ void gnc_ledger_display2_set_split_view_refresh (GNCLedgerDisplay2 *ld, gboolean
 /** Returns the parent of a given ledger display */
 GtkWidget *gnc_ledger_display2_get_parent( GNCLedgerDisplay2 *ld );
 
-/* return the split register associated with a ledger display */
+/** return the split register associated with a ledger display */
 GncTreeModelSplitReg * gnc_ledger_display2_get_split_model_register (GNCLedgerDisplay2 *ld);
 
-/* opens up a register window to display a single account */
+/** opens up a register window to display a single account */
 GNCLedgerDisplay2 * gnc_ledger_display2_simple (Account *account);
 
-/* opens up a register window to display the parent account and all of
+/** opens up a register window to display the parent account and all of
  * its children. */
 GNCLedgerDisplay2 * gnc_ledger_display2_subaccounts (Account *account);
 
-/* opens up a general ledger window */
+/** opens up a general ledger window */
 GNCLedgerDisplay2 * gnc_ledger_display2_gl (void);
 
 /**
@@ -107,37 +113,37 @@ GNCLedgerDisplay2 * gnc_ledger_display2_gl (void);
  **/
 GNCLedgerDisplay2 * gnc_ledger_display2_template_gl (char *id);
 
-/* display a general ledger for an arbitrary query */
+/** display a general ledger for an arbitrary query */
 GNCLedgerDisplay2 * gnc_ledger_display2_query (Query *query,
         SplitRegisterType2 type,
         SplitRegisterStyle2 style);
 
-/* Set the query used for a register. */
+/** Set the query used for a register. */
 void gnc_ledger_display2_set_query (GNCLedgerDisplay2 *ledger_display,
                                    Query *q);
 
-/* return the query associated with a ledger */
+/** return the query associated with a ledger */
 Query * gnc_ledger_display2_get_query (GNCLedgerDisplay2 *ld);
 
-/* If the given ledger display still exists, return it. Otherwise,
+/** If the given ledger display still exists, return it. Otherwise,
  * return NULL */
 GNCLedgerDisplay2 * gnc_ledger_display2_find_by_query (Query *q);
 
-/* redisplay/redraw only the indicated window. Both routines do same
+/** redisplay/redraw only the indicated window. Both routines do same
  * thing, they differ only by the argument they take. */
 void gnc_ledger_display2_refresh (GNCLedgerDisplay2 * ledger_display);
 void gnc_ledger_display2_refresh_by_split_register (GncTreeModelSplitReg *model);
 
-/* This is used to load the register for the schedule */
+/** This is used to load the register for the schedule */
 void gnc_ledger_display2_refresh_sched (GNCLedgerDisplay2 *ld, GList *splits);
 
-/* Refilter the register */
+/** Refilter the register */
 void gnc_ledger_display2_refilter (GNCLedgerDisplay2 *ld);
 
-/* close the window */
+/** close the window */
 void gnc_ledger_display2_close (GNCLedgerDisplay2 * ledger_display);
 
-/* Returns a boolean of whether this display should be single or double lined
+/** Returns a boolean of whether this display should be single or double lined
  * mode by default */
 gboolean gnc_ledger_display2_default_double_line (GNCLedgerDisplay2 *gld);
 



Summary of changes:
 src/business/business-ledger/gncEntryLedger.h      | 30 ++++++++-----
 .../business-ledger/gncEntryLedgerControl.h        |  9 +++-
 .../business-ledger/gncEntryLedgerLayout.h         |  9 +++-
 src/business/business-ledger/gncEntryLedgerModel.h |  9 +++-
 src/business/business-ledger/gncEntryLedgerP.h     | 21 +++++----
 src/gnome-utils/gnc-tree-control-split-reg.h       |  8 +++-
 src/gnome-utils/gnc-tree-model-split-reg.h         | 15 ++++---
 src/gnome-utils/gnc-tree-util-split-reg.h          |  9 +++-
 src/gnome-utils/gnc-tree-view-split-reg.h          |  9 +++-
 src/gnome/gnc-plugin-page-register2.h              | 19 +++-----
 src/gnome/gnc-plugin-register2.h                   |  8 +++-
 src/gnome/gnc-split-reg2.h                         |  9 +++-
 src/register/ledger-core/gnc-ledger-display2.h     | 52 ++++++++++++----------
 src/register/register-core/cellblock.h             | 35 ++++++++++++++-
 14 files changed, 166 insertions(+), 76 deletions(-)



More information about the gnucash-changes mailing list