Browse Source

cosmetics in doxygen documentation

git-svn-id: https://svn.osgeo.org/grass/grass/trunk@45854 15284696-431f-4ddb-bdfa-cd5b030d7da7
Martin Landa 14 years ago
parent
commit
08303ff374
3 changed files with 23 additions and 13 deletions
  1. 1 1
      include/Make/Doxyfile_arch_html.in
  2. 11 0
      include/dbmi.h
  3. 11 12
      lib/db/dbmilib.dox

+ 1 - 1
include/Make/Doxyfile_arch_html.in

@@ -23,7 +23,7 @@ PROJECT_NAME           = "GRASS Programmer's Manual"
 # This could be handy for archiving the generated documentation or 
 # This could be handy for archiving the generated documentation or 
 # if some version control system is used.
 # if some version control system is used.
 
 
-PROJECT_NUMBER         = @GRASS_VERSION_MAJOR@.@GRASS_VERSION_MINOR@.@GRASS_VERSION_RELEASE@ (@GRASS_VERSION_DATE@)
+PROJECT_NUMBER         = @GRASS_VERSION_MAJOR@.@GRASS_VERSION_MINOR@.@GRASS_VERSION_RELEASE@ (@GRASS_VERSION_DATE@) - r@GRASS_VERSION_SVN@
 
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
 # base path where the generated documentation will be put. 
 # base path where the generated documentation will be put. 

+ 11 - 0
include/dbmi.h

@@ -1,3 +1,14 @@
+/*!
+  \file include/dbmi.h
+
+  \brief Main header of \ref dbmilib
+
+  (C) 1999-2009, 2011 by the GRASS Development Team
+  
+  This program is free software under the GNU General Public License
+  (>=v2). Read the file COPYING that comes with GRASS for details.
+*/
+
 #ifndef GRASS_DBMI_H
 #ifndef GRASS_DBMI_H
 #define GRASS_DBMI_H
 #define GRASS_DBMI_H
 
 

+ 11 - 12
lib/db/dbmilib.dox

@@ -1,4 +1,4 @@
-/*! \page dbmilib GRASS DBMI DataBase Management Interface
+/*! \page dbmilib GRASS DataBase Management Interface
 
 
 by GRASS Development Team
 by GRASS Development Team
 
 
@@ -22,7 +22,7 @@ following DBMI drivers for attribute storage are available:
 
 
 These drivers are compiled depending on present DB related libraries
 These drivers are compiled depending on present DB related libraries
 and 'configure' settings. Only the DBF driver is always compiled. The
 and 'configure' settings. Only the DBF driver is always compiled. The
-default DBMI driver is defined in include/dbmi.h
+default DBMI driver is defined in dbmi.h
 
 
 \code
 \code
 #define DB_DEFAULT_DRIVER "sqlite"
 #define DB_DEFAULT_DRIVER "sqlite"
@@ -50,12 +50,12 @@ For DBMI architecture details please read Blazek et al. 2002 (see below).
 
 
 \section dbmiFunc DBMI library functions
 \section dbmiFunc DBMI library functions
 
 
-The db_*() functions are the programmer's API for GRASS DBMI
+The <tt>db_*()</tt> functions are the programmer's API for GRASS DBMI
 programming. There are three groups:
 programming. There are three groups:
 
 
- - dbmi_base:   contains functions for modules, drivers (../../db/drivers/)
- - dbmi_client: contains functions for modules
- - dbmi_driver: contains functions for drivers (../../db/drivers/)
+ - <b>dbmi_base</b>:   contains functions for modules, drivers (<tt>../../db/drivers/</tt>)
+ - <b>dbmi_client</b>: contains functions for modules
+ - <b>dbmi_driver</b>: contains functions for drivers (<tt>../../db/drivers/</tt>)
 
 
 \section dbmiBase DBMI BASE functions
 \section dbmiBase DBMI BASE functions
 
 
@@ -545,7 +545,7 @@ Value management:
 
 
  - db_convert_value_to_string()
  - db_convert_value_to_string()
 
 
-Misc:?
+Misc:
 
 
  - db_isdir()
  - db_isdir()
 
 
@@ -729,15 +729,10 @@ Misc:?
  - db_d_open_select_cursor()
  - db_d_open_select_cursor()
 
 
  - db_d_open_update_cursor()
  - db_d_open_update_cursor()
-
  - db_d_update()
  - db_d_update()
 
 
  - db_d_update()
  - db_d_update()
  
  
-\section dbmiContacts Contacts
-
- GRASS Development Team: http://grass.osgeo.org (preferably developers mailing list)
-
 \section dbmiReferences References
 \section dbmiReferences References
 
 
 Text based on: R. Blazek, M. Neteler, and R. Micarelli. The new GRASS 5.1
 Text based on: R. Blazek, M. Neteler, and R. Micarelli. The new GRASS 5.1
@@ -749,4 +744,8 @@ Text based on: R. Blazek, M. Neteler, and R. Micarelli. The new GRASS 5.1
  
  
 GRASS Vector Architecture: \ref vectorlib
 GRASS Vector Architecture: \ref vectorlib
 
 
+\section dbmiAuthors Authors
+
+ - Joel Jones (CERL/UIUC)
+ - Radim Blazek
 */
 */