[Gnucash-changes] Doxygen tweaks

[Neil Williams]

Log Message:
-----------
Doxygen tweaks

Tags:
----
gnucash-gnome2-dev

Modified Files:
--------------
    gnucash/src/backend/file:
        gnc-backend-file.h
    gnucash/src/business/business-core:
        gncAddress.h
    gnucash/src/engine:
        Period.h
        qofbackend-p.h

Revision Data
-------------
Index: gnc-backend-file.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/backend/file/gnc-backend-file.h,v
retrieving revision 1.1.2.4
retrieving revision 1.1.2.5
diff -Lsrc/backend/file/gnc-backend-file.h -Lsrc/backend/file/gnc-backend-file.h -u -r1.1.2.4 -r1.1.2.5
--- src/backend/file/gnc-backend-file.h
+++ src/backend/file/gnc-backend-file.h
@@ -31,8 +31,7 @@
 #ifndef GNC_BACKEND_FILE_H_
 #define GNC_BACKEND_FILE_H_
 
-#include "qofbackend.h"
-#include "qofbackend-p.h"
+#include "qof.h"
 
 struct FileBackend_struct
 {
@@ -43,7 +42,8 @@
     char *lockfile;
     char *linkfile;
     int lockfd;
-   /** XXX price_lookup should be removed during the redesign
+   /** \deprecated 
+	XXX price_lookup should be removed during the redesign
    * of the SQL backend... prices can now be queried using
    * the generic query mechanism.
    *
Index: gncAddress.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/business/business-core/gncAddress.h,v
retrieving revision 1.4.4.6
retrieving revision 1.4.4.7
diff -Lsrc/business/business-core/gncAddress.h -Lsrc/business/business-core/gncAddress.h -u -r1.4.4.6 -r1.4.4.7
--- src/business/business-core/gncAddress.h
+++ src/business/business-core/gncAddress.h
@@ -54,27 +54,27 @@
 #ifndef GNC_ADDRESS_H_
 #define GNC_ADDRESS_H_
 
-#include "qofbook.h"
-#include "qofid.h"
-#include "qofobject.h"
-#include "qofinstance.h"
-#include "qofid-p.h"
+#include "qof.h"
+#ifdef GNUCASH_MAJOR_VERSION
+#include "gncBusiness.h"
+#endif
 
 #define GNC_ADDRESS_MODULE_NAME        "gncAddress"
 #define GNC_ID_ADDRESS GNC_ADDRESS_MODULE_NAME
 /** \struct GncAddress
 
- at param	QofBook *	book;
- at param	QofEntity * parent;
- at param	gboolean	dirty;
- at param	char *	name;
- at param	char *	addr1;
- at param	char *	addr2;
- at param	char *	addr3;
- at param	char *	addr4;
- at param	char *	phone;
- at param	char *	fax;
- at param	char *	email;
+ at param  QofInstance The address instance.
+ at param	QofBook*	  Copy of the book pointer.
+ at param	QofEntity* parent entity.
+ at param	gboolean	dirty flag
+ at param	char*	name of addressee
+ at param	char*	first line of address
+ at param	char*	second line of address
+ at param	char*	third line of address
+ at param	char*	fourth line of address
+ at param	char*	phone number
+ at param	char*	fax number
+ at param	char*	email address
 */
 typedef struct _gncAddress GncAddress;
 
Index: Period.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/Period.h,v
retrieving revision 1.9.4.4
retrieving revision 1.9.4.5
diff -Lsrc/engine/Period.h -Lsrc/engine/Period.h -u -r1.9.4.4 -r1.9.4.5
--- src/engine/Period.h
+++ src/engine/Period.h
@@ -22,7 +22,8 @@
     @{ */
 /** @addtogroup Period Accounting Periods
     The architecture of the Accounting Period design is discussed
-    in greater detail in the file "src/doc/books.txt"
+    in greater detail under \ref bookperiods and also in the 
+    file "src/doc/books.txt" in the source.
     @{ */
 /** @file Period.h
  *  @brief Implement accounting periods, as per design in src/doc/books.txt
Index: qofbackend-p.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/qofbackend-p.h,v
retrieving revision 1.2.4.7
retrieving revision 1.2.4.8
diff -Lsrc/engine/qofbackend-p.h -Lsrc/engine/qofbackend-p.h -u -r1.2.4.7 -r1.2.4.8
--- src/engine/qofbackend-p.h
+++ src/engine/qofbackend-p.h
@@ -264,21 +264,6 @@
   /** Return a new, initialized backend backend. */
   QofBackend * (*backend_new) (void);
 
-  /** \brief Name of the QofBackendProvider XML Configuration file
-	
-	This is to be generated from a Perl script to utilise gettext
-	translations and includes translated strings that describe
-	what each configuration option achieves. 
-	
-	The file itself can be located in the QSF_SCHEMA_DIR or
-	in any directory accessible to the frontend program.
-	
-	The filename should include the name of the backend as
-	specified in provider_name and the version of the backend 
-	that can use the file: myname-backend-v1.xml
-  */
-  const char* provider_config;
-  
 /** \brief Distinguish two providers with same access method.
   
   More than 1 backend can be registered under the same access_method,