[GRASS-SVN] r52613 - in grass/trunk: include/Make lib/python

[svn_grass at osgeo.org]

Author: wenzeslaus
Date: 2012-08-09 07:41:59 -0700 (Thu, 09 Aug 2012)
New Revision: 52613

Modified:
   grass/trunk/include/Make/Doxyfile_arch_html.in
   grass/trunk/include/Make/Doxyfile_arch_latex.in
   grass/trunk/lib/python/db.py
   grass/trunk/lib/python/pythonlib.dox
Log:
dox: doxygen alias (newcommand) gmod for grass modules (when their params are referenced)

Modified: grass/trunk/include/Make/Doxyfile_arch_html.in
===================================================================
--- grass/trunk/include/Make/Doxyfile_arch_html.in	2012-08-09 13:26:08 UTC (rev 52612)
+++ grass/trunk/include/Make/Doxyfile_arch_html.in	2012-08-09 14:41:59 UTC (rev 52613)
@@ -193,7 +193,7 @@
 # will result in a user-defined paragraph with heading "Side Effects:".
 # You can put \n's in the value part of an alias to insert newlines.
 
-ALIASES                =
+ALIASES += gmod{1}="<a href='http://grass.osgeo.org/grass@GRASS_VERSION_MAJOR@@GRASS_VERSION_MINOR@/manuals/html@GRASS_VERSION_MAJOR@@GRASS_VERSION_MINOR@_user/\1.html'><tt>\1</tt></a>"
 
 # This tag can be used to specify a number of word-keyword mappings (TCL only).
 # A mapping has the form "name=value". For example adding

Modified: grass/trunk/include/Make/Doxyfile_arch_latex.in
===================================================================
--- grass/trunk/include/Make/Doxyfile_arch_latex.in	2012-08-09 13:26:08 UTC (rev 52612)
+++ grass/trunk/include/Make/Doxyfile_arch_latex.in	2012-08-09 14:41:59 UTC (rev 52613)
@@ -193,7 +193,7 @@
 # will result in a user-defined paragraph with heading "Side Effects:".
 # You can put \n's in the value part of an alias to insert newlines.
 
-ALIASES                =
+ALIASES += gmod{1}="<a href='http://grass.osgeo.org/grass@GRASS_VERSION_MAJOR@@GRASS_VERSION_MINOR@/manuals/html@GRASS_VERSION_MAJOR@@GRASS_VERSION_MINOR@_user/\1.html'><tt>\1</tt></a>"
 
 # This tag can be used to specify a number of word-keyword mappings (TCL only).
 # A mapping has the form "name=value". For example adding

Modified: grass/trunk/lib/python/db.py
===================================================================
--- grass/trunk/lib/python/db.py	2012-08-09 13:26:08 UTC (rev 52612)
+++ grass/trunk/lib/python/db.py	2012-08-09 14:41:59 UTC (rev 52613)
@@ -122,7 +122,7 @@
     @param sql SQL statement to perform (or None)
     @param filename name of file with SQL statements (or None)
     @param table name of table to query (or None)
-    @param args  see db.select arguments
+    @param args  see \gmod{db.select} arguments
     """
     fname = tempfile(create = False)
     if sql:

Modified: grass/trunk/lib/python/pythonlib.dox
===================================================================
--- grass/trunk/lib/python/pythonlib.dox	2012-08-09 13:26:08 UTC (rev 52612)
+++ grass/trunk/lib/python/pythonlib.dox	2012-08-09 14:41:59 UTC (rev 52613)
@@ -108,9 +108,9 @@
 
  - python::core::write_command()
 
-<b>Interface to g.message</b>
+<b>Interface to \gmod{g.message}</b>
 
-These all run g.message, differing only in which flag (if any) is
+These all run \gmod{g.message}, differing only in which flag (if any) is
 used. fatal() is error(), but also calls sys.exit(1).
 
  - python::core::debug()
@@ -127,9 +127,9 @@
 
  - python::core::warning()
 
-<b>Interface to g.parser</b>
+<b>Interface to \gmod{g.parser}</b>
 
-Interface to g.parser, intended to be run from the top-level, e.g.
+Interface to \gmod{g.parser}, intended to be run from the top-level, e.g.
 
 \code
 	if __name__ == "__main__":
@@ -139,9 +139,9 @@
 
  - python::core::parser()
 
-<b>Interface to g.tempfile</b>
+<b>Interface to \gmod{g.tempfile}</b>
 
-Returns the name of a temporary file, created with g.tempfile.
+Returns the name of a temporary file, created with \gmod{g.tempfile}.
 
  - python::core::tempfile()
 
@@ -149,11 +149,11 @@
 
  - python::core::parse_key_val()
 
-<b>Interface to g.gisenv</b>
+<b>Interface to \gmod{g.gisenv}</b>
 
  - python::core::gisenv()
 
-<b>Interface to g.region</b>
+<b>Interface to \gmod{g.region}</b>
 
  - python::core::del_temp_region()
 
@@ -163,11 +163,11 @@
 
  - python::core::use_temp_region()
 
-<b>Interface to g.findfile</b>
+<b>Interface to \gmod{g.findfile}</b>
 
  - python::core::find_file()
 
-<b>Interface to g.list</b>
+<b>Interface to \gmod{g.list}</b>
 
  - python::core::list_grouped()
 
@@ -177,11 +177,11 @@
 
  - python::core::mlist_grouped()
 
-<b>Interface to g.mapsets</b>
+<b>Interface to \gmod{g.mapsets}</b>
 
  - python::core::mapsets()
 
-<b>Interface to g.version</b>
+<b>Interface to \gmod{g.version}</b>
 
  - python::core::version()