[Gnucash-changes] Doxygen tag updates.
Neil Williams
codehelp at cvs.gnucash.org
Mon Feb 28 14:32:36 EST 2005
Log Message:
-----------
Doxygen tag updates.
Tags:
----
gnucash-gnome2-dev
Modified Files:
--------------
gnucash:
ChangeLog
gnucash/src/app-utils:
gnc-ui-util.h
gnucash/src/doc:
doxygen_main_page.c
gnucash/src/engine:
Scrub2.c
Scrub3.c
cap-gains.c
gnc-budget-book-p.h
gnc-budget-book.c
gnc-budget-book.h
gnc-budget-cat-p.h
gnc-budget-cat.c
gnc-budget-cat.h
gnc-budget-p.h
gnc-budget-period-p.h
gnc-budget-period-value-p.h
gnc-budget-period-value.c
gnc-budget-period-value.h
gnc-budget-period.c
gnc-budget-period.h
gnc-budget.c
gnc-budget.h
gnc-engine.h
gnc-filepath-utils.c
gnc-filepath-utils.h
policy-p.h
policy.c
gnucash/src/gnome:
dialog-budget-category.c
dialog-budget-category.h
dialog-budget-list.c
dialog-budget-list.h
dialog-budget-workbench.c
dialog-budget-workbench.h
druid-budget-create.c
druid-budget-create.h
gnc-budget-gui.h
gnc-plugin-page-account-tree.h
gnc-plugin-page-register.h
gnucash/src/gnome-utils:
QuickFill.h
account-quickfill.h
dialog-commodity.c
dialog-commodity.h
gnc-budget-list-tree-model.c
gnc-budget-list-tree-model.h
gnc-budget-tree-model.c
gnc-budget-tree-model.h
gnc-gnome-utils.h
gnc-tree-model-account-types.h
gnc-tree-model-account.h
gnc-tree-model-commodity.h
gnc-tree-model-price.h
gnc-tree-view-account.h
gnc-tree-view-commodity.h
gnc-tree-view-common.h
gnc-tree-view-price.h
gnucash/src/report/report-gnome:
gnc-plugin-page-report.h
Revision Data
-------------
Index: ChangeLog
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/ChangeLog,v
retrieving revision 1.1487.2.179
retrieving revision 1.1487.2.180
diff -LChangeLog -LChangeLog -u -r1.1487.2.179 -r1.1487.2.180
--- ChangeLog
+++ ChangeLog
@@ -1,3 +1,61 @@
+2005-02-28 Neil Williams <linux at codehelp.co.uk>
+
+ * ./src/app-utils/gnc-ui-util.h:
+ * ./src/doc/doxygen_main_page.c:
+ * ./src/engine/Scrub2.c:
+ * ./src/engine/Scrub3.c:
+ * ./src/engine/cap-gains.c:
+ * ./src/engine/gnc-budget-book-p.h:
+ * ./src/engine/gnc-budget-book.c:
+ * ./src/engine/gnc-budget-book.h:
+ * ./src/engine/gnc-budget-cat-p.h:
+ * ./src/engine/gnc-budget-cat.c:
+ * ./src/engine/gnc-budget-cat.h:
+ * ./src/engine/gnc-budget-p.h:
+ * ./src/engine/gnc-budget-period-p.h:
+ * ./src/engine/gnc-budget-period-value-p.h:
+ * ./src/engine/gnc-budget-period-value.c:
+ * ./src/engine/gnc-budget-period-value.h:
+ * ./src/engine/gnc-budget-period.c:
+ * ./src/engine/gnc-budget-period.h:
+ * ./src/engine/gnc-budget.c:
+ * ./src/engine/gnc-budget.h:
+ * ./src/engine/gnc-engine.h:
+ * ./src/engine/gnc-filepath-utils.c:
+ * ./src/engine/gnc-filepath-utils.h:
+ * ./src/engine/policy-p.h:
+ * ./src/engine/policy.c:
+ * ./src/gnome-utils/QuickFill.h:
+ * ./src/gnome-utils/account-quickfill.h:
+ * ./src/gnome-utils/dialog-commodity.c:
+ * ./src/gnome-utils/dialog-commodity.h:
+ * ./src/gnome-utils/gnc-budget-list-tree-model.c:
+ * ./src/gnome-utils/gnc-budget-list-tree-model.h:
+ * ./src/gnome-utils/gnc-budget-tree-model.c:
+ * ./src/gnome-utils/gnc-budget-tree-model.h:
+ * ./src/gnome-utils/gnc-gnome-utils.h:
+ * ./src/gnome-utils/gnc-tree-model-account-types.h:
+ * ./src/gnome-utils/gnc-tree-model-account.h:
+ * ./src/gnome-utils/gnc-tree-model-commodity.h:
+ * ./src/gnome-utils/gnc-tree-model-price.h:
+ * ./src/gnome-utils/gnc-tree-view-account.h:
+ * ./src/gnome-utils/gnc-tree-view-commodity.h:
+ * ./src/gnome-utils/gnc-tree-view-common.h:
+ * ./src/gnome-utils/gnc-tree-view-price.h:
+ * ./src/gnome/dialog-budget-category.c:
+ * ./src/gnome/dialog-budget-category.h:
+ * ./src/gnome/dialog-budget-list.c:
+ * ./src/gnome/dialog-budget-list.h:
+ * ./src/gnome/dialog-budget-workbench.c:
+ * ./src/gnome/dialog-budget-workbench.h:
+ * ./src/gnome/druid-budget-create.c:
+ * ./src/gnome/druid-budget-create.h:
+ * ./src/gnome/gnc-budget-gui.h:
+ * ./src/gnome/gnc-plugin-page-account-tree.h:
+ * ./src/gnome/gnc-plugin-page-register.h:
+ * ./src/report/report-gnome/gnc-plugin-page-report.h:
+ Doxygen tag updates.
+
2005-02-23 Joshua Sled <jsled at asynchronous.org>
* src/gnome/gw-gnc-spec.scm: Expose
Index: dialog-budget-list.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome/Attic/dialog-budget-list.h,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/gnome/dialog-budget-list.h -Lsrc/gnome/dialog-budget-list.h -u -r1.1.2.1 -r1.1.2.2
--- src/gnome/dialog-budget-list.h
+++ src/gnome/dialog-budget-list.h
@@ -22,10 +22,12 @@
* *
\********************************************************************/
-/** @addtogroup gui
+/** @addtogroup GUI
+ * @{ */
+/** @addtogroup Budget_GUI
* @{ */
/** @file dialog-budget-list.h
- * @breif Dialog to show the list of available budgets to the user.
+ * @brief Dialog to show the list of available budgets to the user.
* @author Created by Darin Willits 08 sep 2003
* @author Copyright (c) 08 sep 2003 Darin Willits <darin at willits.ca>
*
@@ -41,3 +43,6 @@
void add_budget_to_model( gpointer data, gpointer user_data );
#endif // __DIALOG_BUDGET_LIST_H__
+
+/** @} */
+/** @} */
Index: gnc-budget-gui.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome/Attic/gnc-budget-gui.h,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/gnome/gnc-budget-gui.h -Lsrc/gnome/gnc-budget-gui.h -u -r1.1.2.1 -r1.1.2.2
--- src/gnome/gnc-budget-gui.h
+++ src/gnome/gnc-budget-gui.h
@@ -21,10 +21,12 @@
* *
\********************************************************************/
-/** @addtogroup gui
+/** @addtogroup GUI
+ * @{ */
+/** @addtogroup Budget_GUI
* @{ */
/** @file gnc-budget-gui.h
- * @breif Common defines used by the budgeting gui components.
+ * @brief Common defines used by the budgeting gui components.
* @author Created by Darin Willits 08 sep 2003
* @author Copyright (c) 08 sep 2003 Darin Willits <darin at willits.ca>
*
@@ -36,3 +38,6 @@
#define GNC_BUDGET_GUI_FILE "budget.glade"
#endif // __GNC_BUDGET_H__
+
+/** @} */
+/** @} */
Index: dialog-budget-category.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome/Attic/dialog-budget-category.h,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/gnome/dialog-budget-category.h -Lsrc/gnome/dialog-budget-category.h -u -r1.1.2.1 -r1.1.2.2
--- src/gnome/dialog-budget-category.h
+++ src/gnome/dialog-budget-category.h
@@ -22,10 +22,12 @@
* *
\********************************************************************/
-/** @addtogroup gnome
+/** @addtogroup GUI
* @{ */
-/** @file dialog-budget-category.h
- * @breif Definition of the public interface of the budget category dialog.
+/** @addtogroup Budget_GUI Budget dialogs
+ * @{ */
+ /** @file dialog-budget-category.h
+ * @brief Definition of the public interface of the budget category dialog.
* @author Created by Darin Willits 10 sep 2003
* @author Copyright (c) 10 sep 2003 Darin Willits <darin at willits.ca>
*
@@ -45,3 +47,6 @@
*/
void gnc_budget_category_new_dialog_create(GncBudget* budget);
#endif // __DIALOG_BUDGET_CATEGORY_H__
+
+/** @} */
+/** @} */
Index: dialog-budget-category.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome/Attic/dialog-budget-category.c,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -Lsrc/gnome/dialog-budget-category.c -Lsrc/gnome/dialog-budget-category.c -u -r1.1.2.2 -r1.1.2.3
--- src/gnome/dialog-budget-category.c
+++ src/gnome/dialog-budget-category.c
@@ -22,10 +22,12 @@
* *
\********************************************************************/
-/** @addtogroup gnome
+/** @addtogroup GUI
+ * @{ */
+/** @addtogroup Budget_GUI
* @{ */
/** @file dialog-budget-category.c
- * @breif Implementation of the budget category dialog.
+ * @brief Implementation of the budget category dialog.
* @author Created by Darin Willits 10 sep 2003
* @author Copyright (c) 10 sep 2003 Darin Willits <darin at willits.ca>
*
@@ -320,3 +322,6 @@
gtk_widget_show_all(dlg->wnd);
}
+
+/** @} */
+/** @} */
Index: dialog-budget-workbench.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome/Attic/dialog-budget-workbench.c,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -Lsrc/gnome/dialog-budget-workbench.c -Lsrc/gnome/dialog-budget-workbench.c -u -r1.1.2.2 -r1.1.2.3
--- src/gnome/dialog-budget-workbench.c
+++ src/gnome/dialog-budget-workbench.c
@@ -22,10 +22,12 @@
* *
\********************************************************************/
-/** @addtogroup gnome
+/** @addtogroup GUI
+ * @{ */
+/** @addtogroup Budget_GUI
* @{ */
/** @file dialog-budget-workbench.c
- * @breif Implmentation of the budget workbench dialog.
+ * @brief Implmentation of the budget workbench dialog.
* @author Created by Darin Willits 14 sep 2003
* @author Copyright (c) 14 sep 2003 Darin Willits <darin at willits.ca>
*
@@ -595,3 +597,6 @@
printf("Showing Workbench dialog: Budget: %p\n", bench->budget);
gtk_widget_show_all(bench->wnd);
}
+
+/** @} */
+/** @} */
Index: druid-budget-create.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome/Attic/druid-budget-create.h,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/gnome/druid-budget-create.h -Lsrc/gnome/druid-budget-create.h -u -r1.1.2.1 -r1.1.2.2
--- src/gnome/druid-budget-create.h
+++ src/gnome/druid-budget-create.h
@@ -22,10 +22,12 @@
* *
\********************************************************************/
-/** @addtogroup gui
+/** @addtogroup GUI
+ * @{ */
+/** @addtogroup Budget_GUI
* @{ */
/** @file druid-budget-create.h
- * @breif Public interface for the budget creation druid.
+ * @brief Public interface for the budget creation druid.
* @author Created by Darin Willits 08 sep 2003
* @author Copyright (c) 08 sep 2003 Darin Willits <darin at willits.ca>
*
@@ -42,3 +44,6 @@
#endif // __DRUID_BUDGET_CREATE_H__
+
+/** @} */
+/** @} */
Index: dialog-budget-list.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome/Attic/dialog-budget-list.c,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/gnome/dialog-budget-list.c -Lsrc/gnome/dialog-budget-list.c -u -r1.1.2.1 -r1.1.2.2
--- src/gnome/dialog-budget-list.c
+++ src/gnome/dialog-budget-list.c
@@ -22,10 +22,12 @@
* *
\********************************************************************/
-/** @addtogroup gui
+/** @addtogroup GUI
+ * @{ */
+/** @addtogroup Budget_GUI
* @{ */
/** @file dialog-budget-list.c
- * @breif Implementation of the budget list dialog.
+ * @brief Implementation of the budget list dialog.
* @author Created by Darin Willits 08 sep 2003
* @author Copyright (c) 08 sep 2003 Darin Willits <darin at willits.ca>
*
@@ -241,3 +243,6 @@
gtk_widget_show_all(dlg->wnd);
}
+
+/** @} */
+/** @} */
Index: dialog-budget-workbench.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome/Attic/dialog-budget-workbench.h,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/gnome/dialog-budget-workbench.h -Lsrc/gnome/dialog-budget-workbench.h -u -r1.1.2.1 -r1.1.2.2
--- src/gnome/dialog-budget-workbench.h
+++ src/gnome/dialog-budget-workbench.h
@@ -22,10 +22,12 @@
* *
\********************************************************************/
-/** @addtogroup gnome
+/** @addtogroup GUI
+ * @{ */
+/** @addtogroup Budget_GUI
* @{ */
/** @file dialog-budget-workbench.h
- * @breif Definition of the budget workbench dialog interface.
+ * @brief Definition of the budget workbench dialog interface.
* @author Created by Darin Willits 14 sep 2003
* @author Copyright (c) 14 sep 2003 Darin Willits <darin at willits.ca>
*
@@ -41,3 +43,6 @@
void gnc_budget_workbench_dialog_create(GncBudget* budget);
#endif // __DIALOG_BUDGET_WORKBENCH_H__
+
+/** @} */
+/** @} */
Index: gnc-plugin-page-register.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome/Attic/gnc-plugin-page-register.h,v
retrieving revision 1.1.2.8
retrieving revision 1.1.2.9
diff -Lsrc/gnome/gnc-plugin-page-register.h -Lsrc/gnome/gnc-plugin-page-register.h -u -r1.1.2.8 -r1.1.2.9
--- src/gnome/gnc-plugin-page-register.h
+++ src/gnome/gnc-plugin-page-register.h
@@ -22,7 +22,7 @@
* Boston, MA 02111-1307, USA gnu at gnu.org
*/
-/** @addtogroup UI
+/** @addtogroup GUI
@{ */
/** @file gnc-plugin-register-tree.h
@brief utility functions for the GnuCash UI
Index: druid-budget-create.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome/Attic/druid-budget-create.c,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/gnome/druid-budget-create.c -Lsrc/gnome/druid-budget-create.c -u -r1.1.2.1 -r1.1.2.2
--- src/gnome/druid-budget-create.c
+++ src/gnome/druid-budget-create.c
@@ -22,10 +22,12 @@
* *
\********************************************************************/
-/** @addtogroup gui
+/** @addtogroup GUI
+ * @{ */
+/** @addtogroup Budget_GUI
* @{ */
/** @file druid-budget-create.c
- * @breif Implementation of the budget create druid.
+ * @brief Implementation of the budget create druid.
* @author Created by Darin Willits 08 sep 2003
* @author Copyright (c) 08 sep 2003 Darin Willits <darin at willits.ca>
*
@@ -324,3 +326,6 @@
gtk_widget_show_all(druid->wnd);
}
+
+/** @} */
+/** @} */
Index: gnc-plugin-page-account-tree.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome/Attic/gnc-plugin-page-account-tree.h,v
retrieving revision 1.1.2.4
retrieving revision 1.1.2.5
diff -Lsrc/gnome/gnc-plugin-page-account-tree.h -Lsrc/gnome/gnc-plugin-page-account-tree.h -u -r1.1.2.4 -r1.1.2.5
--- src/gnome/gnc-plugin-page-account-tree.h
+++ src/gnome/gnc-plugin-page-account-tree.h
@@ -22,7 +22,7 @@
* Boston, MA 02111-1307, USA gnu at gnu.org
*/
-/** @addtogroup UI
+/** @addtogroup GUI
@{ */
/** @file gnc-plugin-page-account-tree.h
@brief utility functions for the GnuCash UI
Index: gnc-budget-tree-model.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/gnc-budget-tree-model.c,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/gnome-utils/gnc-budget-tree-model.c -Lsrc/gnome-utils/gnc-budget-tree-model.c -u -r1.1.2.1 -r1.1.2.2
--- src/gnome-utils/gnc-budget-tree-model.c
+++ src/gnome-utils/gnc-budget-tree-model.c
@@ -22,10 +22,12 @@
* *
\********************************************************************/
-/** @addtogroup gnome-util
+/** @addtogroup GUI
+ * @{ */
+/** @addtogroup Budget_Tree
* @{ */
/** @file gnc-budget-tree-model.c
- * @breif Implementation of the budget tree model.
+ * @brief Implementation of the budget tree model.
* @author Created by Darin Willits 09 sep 2003
* @author Copyright (c) 09 sep 2003 Darin Willits <darin at willits.ca>
*
@@ -724,3 +726,6 @@
printf("Category Selected: %s\n", gnc_budget_category_get_name(iter->user_data));
return (GncBudgetCategory *) iter->user_data;
}
+
+/** @} */
+/** @} */
Index: gnc-tree-model-commodity.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/gnc-tree-model-commodity.h,v
retrieving revision 1.1.2.6
retrieving revision 1.1.2.7
diff -Lsrc/gnome-utils/gnc-tree-model-commodity.h -Lsrc/gnome-utils/gnc-tree-model-commodity.h -u -r1.1.2.6 -r1.1.2.7
--- src/gnome-utils/gnc-tree-model-commodity.h
+++ src/gnome-utils/gnc-tree-model-commodity.h
@@ -23,7 +23,7 @@
* Boston, MA 02111-1307, USA gnu at gnu.org
*/
-/** @addtogroup Engine
+/** @addtogroup GUI
@{ */
/** @file gnc-tree-model-commodity.h
@brief GtkTreeModel implementation for gnucash commodities.
Index: gnc-tree-model-account-types.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/gnc-tree-model-account-types.h,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -Lsrc/gnome-utils/gnc-tree-model-account-types.h -Lsrc/gnome-utils/gnc-tree-model-account-types.h -u -r1.1.2.2 -r1.1.2.3
--- src/gnome-utils/gnc-tree-model-account-types.h
+++ src/gnome-utils/gnc-tree-model-account-types.h
@@ -22,6 +22,14 @@
* 59 Temple Place - Suite 330 Fax: +1-617-542-2652
* Boston, MA 02111-1307, USA gnu at gnu.org
*/
+/** @addtogroup GUI
+ * @{ */
+/** @file gnc-tree-model-account-types.h
+ * @brief GtkTreeModel implementation to display account types in a GtkTreeView.
+ * @author Copyright (C) 2003 Jan Arne Petersen
+ * @author: Jan Arne Petersen <jpetersen at uni-bonn.de>
+ *
+ */
#ifndef __GNC_TREE_MODEL_ACCOUNT_TYPES_H
#define __GNC_TREE_MODEL_ACCOUNT_TYPES_H
@@ -73,3 +81,5 @@
G_END_DECLS
#endif /* __GNC_TREE_MODEL_ACCOUNT_H */
+
+/** @} */
Index: gnc-budget-list-tree-model.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/gnc-budget-list-tree-model.h,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/gnome-utils/gnc-budget-list-tree-model.h -Lsrc/gnome-utils/gnc-budget-list-tree-model.h -u -r1.1.2.1 -r1.1.2.2
--- src/gnome-utils/gnc-budget-list-tree-model.h
+++ src/gnome-utils/gnc-budget-list-tree-model.h
@@ -22,10 +22,12 @@
* *
\********************************************************************/
-/** @addtogroup engine
+/** @addtogroup GUI
+ * @{ */
+/** @addtogroup Budget_Tree
* @{ */
/** @file gnc-budget-list-tree-model.h
- * @breif The tree model which represents the internal list of Budget
+ * @brief The tree model which represents the internal list of Budget
* objects.
* @author Created by Darin Willits 09 feb 2004
* @author Copyright (c) 09 feb 2004 Darin Willits <darin at willits.ca>
@@ -85,3 +87,6 @@
#endif // __GNC_BUDGET_LIST_TREE_MODEL_H__
+
+/** @} */
+/** @} */
Index: gnc-tree-view-price.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/gnc-tree-view-price.h,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/gnome-utils/gnc-tree-view-price.h -Lsrc/gnome-utils/gnc-tree-view-price.h -u -r1.1.2.1 -r1.1.2.2
--- src/gnome-utils/gnc-tree-view-price.h
+++ src/gnome-utils/gnc-tree-view-price.h
@@ -22,7 +22,7 @@
* *
\********************************************************************/
-/** @addtogroup Engine
+/** @addtogroup GUI
@{ */
/** @file gnc-tree-view-price.h
@brief GtkTreeView implementation for gnucash price tree.
Index: gnc-tree-view-common.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/gnc-tree-view-common.h,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -Lsrc/gnome-utils/gnc-tree-view-common.h -Lsrc/gnome-utils/gnc-tree-view-common.h -u -r1.1.2.2 -r1.1.2.3
--- src/gnome-utils/gnc-tree-view-common.h
+++ src/gnome-utils/gnc-tree-view-common.h
@@ -22,7 +22,7 @@
* *
\********************************************************************/
-/** @addtogroup Engine
+/** @addtogroup GUI
@{ */
/** @file gnc-tree-view-common.h
@brief common utilities for manipulating a GtkTreeView within gnucash
Index: gnc-tree-model-price.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/gnc-tree-model-price.h,v
retrieving revision 1.1.2.3
retrieving revision 1.1.2.4
diff -Lsrc/gnome-utils/gnc-tree-model-price.h -Lsrc/gnome-utils/gnc-tree-model-price.h -u -r1.1.2.3 -r1.1.2.4
--- src/gnome-utils/gnc-tree-model-price.h
+++ src/gnome-utils/gnc-tree-model-price.h
@@ -23,7 +23,7 @@
* Boston, MA 02111-1307, USA gnu at gnu.org
*/
-/** @addtogroup Engine
+/** @addtogroup GUI
@{ */
/** @file gnc-tree-model-price.h
@brief GtkTreeModel implementation for gnucash price database.
Index: gnc-tree-model-account.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/gnc-tree-model-account.h,v
retrieving revision 1.1.2.9
retrieving revision 1.1.2.10
diff -Lsrc/gnome-utils/gnc-tree-model-account.h -Lsrc/gnome-utils/gnc-tree-model-account.h -u -r1.1.2.9 -r1.1.2.10
--- src/gnome-utils/gnc-tree-model-account.h
+++ src/gnome-utils/gnc-tree-model-account.h
@@ -23,7 +23,7 @@
* Boston, MA 02111-1307, USA gnu at gnu.org
*/
-/** @addtogroup Engine
+/** @addtogroup GUI
@{ */
/** @file gnc-tree-model-account.h
@brief GtkTreeModel implementation for gnucash account tree.
Index: QuickFill.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/QuickFill.h,v
retrieving revision 1.1.4.2
retrieving revision 1.1.4.3
diff -Lsrc/gnome-utils/QuickFill.h -Lsrc/gnome-utils/QuickFill.h -u -r1.1.4.2 -r1.1.4.3
--- src/gnome-utils/QuickFill.h
+++ src/gnome-utils/QuickFill.h
@@ -28,7 +28,7 @@
#include <gdk/gdk.h>
#include <glib.h>
-/** @addtogroup QuickFill
+/** @addtogroup QuickFill Quick Fill: auto-complete typed user input.
QuickFill is meant to be used by the GUI to auto-complete
(e.g. tab-complete) typed user input.
Quickfill is implemented as a heirarchical tree
@@ -45,7 +45,7 @@
@{
@file QuickFill.h
- @breif Quickfill is used to auto-complete typed user entries.
+ @brief Quickfill is used to auto-complete typed user entries.
@author Copyright (C) 1997 Robin D. Clark
@author Copyright (C) 1998,2004 Linas Vepstas <linas at linas.org>
@author Copyright (C) 2000 Dave Peticolas
Index: dialog-commodity.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/dialog-commodity.h,v
retrieving revision 1.3.4.3
retrieving revision 1.3.4.4
diff -Lsrc/gnome-utils/dialog-commodity.h -Lsrc/gnome-utils/dialog-commodity.h -u -r1.3.4.3 -r1.3.4.4
--- src/gnome-utils/dialog-commodity.h
+++ src/gnome-utils/dialog-commodity.h
@@ -21,7 +21,7 @@
* Boston, MA 02111-1307, USA gnu at gnu.org *
********************************************************************/
-/** @addtogroup UI
+/** @addtogroup GUI
@{ */
/** @file dialog-commodity.h
@brief "select" and "new" commodity windows
Index: gnc-tree-view-commodity.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/gnc-tree-view-commodity.h,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/gnome-utils/gnc-tree-view-commodity.h -Lsrc/gnome-utils/gnc-tree-view-commodity.h -u -r1.1.2.1 -r1.1.2.2
--- src/gnome-utils/gnc-tree-view-commodity.h
+++ src/gnome-utils/gnc-tree-view-commodity.h
@@ -22,7 +22,7 @@
* *
\********************************************************************/
-/** @addtogroup Engine
+/** @addtogroup GUI
@{ */
/** @file gnc-tree-view-commodity.h
@brief GtkTreeView implementation for gnucash commodity tree.
Index: gnc-tree-view-account.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/gnc-tree-view-account.h,v
retrieving revision 1.1.2.8
retrieving revision 1.1.2.9
diff -Lsrc/gnome-utils/gnc-tree-view-account.h -Lsrc/gnome-utils/gnc-tree-view-account.h -u -r1.1.2.8 -r1.1.2.9
--- src/gnome-utils/gnc-tree-view-account.h
+++ src/gnome-utils/gnc-tree-view-account.h
@@ -22,7 +22,7 @@
* *
\********************************************************************/
-/** @addtogroup Engine
+/** @addtogroup GUI
@{ */
/** @file gnc-tree-view-account.h
@brief GtkTreeView implementation for gnucash account tree.
Index: gnc-budget-list-tree-model.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/gnc-budget-list-tree-model.c,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/gnome-utils/gnc-budget-list-tree-model.c -Lsrc/gnome-utils/gnc-budget-list-tree-model.c -u -r1.1.2.1 -r1.1.2.2
--- src/gnome-utils/gnc-budget-list-tree-model.c
+++ src/gnome-utils/gnc-budget-list-tree-model.c
@@ -22,10 +22,12 @@
* *
\********************************************************************/
-/** @addtogroup gnome-util
+/** @addtogroup GUI
+ * @{ */
+/** @addtogroup Budget_Tree
* @{ */
/** @file gnc-budget-list-tree-model.c
- * @breif Implementation of the Budget List Tree model.
+ * @brief Implementation of the Budget List Tree model.
* @author Created by Darin Willits 09 feb 2004
* @author Copyright (c) 09 feb 2004 Darin Willits <darin at willits.ca>
*
@@ -570,3 +572,5 @@
}
+/** @} */
+/** @} */
Index: gnc-gnome-utils.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/gnc-gnome-utils.h,v
retrieving revision 1.1.4.3
retrieving revision 1.1.4.4
diff -Lsrc/gnome-utils/gnc-gnome-utils.h -Lsrc/gnome-utils/gnc-gnome-utils.h -u -r1.1.4.3 -r1.1.4.4
--- src/gnome-utils/gnc-gnome-utils.h
+++ src/gnome-utils/gnc-gnome-utils.h
@@ -22,7 +22,7 @@
* *
\********************************************************************/
-/** @addtogroup Utils
+/** @addtogroup GUI
@{ */
/** @file gnc-gnome-utils.h
@brief Gnome specific utility functions.
Index: dialog-commodity.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/dialog-commodity.c,v
retrieving revision 1.8.4.12
retrieving revision 1.8.4.13
diff -Lsrc/gnome-utils/dialog-commodity.c -Lsrc/gnome-utils/dialog-commodity.c -u -r1.8.4.12 -r1.8.4.13
--- src/gnome-utils/dialog-commodity.c
+++ src/gnome-utils/dialog-commodity.c
@@ -21,7 +21,7 @@
* Boston, MA 02111-1307, USA gnu at gnu.org *
********************************************************************/
-/** @addtogroup UI
+/** @addtogroup GUI
@{ */
/** @file dialog-commodity.c
@brief "select" and "new" commodity windows
@@ -1129,3 +1129,5 @@
LEAVE(" ");
return TRUE;
}
+
+/** @} */
Index: gnc-budget-tree-model.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/gnc-budget-tree-model.h,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/gnome-utils/gnc-budget-tree-model.h -Lsrc/gnome-utils/gnc-budget-tree-model.h -u -r1.1.2.1 -r1.1.2.2
--- src/gnome-utils/gnc-budget-tree-model.h
+++ src/gnome-utils/gnc-budget-tree-model.h
@@ -22,10 +22,12 @@
* *
\********************************************************************/
-/** @addtogroup gnome-util
+/** @addtogroup GUI
+ * @{ */
+/** @addtogroup Budget_Tree Tree model for budget objects
* @{ */
/** @file gnc-budget-tree-model.h
- * @breif Definition of the tree model for budget objects.
+ * @brief Definition of the tree model for budget objects.
* @author Created by Darin Willits 09 sep 2003
* @author Copyright (c) 09 sep 2003 Darin Willits <darin at willits.ca>
*
@@ -89,3 +91,6 @@
G_END_DECLS
#endif // __GNC_BUDGET_TREE_MODEL_H__
+
+/** @} */
+/** @} */
Index: account-quickfill.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/account-quickfill.h,v
retrieving revision 1.1.4.1
retrieving revision 1.1.4.2
diff -Lsrc/gnome-utils/account-quickfill.h -Lsrc/gnome-utils/account-quickfill.h -u -r1.1.4.1 -r1.1.4.2
--- src/gnome-utils/account-quickfill.h
+++ src/gnome-utils/account-quickfill.h
@@ -19,7 +19,10 @@
* Boston, MA 02111-1307, USA gnu at gnu.org *
* *
\********************************************************************/
-/** @addtogroup Account_Quickfill Quickfill Account Names
+/** @addtogroup QuickFill
+ @{
+*/
+/** @addtogroup Account_QuickFill Account Names
For systems with a large number of accounts (>500), the creation
of the account name quickfill can take a significant amount of
time (tens of seconds in bad cases). This routine will build
@@ -73,3 +76,4 @@
#endif
/** @} */
+/** @} */
Index: doxygen_main_page.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/doc/doxygen_main_page.c,v
retrieving revision 1.1.4.1
retrieving revision 1.1.4.2
diff -Lsrc/doc/doxygen_main_page.c -Lsrc/doc/doxygen_main_page.c -u -r1.1.4.1 -r1.1.4.2
--- src/doc/doxygen_main_page.c
+++ src/doc/doxygen_main_page.c
@@ -1,55 +1,93 @@
+/** \mainpage GnuCash design and developer's reference
-/*! \mainpage GnuCash design and developer's reference
-
-\section intro Introduction
-
-This is the new GnuCash developer and design manual for GnuCash.
+This is the new developer and design manual for GnuCash.
Previous documentation will slowly be integrated into this, and
eventually it should always be up to date since it is generated
directly from the source files using Doxygen.
\section hacking Hacking on this documentation
-I will eventually post a style guide for documenting, and document one
-of the files "by the book". Until then, feel free to start
-documenting or playing with doxygen configuration. This main page can
-be found in src/doc/doxygen_main_page.c .
-
-\subsection style_discussion Style discussion
-
-[cstim 2003-03-25] It's too bad that doxygen doesn't show the "Member
-Groups" (those created on-the-fly with @{ and @}) inside the Module
-pages (named groups, created with \\addtogroup). This means that the
-"member group" grouping of the account-related functions is only shown
-in the documentation of the Account.h header file. But in the
-documentation of the Engine group (module) all these functions are
-lumped together into one unreadable long list. This is bad (because
-1. nobody will read through the long list, 2. hyperlinks don't even
-work properly since the document is simply too big). Isn't there a way
-to have this member groups also show up on the module pages...?
-Unfortunately nesting several named modules (groups) into one another
-doesn't really solve this problem, because that way all
-account-related functions will show up in one separate group each --
-which makes these unreadable as well. Maybe it would even be better to
-not have these function names show up on the module page at all. If
-they appear *only* on the file page, they will show up in their
-respective "member group" grouping and everything would be fine.
+There is the beginning of a style guide for documenting under
+\ref tips_hints.
-[cstim 2003-03-25] The "Data Structures" page of doxygen doesn't show
-anything useful for gnucash. Obviously doxygen only accepts "real" C
-struct definitions for inclusion on that page. However, all gnucash
-data structures are defined somewhere in private headers, and only the
-typedefs are publically visible. Isn't there a way to have doxygen
-show the documentation for the <i>typedefs</i> on the "Data
-Structures" page? Unfortunately I don't know how.
+The Book Merge files are an attempt to document "by the book".
+\ref BookMerge\n
+Feel free to start documenting or playing with doxygen configuration.
+This main page can be found in src/doc/doxygen_main_page.c .
+
+Each doxygen section must be within a single comment block although
+large comment blocks can be split into separate pages:
+\ref style_discussion.
+
+This main page is just an introduction to doxygen markup, see the
+Doxygen manual for the full command set.
+
+- \ref tips_hints Tips and hints for using doxygen
+- \ref style_discussion Long comments, pages, editors
+- \ref reference Links to the Doxygen manual
+
+*/
+/**
+\page tips_hints Useful tips for doxygen in C files
+
+ - \ref index Introduction
+ - \ref style_discussion Long comments, pages, editors
+ - \ref reference The Doxygen manual
+
+\section tips An introduction to doxygen markup
+
+\subsection Locations What to document
+
+All declarations for:
+
+-# typedef
+-# struct
+-# enum
+-# functions
+
+This will enable doxygen to link all parameter types to the declarations
+every time the type is used in a function - very helpful to new developers.
+
+\subsection Files Private files
+
+If your declarations are in separate files, like private header files,
+a simple block can still be linked into doxygen as long as the file is
+identified to doxygen using a '\\file' section:
+
+/** \\file filename.h\n
+ \\brief one-liner summary of the file purpose\n
+ \\author the usual copyright statement
-[cstim 2003-03-25] This mainpage file should at some time be moved to
-a file name ending in .txt or even .html. It's a PITA to edit one huge
-C comment. All text editors will run amok sooner or later (well,
-XEmacs does :) and will not support proper HTML markup and editing
-inside this C comment... well, that's not really a problem of the
-outcome, yes. It would just make life easier for editing this
-non-source file.
+\subsection Methods How to document
+
+Every doxygen comment block starts with an adapted comment marker.
+You can use an extra slash /// or an extra asterisk /** . Blocks end
+in the usual way. Doxygen accepts commands using a backslash.
+
+To put a description with each function or structure, use '\\brief'
+End the brief description with a blank line. The rest of the documentation will
+then be shown in the body of the doxygen page.
+
+Commands may begin with \\ or @
+
+\subsection Presentation Extras
+
+ -# Start a line with a hyphen to start a list - the indent determines the
+nesting of the list:
+ - To create a numbered list, use -# e.g. for a sublist:
+ -# start a numbered list
+ - revert to previous list
+
+ End the list with a blank line.
+Use :: at the start of a function or structure to link to the page
+for that function in the doxygen documentation. e.g. ::qof_class_foreach
+
+Use the param command to describe function parameters in the text.
+
+Use the 'back reference' to document enumerator values:\n
+enum testenum {\n
+ enum_one /**< less than marker tells doxygen to use this line
+ to document enum_one.
\subsection config Editing Doxygen configuration
@@ -59,15 +97,50 @@
*
doxywizard doxygen.cfg &
-\subsection reference Doxygen reference documentation
+*/
+
+/** \page style_discussion Style discussion
+
+- \ref index Introduction
+- \ref tips_hints Tips and hints for using doxygen
+- \ref reference Links to the Doxygen manual
+
+[codehelpgpg 2004-07-25] Doxygen now copes with addgroup and this page
+can be handled more easily by splitting the old single comment into repeated
+comments, split into pages. I've worked on doxygen files in Kate, KWrite and XCode (MacOSX) and
+the comment higlighting works fine. If you do have problems, particularly when
+you start a new line within an existing comment, enter a character at the end of
+the last highlighted line to refresh the highlighting. Some editors have a specific
+refresh option.
+
+[cstim 2003-03-25] The "Data Structures" page of doxygen doesn't show
+anything useful for gnucash. Obviously doxygen only accepts "real" C
+struct definitions for inclusion on that page. However, all gnucash
+data structures are defined somewhere in private headers, and only the
+typedefs are publically visible. Isn't there a way to have doxygen
+show the documentation for the <i>typedefs</i> on the "Data
+Structures" page? Unfortunately I don't know how.
+[codehelpgpg 2004-07-25] Yes, there is a way of linking to these data structures.
+Make sure that the private header is included in the documentation by including a
+\\file command in the private header file. Then include a short doxygen comment above
+the declaration. Doxygen will accept both valid C struct definition formats.
+
+*/
+
+/** \page reference Doxygen reference documentation
+
+- \ref index Introduction
+- \ref tips_hints Tips and hints for using doxygen
+- \ref style_discussion Long comments, pages, editors
+
The Doxygen web site (http://www.stack.nl/~dimitri/doxygen/) has a
complete user manual. For the impatient, here are the most
interesting sections:
- How to write grouped documentation for files, functions, variables,
etc.: http://www.stack.nl/~dimitri/doxygen/grouping.html . Do not
-forget to add a file documentation block (@file) at the top of your
+forget to add a file documentation block (\@file) at the top of your
file. Otherwise, all documentation in that file will <i>not</i> appear
in the html output.
Index: Scrub2.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/Scrub2.c,v
retrieving revision 1.15.2.4
retrieving revision 1.15.2.5
diff -Lsrc/engine/Scrub2.c -Lsrc/engine/Scrub2.c -u -r1.15.2.4 -r1.15.2.5
--- src/engine/Scrub2.c
+++ src/engine/Scrub2.c
@@ -20,7 +20,7 @@
\********************************************************************/
/** @file Scrub2.c
- * @breif Utilities to Convert Stock Accounts to use Lots
+ * @brief Utilities to Convert Stock Accounts to use Lots
* @author Created by Linas Vepstas March 2003
* @author Copyright (c) 2003 Linas Vepstas <linas at linas.org>
*
Index: gnc-budget-period-p.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/Attic/gnc-budget-period-p.h,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/engine/gnc-budget-period-p.h -Lsrc/engine/gnc-budget-period-p.h -u -r1.1.2.1 -r1.1.2.2
--- src/engine/gnc-budget-period-p.h
+++ src/engine/gnc-budget-period-p.h
@@ -22,10 +22,12 @@
* *
\********************************************************************/
-/** @addtogroup engine
+/** @addtogroup Engine
+ * @{ */
+/** @addtogroup Budget
* @{ */
/** @file gnc-budget-period-p.h
- * @breif Private structure definition of the budget period structure.
+ * @brief Private structure definition of the budget period structure.
* @author Created by Darin Willits 16 sep 2003
* @author Copyright (c) 16 sep 2003 Darin Willits <darin at willits.ca>
*
@@ -47,3 +49,6 @@
#endif // __GNC_BUDGET_PERIOD_P_H__
+
+/** @} */
+/** @} */
Index: gnc-budget-cat.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/Attic/gnc-budget-cat.c,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -Lsrc/engine/gnc-budget-cat.c -Lsrc/engine/gnc-budget-cat.c -u -r1.1.2.2 -r1.1.2.3
--- src/engine/gnc-budget-cat.c
+++ src/engine/gnc-budget-cat.c
@@ -23,8 +23,10 @@
/** @addtogroup Engine
* @{ */
+/** @addtogroup Budget
+ * @{ */
/** @file gnc-budget-cat.c
- * @breif Implementation of the budget category methods.
+ * @brief Implementation of the budget category methods.
* @author Created by Darin Willits 05 sep 2003
* @author Copyright (c) 05 sep 2003 Darin Willits <darin at willits.ca>
*
@@ -565,3 +567,6 @@
return sum;
}
+
+/** @} */
+/** @} */
Index: gnc-budget-period.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/Attic/gnc-budget-period.c,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/engine/gnc-budget-period.c -Lsrc/engine/gnc-budget-period.c -u -r1.1.2.1 -r1.1.2.2
--- src/engine/gnc-budget-period.c
+++ src/engine/gnc-budget-period.c
@@ -22,10 +22,12 @@
* *
\********************************************************************/
-/** @addtogroup engine
+/** @addtogroup Engine
+ * @{ */
+/** @addtogroup Budget
* @{ */
/** @file gnc-budget-period.c
- * @breif Implementation of the budget period interface.
+ * @brief Implementation of the budget period interface.
* @author Created by Darin Willits 16 sep 2003
* @author Copyright (c) 16 sep 2003 Darin Willits <darin at willits.ca>
*
@@ -84,4 +86,5 @@
return &period->end_date;
}
-
+/** @} */
+/** @} */
Index: gnc-budget-book-p.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/Attic/gnc-budget-book-p.h,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/engine/gnc-budget-book-p.h -Lsrc/engine/gnc-budget-book-p.h -u -r1.1.2.1 -r1.1.2.2
--- src/engine/gnc-budget-book-p.h
+++ src/engine/gnc-budget-book-p.h
@@ -23,8 +23,10 @@
/** @addtogroup Engine
* @{ */
+/** @addtogroup Budget
+ * @{ */
/** @file gnc-budget-book-p.h
- * @breif Private functions for budget/book linkage.
+ * @brief Private functions for budget/book linkage.
* @author Created by Darin Willits 04 sep 2003
* @author Copyright (c) 04 sep 2003 Darin Willits <darin at willits.ca>
*
@@ -51,3 +53,6 @@
gboolean gnc_budget_register (void);
#endif // __BUDGETBOOK_P_H__
+
+/** @} */
+/** @} */
Index: gnc-engine.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/gnc-engine.h,v
retrieving revision 1.16.4.6
retrieving revision 1.16.4.7
diff -Lsrc/engine/gnc-engine.h -Lsrc/engine/gnc-engine.h -u -r1.16.4.6 -r1.16.4.7
--- src/engine/gnc-engine.h
+++ src/engine/gnc-engine.h
@@ -137,7 +137,7 @@
/** @brief A gnc_commodity_table is a database of commodity info. */
typedef struct gnc_commodity_table_s gnc_commodity_table;
-/** @breif Identifies that something sold at one time was bought at another.
+/** @brief Identifies that something sold at one time was bought at another.
* A GNCLot provides a way of tracking physical items as they are
* bought and sold in different transactions. By identifying
* the individual, underlying physical objects, it provides the
@@ -148,7 +148,7 @@
*/
typedef struct gnc_lot_struct GNCLot;
-/** @breif Price of commodity on a given date.
+/** @brief Price of commodity on a given date.
* A GNCPrice encapsulates price information: the cost of a commodity
* expressed as a currency, on a given date. It also holds info about
* the provenance of the price: where it came from, its general validity.
Index: gnc-budget-cat.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/Attic/gnc-budget-cat.h,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/engine/gnc-budget-cat.h -Lsrc/engine/gnc-budget-cat.h -u -r1.1.2.1 -r1.1.2.2
--- src/engine/gnc-budget-cat.h
+++ src/engine/gnc-budget-cat.h
@@ -23,8 +23,10 @@
/** @addtogroup Engine
* @{ */
+/** @addtogroup Budget
+ * @{ */
/** @file gnc-budget-cat.h
- * @breif Public interface of the budget category structure.
+ * @brief Public interface of the budget category structure.
* @author Created by Darin Willits 05 sep 2003
* @author Copyright (c) 05 sep 2003 Darin Willits <darin at willits.ca>
*
@@ -185,3 +187,6 @@
double gnc_budget_category_sum_child_values_by_index(GncBudgetCategory* category, gint index);
#endif // __BUDGET_CAT_H__
+
+/** @} */
+/** @} */
Index: gnc-budget.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/Attic/gnc-budget.h,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/engine/gnc-budget.h -Lsrc/engine/gnc-budget.h -u -r1.1.2.1 -r1.1.2.2
--- src/engine/gnc-budget.h
+++ src/engine/gnc-budget.h
@@ -24,17 +24,19 @@
/** @addtogroup Engine
* @{ */
+/** @addtogroup Budget Budget objects
+ * A budget object contains a list of budget_categories each of
+ * which define an individual budgetable item. When a budget is first
+ * created these catagories will be initialized based on the existing
+ * account hierarchy.
+ * @{ */
/** @file gnc-budget.h
- * @breif Public interface for budget objects.
+ * @brief Public interface for budget objects.
* @author Created by Darin Willits 04 sep 2003
* @author Copyright (c) 04 Darin Willits <darin at willits.ca>
*
* This file contains the public methods to interact with a budgeting
- * object. A budget object contains a list of budget_categories each of
- * which define an individual budgetable item. When a budget is first
- * created these catagories will be initialized based on the existing
- * account hierarchy.
- *
+ * object.
* This is pre-alpha code right now. User beware.
*/
@@ -185,3 +187,6 @@
GncBudget* gnc_budget_lookup (const GUID *guid, QofBook *book);
#endif // __BUDGET_H__
+
+/** @} */
+/** @} */
Index: gnc-budget-period-value-p.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/Attic/gnc-budget-period-value-p.h,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/engine/gnc-budget-period-value-p.h -Lsrc/engine/gnc-budget-period-value-p.h -u -r1.1.2.1 -r1.1.2.2
--- src/engine/gnc-budget-period-value-p.h
+++ src/engine/gnc-budget-period-value-p.h
@@ -22,10 +22,12 @@
* *
\********************************************************************/
-/** @addtogroup engine
+/** @addtogroup Engine
+ * @{ */
+/** @addtogroup Budget
* @{ */
/** @file gnc-budget-period-value-p.h
- * @breif Private structure definition of the budget period value
+ * @brief Private structure definition of the budget period value
* structure.
* @author Created by Darin Willits 16 sep 2003
* @author Copyright (c) 16 sep 2003 Darin Willits <darin at willits.ca>
@@ -50,3 +52,6 @@
#endif // __GNC_BUDGET_PERIOD_VALUE_P_H__
+
+/** @} */
+/** @} */
Index: Scrub3.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/Scrub3.c,v
retrieving revision 1.4.4.2
retrieving revision 1.4.4.3
diff -Lsrc/engine/Scrub3.c -Lsrc/engine/Scrub3.c -u -r1.4.4.2 -r1.4.4.3
--- src/engine/Scrub3.c
+++ src/engine/Scrub3.c
@@ -20,7 +20,7 @@
\********************************************************************/
/** @file Scrub3.c
- * @breif Constrain Cap Gains to Track Sources of Gains
+ * @brief Constrain Cap Gains to Track Sources of Gains
* @author Created by Linas Vepstas Sept 2003
* @author Copyright (c) 2003,2004 Linas Vepstas <linas at linas.org>
*
Index: gnc-budget-period-value.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/Attic/gnc-budget-period-value.c,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/engine/gnc-budget-period-value.c -Lsrc/engine/gnc-budget-period-value.c -u -r1.1.2.1 -r1.1.2.2
--- src/engine/gnc-budget-period-value.c
+++ src/engine/gnc-budget-period-value.c
@@ -22,10 +22,12 @@
* *
\********************************************************************/
-/** @addtogroup engine
+/** @addtogroup Engine
+ * @{ */
+/** @addtogroup Budget
* @{ */
/** @file gnc-budget-period-value.c
- * @breif Implementation of the budget-period-value structure.
+ * @brief Implementation of the budget-period-value structure.
* @author Created by Darin Willits 16 sep 2003
* @author Copyright (c) 16 sep 2003 Darin Willits <darin at willits.ca>
*
@@ -80,6 +82,6 @@
}
+/** @} */
-
-
+/** @} */
Index: gnc-budget-book.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/Attic/gnc-budget-book.h,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/engine/gnc-budget-book.h -Lsrc/engine/gnc-budget-book.h -u -r1.1.2.1 -r1.1.2.2
--- src/engine/gnc-budget-book.h
+++ src/engine/gnc-budget-book.h
@@ -23,8 +23,10 @@
/** @addtogroup Engine
* @{ */
+ /** @addtogroup Budget
+ * @{ */
/** @file gnc-budget-book.h
- * @breif Linkage between budgets and books.
+ * @brief Linkage between budgets and books.
* @author Created by Darin Willits 04 sep 2003
* @author Copyright (c) 04 sep 2003 Darin Willits <darin at willits.ca>
*
@@ -58,3 +60,6 @@
void gnc_book_delete_budget(QofBook* book, GncBudget* budget);
#endif // __BUDGETBOOK_H__
+
+/** @} */
+/** @} */
Index: policy-p.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/policy-p.h,v
retrieving revision 1.2.4.1
retrieving revision 1.2.4.2
diff -Lsrc/engine/policy-p.h -Lsrc/engine/policy-p.h -u -r1.2.4.1 -r1.2.4.2
--- src/engine/policy-p.h
+++ src/engine/policy-p.h
@@ -20,7 +20,7 @@
\********************************************************************/
/** @file policy-p.h
- * @breif Implement Accounting Policy Private header File.
+ * @brief Implement Accounting Policy Private header File.
* @author Created by Linas Vepstas August 2003
* @author Copyright (c) 2003 Linas Vepstas <linas at linas.org>
*
Index: gnc-budget-p.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/Attic/gnc-budget-p.h,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/engine/gnc-budget-p.h -Lsrc/engine/gnc-budget-p.h -u -r1.1.2.1 -r1.1.2.2
--- src/engine/gnc-budget-p.h
+++ src/engine/gnc-budget-p.h
@@ -23,8 +23,10 @@
/** @addtogroup Engine
* @{ */
+/** @addtogroup Budget
+ * @{ */
/** @file gnc-budget-p.h
- * @breif Private structure definition for the budget object.
+ * @brief Private structure definition for the budget object.
* @author Created by Darin Willits 04 sep 2003
* @author Copyright (c) 04 Darin Willits <darin at willits.ca>
*
@@ -65,3 +67,6 @@
#endif // __GNC_BUDGET_P_H__
+
+/** @} */
+/** @} */
Index: gnc-budget-period.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/Attic/gnc-budget-period.h,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/engine/gnc-budget-period.h -Lsrc/engine/gnc-budget-period.h -u -r1.1.2.1 -r1.1.2.2
--- src/engine/gnc-budget-period.h
+++ src/engine/gnc-budget-period.h
@@ -22,10 +22,12 @@
* *
\********************************************************************/
-/** @addtogroup engine
+/** @addtogroup Engine
+ * @{ */
+/** @addtogroup Budget
* @{ */
/** @file gnc-budget-period.h
- * @breif Public interface for the budget period structure.
+ * @brief Public interface for the budget period structure.
* @author Created by Darin Willits 16 sep 2003
* @author Copyright (c) 16 sep 2003 Darin Willits <darin at willits.ca>
*
@@ -65,3 +67,6 @@
#endif // __BUDGET_PERIOD_H__
+
+/** @} */
+/** @} */
Index: cap-gains.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/cap-gains.c,v
retrieving revision 1.13.4.4
retrieving revision 1.13.4.5
diff -Lsrc/engine/cap-gains.c -Lsrc/engine/cap-gains.c -u -r1.13.4.4 -r1.13.4.5
--- src/engine/cap-gains.c
+++ src/engine/cap-gains.c
@@ -20,7 +20,7 @@
\********************************************************************/
/** @file cap-gains.c
- * @breif Utilities to Automatically Compute Capital Gains/Losses.
+ * @brief Utilities to Automatically Compute Capital Gains/Losses.
* @author Created by Linas Vepstas August 2003
* @author Copyright (c) 2003,2004 Linas Vepstas <linas at linas.org>
*
Index: gnc-budget-cat-p.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/Attic/gnc-budget-cat-p.h,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/engine/gnc-budget-cat-p.h -Lsrc/engine/gnc-budget-cat-p.h -u -r1.1.2.1 -r1.1.2.2
--- src/engine/gnc-budget-cat-p.h
+++ src/engine/gnc-budget-cat-p.h
@@ -23,8 +23,10 @@
/** @addtogroup Engine
* @{ */
+/** @addtogroup Budget
+ * @{ */
/** @file gnc-budget-cat-p.h
- * @breif Definition of the private budget category structure.
+ * @brief Definition of the private budget category structure.
* @author Created by Darin Willits 05 sep 2003
* @author Copyright (c) 05 sep 2003 Darin Willits <darin at willits.ca>
*
@@ -65,3 +67,6 @@
#endif // __BUDGET_CAT_P_H__
+
+/** @} */
+/** @} */
Index: gnc-filepath-utils.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/gnc-filepath-utils.c,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/engine/gnc-filepath-utils.c -Lsrc/engine/gnc-filepath-utils.c -u -r1.1.2.1 -r1.1.2.2
--- src/engine/gnc-filepath-utils.c
+++ src/engine/gnc-filepath-utils.c
@@ -21,7 +21,7 @@
/*
* @file gnc-filepath-utils.c
- * @breif file path resolutionutilities
+ * @brief file path resolution utilities
* @author Copyright (c) 1998-2004 Linas Vepstas <linas at linas.org>
* @author Copyright (c) 2000 Dave Peticolas
*
Index: policy.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/policy.c,v
retrieving revision 1.2.4.2
retrieving revision 1.2.4.3
diff -Lsrc/engine/policy.c -Lsrc/engine/policy.c -u -r1.2.4.2 -r1.2.4.3
--- src/engine/policy.c
+++ src/engine/policy.c
@@ -20,7 +20,7 @@
\********************************************************************/
/** @file policy.c
- * @breif Implement FIFO Accounting Policy.
+ * @brief Implement FIFO Accounting Policy.
* @author Created by Linas Vepstas August 2003
* @author Copyright (c) 2003,2004 Linas Vepstas <linas at linas.org>
*
Index: gnc-budget-book.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/Attic/gnc-budget-book.c,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/engine/gnc-budget-book.c -Lsrc/engine/gnc-budget-book.c -u -r1.1.2.1 -r1.1.2.2
--- src/engine/gnc-budget-book.c
+++ src/engine/gnc-budget-book.c
@@ -22,7 +22,7 @@
\********************************************************************/
/** @file gnc-budget-book.c
- * @breif Implementation of the book/budget linkage.
+ * @brief Implementation of the book/budget linkage.
* @author Created by Darin Willits 04 sep 2003
* @author Copyright (c) 2003 Darin Willits <darin at willits.ca>
*
Index: gnc-budget.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/Attic/gnc-budget.c,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/engine/gnc-budget.c -Lsrc/engine/gnc-budget.c -u -r1.1.2.1 -r1.1.2.2
--- src/engine/gnc-budget.c
+++ src/engine/gnc-budget.c
@@ -22,7 +22,7 @@
\********************************************************************/
/** @file gnc-budget.c
- * @breif Implementation of the top level budgeting API's.
+ * @brief Implementation of the top level budgeting API's.
* @author Created by Darin Willits 04 sep 2003
* @author Copyright (c) 2003 Darin Willits <darin at willits.ca>
*
@@ -510,4 +510,3 @@
col = qof_book_get_collection (book, GNC_ID_BUDGET);
return (GncBudget*)qof_collection_lookup_entity (col, guid);
}
-
Index: gnc-budget-period-value.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/Attic/gnc-budget-period-value.h,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/engine/gnc-budget-period-value.h -Lsrc/engine/gnc-budget-period-value.h -u -r1.1.2.1 -r1.1.2.2
--- src/engine/gnc-budget-period-value.h
+++ src/engine/gnc-budget-period-value.h
@@ -22,10 +22,12 @@
* *
\********************************************************************/
-/** @addtogroup engine
+/** @addtogroup Engine
+ * @{ */
+/** @addtogroup Budget
* @{ */
/** @file gnc-budget-period-value.h
- * @breif Public interface for the budget period value structure.
+ * @brief Public interface for the budget period value structure.
* @author Created by Darin Willits 16 sep 2003
* @author Copyright (c) 16 sep 2003 Darin Willits <darin at willits.ca>
*
@@ -61,5 +63,7 @@
*/
gnc_numeric gnc_budget_period_value_get_value(GncBudgetPeriodValue* periodValue);
-
#endif // __BUDGET_PERIOD_VALUE_H__
+
+/** @} */
+/** @} */
Index: gnc-filepath-utils.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/gnc-filepath-utils.h,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/engine/gnc-filepath-utils.h -Lsrc/engine/gnc-filepath-utils.h -u -r1.1.2.1 -r1.1.2.2
--- src/engine/gnc-filepath-utils.h
+++ src/engine/gnc-filepath-utils.h
@@ -21,7 +21,7 @@
/**
* @file gnc-filepath-utils.h
- * @breif file path resolutionutilities
+ * @brief file path resolutionutilities
* @author Copyright (c) 1998-2004 Linas Vepstas <linas at linas.org>
* @author Copyright (c) 2000 Dave Peticolas
*
Index: gnc-ui-util.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/app-utils/gnc-ui-util.h,v
retrieving revision 1.22.2.6
retrieving revision 1.22.2.7
diff -Lsrc/app-utils/gnc-ui-util.h -Lsrc/app-utils/gnc-ui-util.h -u -r1.22.2.6 -r1.22.2.7
--- src/app-utils/gnc-ui-util.h
+++ src/app-utils/gnc-ui-util.h
@@ -20,7 +20,7 @@
* Boston, MA 02111-1307, USA gnu at gnu.org *
\********************************************************************/
-/** @addtogroup UI
+/** @addtogroup GUI
@{ */
/** @file gnc-ui-util.h
@brief utility functions for the GnuCash UI
Index: gnc-plugin-page-report.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/report/report-gnome/Attic/gnc-plugin-page-report.h,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -Lsrc/report/report-gnome/gnc-plugin-page-report.h -Lsrc/report/report-gnome/gnc-plugin-page-report.h -u -r1.1.2.1 -r1.1.2.2
--- src/report/report-gnome/gnc-plugin-page-report.h
+++ src/report/report-gnome/gnc-plugin-page-report.h
@@ -22,7 +22,7 @@
* Boston, MA 02111-1307, USA gnu at gnu.org
**/
-/** @addtogroup UI
+/** @addtogroup GUI
@{ */
/** @file gnc-plugin-page-report.h
@brief Report page.
More information about the gnucash-changes
mailing list