浏览代码

dox: syntax errors

git-svn-id: https://svn.osgeo.org/grass/grass/trunk@55460 15284696-431f-4ddb-bdfa-cd5b030d7da7
Vaclav Petras 12 年之前
父节点
当前提交
c18eee3ba3

+ 1 - 1
grasslib.dox

@@ -89,7 +89,7 @@ href="http://grass.osgeo.org">http://grass.osgeo.org</a>
 \subsection vectoribs Vector Libraries
 
  - %vector: \ref vectorlib
-  - dglib: \ref dglib
+  - dglib (internal library)
   - vedit: \ref veditlib - %vector editing
   - neta: \ref netalib
  - sites:	Old Sites library, now interfaced to \ref vectorlib - \ref sites

+ 2 - 2
gui/wxpython/core/utils.py

@@ -848,8 +848,8 @@ def StoreEnvVariable(key, value = None, envFile = None):
 def SetAddOnPath(addonPath = None, key = 'PATH'):
     """!Set default AddOn path
 
-    @addonPath path to addons (None for default)
-    @key env key - 'PATH' or 'BASE'
+    @param addonPath path to addons (None for default)
+    @param key env key - 'PATH' or 'BASE'
     """
     gVersion = grass.version()['version'].split('.', 1)[0]
     # update env file

+ 1 - 1
gui/wxpython/dbmgr/sqlbuilder.py

@@ -20,7 +20,7 @@ This program is free software under the GNU General Public License
 
 @author Jachym Cepicky <jachym.cepicky gmail.com> (original author)
 @author Martin Landa <landa.martin gmail.com>
-@author Hamish Bowman <hamish_b yahoo com>
+@author Hamish Bowman <hamish_b yahoo.com>
 @author Refactoring, SQLBUilderUpdate by Stepan Turek <stepan.turek seznam.cz> (GSoC 2012, mentor: Martin Landa)
 """
 

+ 1 - 1
gui/wxpython/iclass/frame.py

@@ -1080,7 +1080,7 @@ class IClassMapFrame(DoubleMapFrame):
     def OnPointer(self, event):
         """!Set pointer mode.
 
-        @fixme: needs refactoring
+        @todo: pointers need refactoring
         """
         toolbar = self.GetMapToolbar()
 

+ 2 - 2
gui/wxpython/lmgr/giface.py

@@ -137,8 +137,8 @@ class LayerManagerGrassInterfaceForMapDisplay(object):
     """
     def __init__(self, giface, tree):
         """!
-        @giface original grass interface
-        @tree tree which will be used instead of the tree from giface
+        @param giface original grass interface
+        @param tree tree which will be used instead of the tree from giface
         """
         self._giface = giface
         self.tree = tree

+ 1 - 1
gui/wxpython/web_services/dialogs.py

@@ -644,7 +644,7 @@ class WSPropertiesDialog(WSDialogBase):
     def LoadCapFiles(self, ws_cap_files, cmd):
         """!Parse cap files and update dialog.
 
-        @params for description see constructor
+        For parameters description, see the constructor.
         """
         self.ch_ws_sizer.Clear(deleteWindows = True)
 

+ 4 - 1
lib/display/symbol.c

@@ -131,13 +131,16 @@ static void symbol(const SYMBOL *Symb, double x0, double y0,
  * The symbol must be pre-processed with S_stroke() before being sent
  * to this function.
  *
- * example:
+ * \par Example
+ * \code
  *   #include <grass/display.h>
  *   #include <grass/symbol.h>
+ *   ...
  *   SYMBOL *Symb;
  *   Symb = S_read( symbol_name );
  *   S_stroke( Symb, size, rotation, tolerance );
  *   D_symbol( Symb, x0, y0, line_color, fill_color );
+ * \endcode
  *
  *  \param Symb The symbol name (e.g. basic/circle)
  *  \param x0   The starting x display coordinate (pixel)

+ 2 - 2
lib/gis/gislib.dox

@@ -1058,13 +1058,13 @@ plotting vector areas with interior islands.
  - G_plot_where_en()
 
 The pixel coordinates <i>x,y</i> are converted to map coordinates
-east,north</i>. See G_setup_plot() for the required coordinate
+<i>east,north</i>. See G_setup_plot() for the required coordinate
 initialization procedure.
 
  - G_plot_where_xy()
 
 The map coordinates <i>east,north</i> are converted to pixel
-coordinates <i>x,y.</i>. See G_setup_plot() for the required
+coordinates <i>x,y</i>. See G_setup_plot() for the required
 coordinate initialization procedure.
 
  - G_plot_fx()

+ 1 - 1
lib/ogsf/gvl_file.c

@@ -412,7 +412,7 @@ int gvl_file_free_datah(int id)
    \param[out] min min value
    \param[out] max max value
 
-   \pointer to data
+   \returns pointer to data
  */
 void *open_g3d_file(const char *filename, IFLAG * type, double *min,
 		    double *max)