dox: reducing doxygen warnings

git-svn-id: https://svn.osgeo.org/grass/grass/trunk@52600 15284696-431f-4ddb-bdfa-cd5b030d7da7

grasslib.dox

@@ -352,7 +352,7 @@ Each module which modifies and writes data must read from <b>input</b>
 and write to <b>output</b> so that data may not be lost. For example
 <tt>v.spag</tt> works on <b>map</b> at in GRASS GIS 5.0 but if program
 (system) crashes or threshold was specified incorrectly and vector was
-not backuped, data were lost. In this case </b>map</b> option should
+not backuped, data were lost. In this case <b>map</b> option should
 be replaced by <b>input</b> and <b>output</b>.
 
 Topology is always built by default if the coor file was modified.

lib/db/stubs/add_col.c

@@ -1,10 +1,7 @@
 #include <grass/dbmi.h>
 
 /*!
-   \fn int db__driver_add_column (dbString *tableName, dbColumn *column)
-   \brief 
-   \return 
-   \param 
+   This function calls db_procedure_not_implemented().
  */
 int db__driver_add_column(dbString * tableName, dbColumn * column)
 {

lib/db/stubs/close_cursor.c

@@ -1,10 +1,7 @@
 #include <grass/dbmi.h>
 
 /*!
-   \fn int db__driver_close_cursor (dbCursor *cursor)
-   \brief 
-   \return 
-   \param 
+   This function calls db_procedure_not_implemented().
  */
 
 int db__driver_close_cursor(dbCursor * cursor)

lib/gis/error.c

@@ -1,5 +1,5 @@
 /*!
- * \file error.c
+ * \file lib/gis/error.c
  * 
  * \brief GIS Library - Error messages functions
  *

lib/gis/gislib.dox

@@ -93,7 +93,7 @@ etc.) which are not tied directly to database processing.
 
 It is assumed that the reader has read \ref location for a general
 description of GRASS databases, \ref Raster_File_Processing for
-details about raster map layers in GRASS, and Region_and_Mask
+details about raster map layers in GRASS, and \ref Region_and_Mask
 (<b>???</b>) which discusses regions and masks. The routines in the
 <em>GIS Library</em> are presented in functional groupings, rather
 than in alphabetical order. The order of presentation will, it is
@@ -170,7 +170,7 @@ used to modify the error handling:
  - G_set_error_routine() change error handling
 
 This routine provides a different error handler for G_fatal_error()
-and G_warning(). The <m>handler</em> routine must be defined as
+and G_warning(). The <em>handler</em> routine must be defined as
 follows:
 
 \code
@@ -282,7 +282,7 @@ environment and return its value (which is a character string). If
 <em>name</em> is not set, G_getenv() issues an error message and calls
 exit(). G__setenv() just returns the NULL pointer.
 
- - G_setenv ()
+ - G_setenv()
 
  - G__setenv()
   
@@ -748,7 +748,7 @@ available to support latitude-longitude databases.
 
 Latitudes and longitudes are specified in degrees. Northern latitudes
 range from 0 to 90 degrees, and southern latitudes from 0 to
--90. Longitudes have no limits since longitudes ±360 degrees are
+-90. Longitudes have no limits since longitudes ±360 degrees are
 equivalent.
 
 Coordinates are represented in ASCII using the format
@@ -810,7 +810,7 @@ G_format_northing(north, buf, -1);             /* double to ASCII */
 
 
 These next routines provide a mechanism for determining the relative
-position of a pair of longitudes. Since longitudes of ±360 are
+position of a pair of longitudes. Since longitudes of ±360 are
 equivalent, but GRASS requires the east to be bigger than the west,
 some adjustment of coordinates is necessary.
 
@@ -1477,8 +1477,9 @@ int main(int argc, char *argv[])
 
 \subsection Complete_Structure_Members_Table Complete Structure Members Table
 
-<v>struct Flag</v>
-<table border=1>
+\subsubsection memtabFlag struct Flag
+
+<table>
 <tr>
  <td>structure member</td>
  <td>C type</td>
@@ -1509,8 +1510,9 @@ int main(int argc, char *argv[])
 </tr>
 </table>
 
-<b>struct Option</b>
-<table border=1>
+\subsubsection memtabOption struct Option
+
+<table>
 <tr>
  <td>structure member</td>
  <td>C type </td>
@@ -1531,7 +1533,7 @@ int main(int argc, char *argv[])
  <td>int </td>
  <td>YES </td>
  <td>none </td>
- <td>Option type: <br>
+ <td>%Option type: <br>
  TYPE_STRING <br>
  TYPE_INTEGER <br>
  TYPE_DOUBLE <br>

lib/manage/sighold.c

@@ -1,5 +1,5 @@
 /*!
-  \file lib/manage/sighol.c
+  \file lib/manage/sighold.c
   
   \brief Manage Library - Hold signals
   

lib/ogsf/gsget.c

@@ -1,5 +1,5 @@
 /*!
-   \file gsd_get.c
+   \file gsget.c
 
    \brief OGSF library - get map attribute (lower level functions)
 

lib/ogsf/mc33_table.h

@@ -1,5 +1,5 @@
 /*!
-   \file m33_table.h
+   \file mc33_table.h
 
    \brief OGSF library - 
 

lib/proj/datum.c

@@ -1,6 +1,6 @@
 
 /**
-   \file datum.c
+   \file lib/proj/datum.c
 
    \brief GProj library - Functions for reading datum parameters from the location database
 

lib/proj/local_proto.h

@@ -1,6 +1,6 @@
 
 /**
-   \file local_proto.h
+   \file lib/proj/local_proto.hlocal_proto.h
 
    \brief GProj library
 

lib/raster/align_window.c

@@ -1,5 +1,5 @@
 /*!
- * \file gis/align_window.c
+ * \file lib/raster/align_window.c
  *
  * \brief GIS Library - Window alignment functions.
  *

lib/raster/cell_stats.c

@@ -174,8 +174,8 @@ static void init_node(NODE * node, int idx, int offset)
  * \brief Random query of cell stats
  *
  * This routine allows a random query of the Cell_stats structure. The
- * <i>count</i> associated with the raster value <i>cat</i> is
- * set. The routine returns 1 if <i>cat<i> was found in the
+ * \p count associated with the raster value \p cat is
+ * set. The routine returns 1 if \p cat was found in the
  * structure, 0 otherwise.
  *
  * Allow finding the count for the NULL-value.

lib/raster/color_out.c

@@ -34,7 +34,7 @@ static void write_rule(DCELL *val, DCELL *min, DCELL *max, int r, int g, int b,
   \brief Print color table
 
   \param colors pointer to Colors structure
-  \param min,max minimum and maximum value for percentage output (used only when <em>perc<em> is non-zero)
+  \param min,max minimum and maximum value for percentage output (used only when \p perc is non-zero)
   \param fp file where to print color table rules
   \param perc TRUE for percentage output
 */

lib/raster/rasterlib.dox

@@ -6,6 +6,8 @@
 
 by GRASS Development Team (http://grass.osgeo.org)
 
+\tableofcontents
+
 <b>TODO: Needs to be cleaned up. The upper GRASS 4.x and the lower
 GRASS 5.x/6.x parts need to me merged and updated to GRASS 7</b>
 
@@ -779,8 +781,9 @@ while(Rast_next_cell_stat(&cat, &count, &s))
   fprintf(stdout, "%ld %ld\n", (long) cat, count);
 \endcode
 
-\section  GRASS_5_raster_API GRASS 5 raster API [needs to be merged
-      into above sections]
+\section  GRASS_5_raster_API GRASS 5 raster API
+
+<em>Needs to be merged into above sections.<em>
 
 \subsection The_CELL_Data_Type The CELL Data Type
 
@@ -824,7 +827,7 @@ CELL type, this problem does not arise. It is only when CELL data must
 be used in routines which do not know about the CELL type, that the
 values must be cast to or from long.
 
-\subsection 5.0 Changes to  <TT>"gis.h"</TT>
+\subsection GRASS_5_raster_API_gish Changes to gis.h
 
 The "gis.h" contains 5 new items:
 
@@ -1188,7 +1191,7 @@ didn't have a <tt>null</tt> file, but typically used zero to indicate
 a null value).
 
 For a floating-point map, any cells which were null will become zero
-(when writing FP data, a null has a zero written to the fcell/<map>
+(when writing FP data, a null has a zero written to the fcell/\<map\>
 file, and the corresponding bit is set in the <tt>null</tt> file).
 
 \section Color_Functions Color Functions (new and upgraded)
@@ -1201,7 +1204,7 @@ struct _Color_Rule_
 {
 struct
 {
-    int version;                                   /* set by read\_colors: -1=old,1=new */
+    int version;                                   /* set by read_colors: -1=old,1=new */
     DCELL shift;
     int invert;
     int is_float;                                  /* defined on floating point raster data? */
@@ -1318,7 +1321,7 @@ Modified to return a color for NULL-values.
 
 Modified to return a color for the NULL-value.
 
-\section Changes_to_the_Colors_structure Changes to the <TT>Colors</TT> structure
+\section Changes_to_the_Colors_structure Changes to the Colors structure
 
 
 Modifications to the Colors structure to support colors for
@@ -1341,7 +1344,7 @@ color rule for each inteval, and the binary search is then used when
 looking up colors instead of linearly searching through all color
 rules.
 
-\section Changes_to_the_colr_file Changes to the <TT>colr</TT> file
+\section Changes_to_the_colr_file Changes to the \c colr file
 
 
  - The rules are written out using floating-point format, removing trailing zeros (possibly producing integers) . For example, to ramp from red to green for the range [1.3,5.0]:
@@ -1640,7 +1643,7 @@ struct Categories
 } ;
 \endcode
 
-\section Changes_to_the_cats_file Changes to the <TT>cats</TT> file
+\section Changes_to_the_cats_file Changes to the \c cats file
 
 The format of explicit label entries is the same for integer maps.
 

lib/raster3d/raster3dlib.dox

@@ -106,7 +106,7 @@ variables or explicitly set at run-time.
 \verbatim 
         Precision
         RLE
-\endverbatim 
+\endverbatim
 
 <P>
 Precision indicates how many of the mantissa bits should be stored on
@@ -307,7 +307,7 @@ typedef struct{
     int proj;  /* Projection (see gis.h) */
     int zone;  /* Projection zone (see gis.h) */
 
-} RASTER3D\_Region;
+} RASTER3D_Region;
 \endverbatim
 
 <P>
@@ -608,18 +608,18 @@ The vertical units are defined in gis.h and can be spatial or temporal.
 No environment variable.
 
 <P>
+\verbatim
 void Rast3d_set_unit (map, unit)
         RASTER3d_Map; /* the map */
         char *unit; /* The data unit description */ 
-<P>
+
 void Rast3d_set_vertical_unit (map, unit)
         RASTER3d_Map; /* the map */
         char *unit;  /* Use the standard from units.c in lib/gis */
-<P>
 void Rast3d_set_vertical_unit2 (map, unit)
         RASTER3d_Map; /* the map */
         int unit; /* defined in gis.h */
-<P>
+\endverbatim
 
 \section Error_Handling Error Handling: Setting the error function
 
@@ -828,9 +828,14 @@ float Rast3d_getFloatRegion(void *map, int x, int y, int z)Is
   return value.
 
 <P>
-double Rast3d_getDoubleRegion(void *map, int x, int y, int z)Is
-  equivalent to <TT>Rast3d_getValueRegion (map, x, y, z, &amp;value,
-    DCELL_TYPE);</TT> return value.
+
+\code
+Rast3d_getDoubleRegion(map, x, y, z)
+\endcode
+is equivalent to
+\code
+Rast3d_getValueRegion(map, x, y, z, &amp;value, DCELL_TYPE)
+\endcode
 
 <P>
 int Rast3d_putValue(void *map, int x, int y, int z, char *value, int
@@ -1161,8 +1166,13 @@ Returns
         NULL ... otherwise.
 
 <P>
-char *Rast3d_allocTiles(void *map, int nofTiles)
-Is equivalent to Rast3d_allocTilesType (map, nofTiles, Rast3d_fileTypeMap (map)).
+\code
+Rast3d_allocTiles(map, nofTiles)
+\endcode
+is equivalent to
+\code
+Rast3d_allocTilesType(map, nofTiles, Rast3d_fileTypeMap(map)).
+\endcode
 
 <P>
 void Rast3d_freeTiles(char *tiles)
@@ -1563,9 +1573,11 @@ void Rast3d_customResampleFun(void *map, int row, int col, int depth,
   Rast3d_getValueRegion() (cf. Section 22.4.3).
 
 <P>
-void Rast3d_nearestNeighbor(void *map, int row, int col, int depth, char
-  *value, int type) The default resampling function which uses nearest
-  neighbor resampling.
+The default resampling function which uses nearest
+neighbor resampling.
+\code
+Rast3d_nearestNeighbor(map, row, col, depth, value, type)
+\endcode
 
 <P>
 void Rast3d_getResamplingFun(void *map, void  (**resampleFun)())

lib/temporal/lib/connect.c

@@ -1,5 +1,5 @@
 /*!
-  \file lib/temporal/src/connect.c
+  \file lib/temporal/lib/connect.c
   
   \brief Temporal GIS Library - connect to TGIS DB
   

lib/vector/Vlib/read_ogr.c

@@ -1,5 +1,5 @@
 /*!
-   \file lib/vector/Vlib/lib/vector/Vlib/read_ogr.c
+   \file lib/vector/Vlib/read_ogr.c
 
    \brief Vector library - reading data (OGR format)
 

lib/vector/diglib/update.c

@@ -1,6 +1,6 @@
 
 /**
- * \file update.c
+ * \file lib/vector/diglib/update.c
  *
  * \brief Vector library - update topology (lower level functions)
  *

lib/vector/neta/bridge.c

@@ -1,5 +1,5 @@
 /*!
-   \file vector/neta/bridges.c
+   \file lib/vector/neta/bridge.c
 
    \brief Network Analysis library - bridges
 

lib/vector/neta/centrality.c

@@ -1,5 +1,5 @@
 /*!
-   \file vector/neta/centality.c
+   \file lib/vector/neta/centrality.c
 
    \brief Network Analysis library - centrality
 

lib/vector/vectorlib.dox

@@ -71,7 +71,7 @@ The current implementation includes:
   OGR sources etc.)
 - <em>portability</em>: platform independent internal format, read- and
       writable on 32bit, 64bit etc. computer architectures
-- integrated \ref vlibDglib - support for vector network analysis
+- integrated \ref dglib - support for vector network analysis
 - <em>spatial index</em>: based on R-tree method for fast vector
   geometry access (see \ref vlibSpidx)
 - <em>multi-attribute</em>: attributes saved in external Relational

rfc/RFC1_PSC.dox

@@ -26,8 +26,8 @@ at OSGeo.
 The two primary functions of the PSC are:
 
 -# To enforce control over the GRASS codebase. This can be summarised as:
- - Enforce mechanisms to ensure quality control.</li>
- - Ensure compliance with all required legal measures.</li>
+ - Enforce mechanisms to ensure quality control.
+ - Ensure compliance with all required legal measures.
 -# Project Management and responsibility for the "public face" of
 GRASS.
     

rfc/rfc_list.dox

@@ -1,13 +1,13 @@
 /*!
-\mainpage RFC List of the GRASS Project Steering Committee
+\page RFC List of the GRASS Project Steering Committee
 
 List of \link psc_motions Motions of the GRASS Project Steering Committee\endlink
 
 A list of all GRASS RFC documents, with status. 
 
-- \link rfc1_psc RFC 1: Project Steering Committee Guidelines\endlink (Adopted)
-- \link rfc2_psc RFC 2: Legal aspects of code contributions\endlink (Adopted)
-- \link rfc3_psc RFC 3: PSC Voting Procedures\endlink (Proposed)
+- \subpage rfc1_psc (Adopted)
+- \subpage rfc2_psc (Adopted)
+- \subpage rfc3_psc (Proposed)
 
 <a href="http://grass.osgeo.org/">GRASS GIS</a>
 */