dox: fixing several doxygen warnings (wrong file names, typos, lt gt chars)

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

gui/wxpython/core/gcmd.py

@@ -103,7 +103,7 @@ class GError:
         @param message error message
         @param parent centre window on parent if given
         @param caption window caption (if not given "Error")
-        @showTraceback True to show also Python traceback
+        @param showTraceback True to show also Python traceback
         """
         if not caption:
             caption = _('Error')

gui/wxpython/core/render.py

@@ -1191,7 +1191,7 @@ class Map(object):
         @param l_render render an image (if True)
         
         @return new layer on success
-        @retutn None on failure
+        @return None on failure
         """
         Debug.msg (2, "Map.AddOverlay(): cmd=%s, render=%d" % (command, l_render))
         overlay = Overlay(id = id, type = type, cmd = command,
@@ -1254,7 +1254,7 @@ class Map(object):
         
         @return list of overlays (list=True)
         @return overlay (list=False)
-        @retur None (list=False) if no overlay or more overlays found
+        @return None (list=False) if no overlay or more overlays found
         """
         ovl = []
         for overlay in self.overlays:

gui/wxpython/core/settings.py

@@ -1118,7 +1118,7 @@ class Settings:
     def Reset(self, key = None):
         """!Reset to default settings
 
-        @key key in settings dict (None for all keys)
+        @param key key in settings dict (None for all keys)
         """
         if not key:
             self.userSettings = copy.deepcopy(self.defaultSettings)

gui/wxpython/dbmgr/manager.py

@@ -532,7 +532,7 @@ class AttributeManager(wx.Frame):
         """!GRASS Attribute Table Manager window
 
         @param parent parent window
-        @parem id window id
+        @param id window id
         @param title window title or None for default title
         @param vetorName name of vector map
         @param item item from Layer Tree

gui/wxpython/gui_core/gselect.py

@@ -126,7 +126,7 @@ class VectorSelect(Select):
         select vector maps. Control allows to filter vector maps. If you
         don't need this feature use Select class instead
         
-        @ftype filter vector maps based on feature type
+        @param ftype filter vector maps based on feature type
         """
         Select.__init__(self, parent = parent, id = wx.ID_ANY,
                         type = 'vector', **kwargs)

gui/wxpython/mapdisp/mapwindow.py

@@ -918,7 +918,7 @@ class BufferedWindow(MapWindow, wx.Window):
         @param rotation rotate symbol
         @param text draw also text (text, font, color, rotation)
         @param textAlign alignment (default 'lower-right')
-        @textOffset offset for text (from center point)
+        @param textOffset offset for text (from center point)
         """
         Debug.msg(4, "BufferedWindow.DrawCross(): pdc=%s, coords=%s, size=%d" % \
                   (pdc, coords, size))

gui/wxpython/nviz/mapwindow.py

@@ -253,7 +253,7 @@ class GLWindow(MapWindow, glcanvas.GLCanvas):
     def ComputeFlyValues(self, mx, my):
         """!Compute parameters for fly-through navigation
         
-        @params mx,my results from ComputeMxMy method
+        @param mx,my results from ComputeMxMy method
         """
         self.fly['value'] = [0, 0, 0]
         

gui/wxpython/psmap/menudata.py

@@ -23,7 +23,7 @@ class PsMapData(MenuData):
     def __init__(self, path = None):
         """!Menu for Cartographic Composer (psmap.py)
         
-        @path path to XML to be read (None for menudata_psmap.xml)
+        @param path path to XML to be read (None for menudata_psmap.xml)
         """
         if not path:
             path = os.path.join(globalvar.ETCWXDIR, 'xml', 'menudata_psmap.xml')

gui/wxpython/vdigit/wxdigit.py

@@ -128,7 +128,7 @@ class IVDigit:
     def __init__(self, mapwindow):
         """!Base class for vector digitizer (ctypes interface)
         
-        @parem mapwindow reference for map window (BufferedWindow)
+        @param mapwindow reference for map window (BufferedWindow)
         """
         self.poMapInfo   = None      # pointer to Map_info
         self.mapWindow = mapwindow

gui/wxpython/vdigit/wxdisplay.py

@@ -918,7 +918,7 @@ class DisplayDriver:
 
         @todo map units
         
-        @alpha color value for aplha channel
+        @param alpha color value for aplha channel
         """
         color = dict()
         for key in self.settings.keys():

include/ogsf.h

@@ -1,5 +1,5 @@
 /*!
-  \file include/ogsf.c
+  \file include/ogsf.h
 
   \brief OGSF header file (structures)
 

lib/db/dbmi_base/xdrprocedure.c

@@ -47,7 +47,7 @@ int db__start_procedure_call(int procnum)
   \param n
 
   \return DB_OK  ok
-  \returnDB_EOF eof from client
+  \return DB_EOF eof from client
 */
 int db__recv_procnum(int *n)
 {

lib/display/r_raster.c

@@ -176,7 +176,7 @@ void D_close_driver(void)
   \brief Append command to the cmd file
 
   Cmd file is created by d.mon by defining GRASS variable
-  MONITOR_<name>_CMDFILE, where <name> is name of the monitor.
+  \c MONITOR_<name>_CMDFILE, where \c \<name\> is name of the monitor.
 
   Command string is usually generated by G_recreate_command(), NULL is
   used to clean up list of commands (see d.erase command).

lib/display/raster.c

@@ -1,5 +1,5 @@
 /*!
-  \file lib/driver/raster.c
+  \file lib/display/raster.c
 
   \brief Display Driver - draw raster data
 

lib/display/setup.c

@@ -1,5 +1,5 @@
 /*!
-  \file lib/driver/setup.c
+  \file lib/display/setup.c
 
   \brief Display Driver - setup
 

lib/gis/alloc.c

@@ -1,5 +1,5 @@
 /*!
- * \file fis/alloc.c
+ * \file lib/gis/alloc.c
  *
  * \brief GIS Library - Memory allocation routines.
  *

lib/gis/color_rules.c

@@ -1,5 +1,5 @@
 /*!
- \file lib/gis/color_tables.c
+ \file lib/gis/color_rules.c
  
  \brief GIS Library - Color tables management subroutines
 

lib/gis/list.c

@@ -36,7 +36,7 @@ static int list_element(FILE *, const char *, const char *, const char *,
   lister (char *name char *mapset, char* buf)
   \endcode
   
-  Given file <em>name</em>, and </em>mapset</em>, lister() should
+  Given file <em>name</em>, and <em>mapset</em>, lister() should
   copy a string into 'buf' when called with name == "", should set
   buf to general title for mapset list.
   

lib/gis/location.c

@@ -28,7 +28,6 @@
  * should be used by modules that need to display the current location
  * to the user. See Locations for an explanation of locations.
  *
- *  \param
  *  \return char* tolocation name
  */
 
@@ -46,7 +45,6 @@ const char *G_location(void)
  * directory, this routine will return a string which looks like
  * <i>/home/user/grassdata/spearfish</i>.
  *
- *  \param
  *  \return char * 
  */
 
@@ -67,7 +65,6 @@ char *G_location_path(void)
 /*!
  * \brief Get current location path
  *
- *  \param
  *  \return char* to location path
  */
 char *G__location_path(void)

lib/gis/make_loc.c

@@ -86,26 +86,26 @@ int G__make_location(const char *location_name,
  * This function creates a new location in the current database,
  * initializes the projection, default window and current window.  
  *
- * \param char * location_name
+ * \param location_name
  *                      The name of the new location.  Should not include
  *                      the full path, the location will be created within
  *                      the current database.
- * \param struct Cell_head *wind
+ * \param wind
  *                      Contains the default window setting for the
  *                      new location.  All fields should be set in this
  *                      structure, and care should be taken to ensure that
  *                      the proj/zone fields match the definition in the
  *                      proj_info parameter (see G_set_cellhd_from_projinfo()).
  *
- * \param struct Key_Value *proj_info
+ * \param proj_info
  *                      Projection definition suitable to write to the
  *                      PROJ_INFO file, or NULL for PROJECTION_XY.
  *
- * \param struct Key_Value *proj_units
+ * \param proj_units
  *                      Projection units suitable to write to the PROJ_UNITS
  *                      file, or NULL.
  *
- * \param FILE *report_file 
+ * \param report_file 
  *                      File to which creation information should be written
  *                      (can be stdout).  Currently not used.
  *

lib/gis/make_mapset.c

@@ -86,13 +86,13 @@ int G__make_mapset(const char *gisdbase_name, const char *location_name,
  * This function creates a new mapset in the current location,
  * initializes default window and current window.
  *
- * \param char * gisdbase_name
+ * \param gisdbase_name
  *                      The full path of GISDBASE to create mapset in.
  *                      If NULL then current GISDBASE is used.
- * \param char * location_name
+ * \param location_name
  *                      The name location to create mapset in.
  *                      If NULL then current location is used.
- * \param char * mapset_name
+ * \param mapset_name
  *                      The name of the new mapset.  Should not include
  *                      the full path, the mapset will be created within
  *                      the current database and location.

lib/gis/parser.c

@@ -761,7 +761,7 @@ void G__print_keywords(FILE *fd, void (*format)(FILE *, const char *))
 }
 
 /*!
-  \Get overwrite value
+  \brief Get overwrite value
 
   \return 1 overwrite enabled
   \return 0 overwrite disabled

lib/gis/rd_cellhd.c

@@ -46,7 +46,7 @@ static double scan_double(const char *, double *);
 #define TEST(x) (flags&(1<<x))
 
 /*!
-  \bried Read cell header (for internal use only)
+  \brief Read cell header (for internal use only)
   
   \param fp file descriptor
   \param[out] cellhd pointer to Cell_head structure

lib/imagery/iclass.c

@@ -39,7 +39,7 @@
 
    \param statistics pointer to bands statistics
    \param refer pointer to band files structure
-   \param vector_map name of vector map with training areas
+   \param map_info vector map with training areas
    \param layer_name vector layer
    \param group name of imagery group
    \param raster_name name of temporary raster map (to be created)

lib/imagery/iclass_perimeter.c

@@ -40,7 +40,7 @@
 /*!
    \brief Creates perimeters from vector areas of given category.
 
-   \param vector_map name of vector map
+   \param Map vector map
    \param layer_name layer name (within vector map)
    \param category vector category (cat column value)
    \param[out] perimeters list of perimeters

lib/imagery/iclass_statistics.c

@@ -104,7 +104,6 @@ void alloc_statistics(IClass_statistics * statistics, int nbands)
    Frees all allocated arrays in statistics structure.
 
    \param statistics pointer to statistics structure
-   \param nbands number of band files
  */
 void I_iclass_free_statistics(IClass_statistics * statistics)
 {
@@ -185,7 +184,7 @@ int make_all_statistics(IClass_statistics * statistics,
 /*!
    \brief Calculate statistics for one training area.
 
-   \param statistics[out] pointer to statistics structure
+   \param[out] statistics pointer to statistics structure
    \param perimeter area perimeter
    \param band_buffer buffer to read band rows into
    \param band_fd band files descriptors

lib/ogsf/GS2.c

@@ -713,8 +713,7 @@ void GS_draw_line_onsurf(int id, float x1, float y1, float x2, float y2)
 
    \param id surface id
    \param x1,y1,x2,y2 line nodes
-   \param lasp ?
-   \paran n ?
+
    \return number of points used
  */
 int GS_draw_nline_onsurf(int id, float x1, float y1, float x2, float y2,
@@ -2876,7 +2875,7 @@ int GS_get_twist(void)
 
    10ths of degrees off twelve o'clock
 
-   \params t tenths of degrees clockwise from 12:00.
+   \param t tenths of degrees clockwise from 12:00.
  */
 void GS_set_twist(int t)
 {

lib/ogsf/gs_query.c

@@ -37,7 +37,7 @@
 
 
 /*!
-   \biref Crude method of intersecting line of sight with closest part of surface. 
+   \brief Crude method of intersecting line of sight with closest part of surface. 
 
    Uses los vector to determine the point of first intersection
    which is returned in point. Returns 0 if los doesn't intersect. 
@@ -175,7 +175,7 @@ int gs_los_intersect1(int surfid, float (*los)[3], float *point)
 }
 
 /*!
-   \biref Crude method of intersecting line of sight with closest part of surface. 
+   \brief Crude method of intersecting line of sight with closest part of surface. 
 
    This version uses the shadow of the los projected down to
    the surface to generate a line_on_surf, then follows each

lib/ogsf/gvl_file.c

@@ -131,7 +131,7 @@ geovol_file *gvl_file_get_volfile(int id)
    \brief Find file with name and type in geovol_file array an return handle
 
    \param name file name
-   \para begin
+   \param begin
 
    \param data id
    \param -1 not found
@@ -680,7 +680,7 @@ int get_buff_value(IFLAG type, void *data, int offset, void *value)
 
    \param vf pointer to geovol_file struct
    \param x,y,z real point
-   \oaram[out] value data value
+   \param[out] value data value
 
    \return -1 on failure
    \return 1 on success

lib/proj/local_proto.h

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

lib/python/task.py

@@ -198,7 +198,7 @@ class grassTask:
         @param ignoreErrors True to return whatever has been built so
         far, even though it would not be a correct command for GRASS
         @param ignoreRequired True to ignore required flags, otherwise
-        '<required>' is shown
+        '@<required@>' is shown
         @param ignoreDefault True to ignore parameters with default values
         """
         cmd = [self.name]

lib/python/temporal/base.py

@@ -37,9 +37,9 @@ class dict_sql_serializer(object):
 	"""!Convert the internal dictionary into a string of semicolon separated SQL statements
 	   The keys are the column names and the values are the row entries
 
-	   @type must be SELECT. INSERT, UPDATE
-	   @table The name of the table to select, insert or update
-	   @where The optional where statement
+	   @param type must be SELECT. INSERT, UPDATE
+	   @param table The name of the table to select, insert or update
+	   @param where The optional where statement
 	   @return the sql string
 	"""
 

lib/raster/color_look.c

@@ -1,5 +1,5 @@
 /*!
- * \file raster/color_lookup.c
+ * \file lib/raster/color_look.c
  * 
  * \brief Raster Library - Lookup array of colors 
  *

lib/raster/init.c

@@ -1,6 +1,6 @@
 
 /**
- * \file rasterinit.c
+ * \file lib/raster/init.c
  * 
  * \brief Raster Library - Handles program initialization.
  *

lib/raster/null_val.c

@@ -1,5 +1,5 @@
 /*!
- * \file raster/null_value.c
+ * \file lib/raster/null_val.c
  *
  * \brief Raster Library - NULL value management
  *

lib/raster/quant_rw.c

@@ -66,7 +66,7 @@ void Rast_round_fp_map(const char *name, const char *mapset)
  * in <tt>f_range</tt> producing the integer range
  * [<em>cmin,cmax</em>].
  *
- * Make a rule for map <name> that maps floating range (d_min, d_max)
+ * Make a rule for map \<name\> that maps floating range (d_min, d_max)
  * into integer range (min, max)
  * This function is useful when the quant rule doesn't depend of the
  * range of produced float data, for example the slope map whould
@@ -107,7 +107,7 @@ void Rast_quantize_fp_map(const char *name, const char *mapset,
  * 90] even if the range of slopes is not 0-90. The aspect map would be
  * quantized from [0.0, 360.0] to [0, 360].
  *
- * Make a rule for map <name> that maps floating range (d_min, d_max)
+ * Make a rule for map \<name\> that maps floating range (d_min, d_max)
  * into integer range (min, max)
  * This function is useful when the quant rule doesn't depend of the
  * range of produced float data, for example the slope map whould

lib/raster/window_map.c

@@ -1,5 +1,5 @@
 /*!
- * \file window_map.c
+ * \file lib/raster/window_map.c
  *
  * \brief Raster Library - Window mapping functions.
  *

lib/segment/close.c

@@ -1,5 +1,5 @@
 /**
- * \file close.c
+ * \file lib/segment/close.c
  *
  * \brief Segment closing routine.
  *

lib/segment/format.c

@@ -1,6 +1,6 @@
 
 /**
- * \file format.c
+ * \file lib/segment/format.c
  *
  * \brief Segment formatting routines.
  *

lib/segment/get.c

@@ -1,6 +1,6 @@
 
 /**
- * \file get.c
+ * \file lib/segment/get.c
  *
  * \brief Get segment routines.
  *

lib/segment/get_row.c

@@ -1,6 +1,6 @@
 
 /**
- * \file get_row.c
+ * \file lib/segment/get_row.c
  *
  * \brief Segment row retrieval routines.
  *

lib/segment/open.c

@@ -1,6 +1,6 @@
 
 /**
- * \file open.c
+ * \file lib/segment/open.c
  *
  * \brief Segment creation routine.
  *

lib/segment/put.c

@@ -1,6 +1,6 @@
 
 /**
- * \file put.c
+ * \file lib/segment/put.c
  *
  * \brief Segment write routines.
  *

lib/segment/put_row.c

@@ -1,6 +1,6 @@
 
 /**
- * \file put_row.c
+ * \file lib/segment/put_row.c
  *
  * \brief Write segment row routines.
  *

lib/segment/release.c

@@ -1,6 +1,6 @@
 
 /**
- * \file release.c
+ * \file lib/segment/release.c
  *
  * \brief Segment release routines.
  *

lib/segment/seek.c

@@ -1,6 +1,6 @@
 
 /**
- * \file seek.c
+ * \file lib/segment/seek.c
  *
  * \brief Segment seek routines.
  *

lib/segment/setup.c

@@ -1,6 +1,6 @@
 
 /**
- * \file setup.c
+ * \file lib/segment/setup.c
  *
  * \brief Segment setup routines.
  *

lib/sites/sites.c

@@ -4,9 +4,9 @@
   These functions and definitions support the site format for 5.0
   (format proposed by Dave Gerdes):
   
-  <pre>
+  \verbatim
   easting|northing|[z|[d4|]...][#category_int] [ [@attr_text OR %flt] ... ]
-  </pre>
+  \endverbatim
  
   to allow multidimensions (everything preceding the last '|') and any
   number of text or numeric attribute fields.

lib/vector/Vlib/dbcolumns.c

@@ -151,7 +151,7 @@ const char *Vect_get_column_types(const struct Map_info *Map, int field)
    \param field layer number
 
    \return list of column(s) types on success
-   \retutn NULL on error 
+   \return NULL on error 
  */
 const char *Vect_get_column_names_types(const struct Map_info *Map, int field)
 {

lib/vector/Vlib/header_finfo.c

@@ -58,7 +58,7 @@ const char *Vect_get_finfo_dsn_name(const struct Map_info *Map)
 
    Returns:
     - layer name for OGR format (GV_FORMAT_OGR and GV_FORMAT_OGR_DIRECT)
-    - table name for PostGIS format (GV_FORMAT_POSTGIS) including schema (<schema>.<table>)
+    - table name for PostGIS format (GV_FORMAT_POSTGIS) including schema (\<schema\>.\<table\>)
 
    Note: allocated string should be freed by G_free()
 

lib/vector/Vlib/level_two.c

@@ -40,7 +40,7 @@ plus_t Vect_get_num_nodes(const struct Map_info *Map)
    \brief Get number of primitives in vector map
 
    \param map pointer to Map_info struct
-   \patam type feature type
+   \param type feature type
 
    \return number of primitives
  */