[GRASS-SVN] r37533 - in grass/branches/develbranch_6/swig: . python
svn_grass at osgeo.org
svn_grass at osgeo.org
Wed May 27 05:53:44 EDT 2009
Author: martinl
Date: 2009-05-27 05:53:44 -0400 (Wed, 27 May 2009)
New Revision: 37533
Modified:
grass/branches/develbranch_6/swig/python/grasspython.dox
grass/branches/develbranch_6/swig/swiglib.dox
Log:
doxygen page clean up
Modified: grass/branches/develbranch_6/swig/python/grasspython.dox
===================================================================
--- grass/branches/develbranch_6/swig/python/grasspython.dox 2009-05-27 09:48:05 UTC (rev 37532)
+++ grass/branches/develbranch_6/swig/python/grasspython.dox 2009-05-27 09:53:44 UTC (rev 37533)
@@ -1,22 +1,43 @@
-/*! \page GRASS_SWIG_PYTHON GRASS 6 SWIG/PYTHON interface
+/*! \page GRASS_SWIG_PYTHON GRASS SWIG/PYTHON interface
-<h2>GRASS 6 SWIG/PYTHON interface</h2>
+At the moment a prototype is implemented. It permits to use some GRASS
+library functions directly from the PYTHON programming language.
-At the moment a prototype is implemented (a more advanced interface
-is included in GRASS 7). It permits to use some GRASS 6 library
-functions directly from the PYTHON programming language.
+\section status Status of GRASS SWIG/PYTHON implementation
-<P>
-See: python_grass6.i
+There is a <b>grass.lib</b> package with a series of separate modules
+available. Python SWIG modules are organized as follows:
-<p>
-Examples:
-<ul>
-<li> examples/rasteraccess.py
-<li> examples/vectoraccess.py
-<li> examples/m.distance
-<li> test.py
-</ul>
+ - grass.lib
+ - arraystats.py
+ - cluster.py
+ - date.py
+ - dbmi.py
+ - display.py
+ - g3d.py
+ - grass.py
+ - imagery.py
+ - math.py
+ - proj.py
+ - raster.py
+ - stats.py
+ - trans.py
+ - utils.py
+ - vector.py
+ - vedit.py
+\section usage Usage
+
+Access to GRASS library functions (example: Vector functions):
+
+\code
+from grass.lib import vector as grassvect
+\endcode
+
+\section examples Examples
+
+ - examples/m.distance.py
+ - examples/rasteraccess.py
+ - examples/vectoraccess.py
+
*/
-
Modified: grass/branches/develbranch_6/swig/swiglib.dox
===================================================================
--- grass/branches/develbranch_6/swig/swiglib.dox 2009-05-27 09:48:05 UTC (rev 37532)
+++ grass/branches/develbranch_6/swig/swiglib.dox 2009-05-27 09:53:44 UTC (rev 37533)
@@ -1,70 +1,54 @@
/*! \mainpage GRASS_SWIG_interface GRASS SWIG interface
-<h2>GRASS SWIG interface</h2>
+<a href="http://grass.osgeo.org">GRASS GIS</a> (Geographic Resources
+Analysis Support System) is an open source, Free Software
+<em>Geographical Information System</em> (GIS) with raster,
+topological %vector, image processing, and graphics production
+functionality that operates on various platforms through a graphical
+user interface (GUI) or command line interface (CLI). It is released under GNU
+General Public License (GPL).
-GRASS GIS (Geographic Resources Analysis Support System) is an open source,
-Free Software Geographical Information System (GIS) with raster, topological
-vector, image processing, and graphics production functionality that
-operates on various platforms through a graphical user interface and shell
-in X-Window. GRASS is released under GNU General Public License (GPL).
-The GRASS SWIG interface partially released under X11/MIT License.
+<i>Cited from <a href="http://www.swig.org/">SWIG Web
+site</a>:</i><br> SWIG is a software development tool that connects
+programs written in C and C++ with a variety of high-level programming
+languages. SWIG is used with different types of languages including
+common scripting languages such as Perl, PHP, Python, Tcl, Ruby and
+PHP. The list of <a
+href="http://www.swig.org/compat.html#SupportedLanguages">supported
+languages</a> also includes on-scripting languages such as C#, Common
+Lisp (CLISP, Allegro CL, UFFI), Java, Modula-3 and OCAML. Also several
+interpreted and compiled Scheme implementations (Guile, MzScheme,
+Chicken) are supported. SWIG is most commonly used to create
+high-level interpreted or compiled programming environments, user
+interfaces, and as a tool for testing and prototyping C/C++ software.
+SWIG can also export its parse tree in the form of XML and Lisp
+s-expressions. SWIG may be freely used, distributed, and modified for
+commercial and non-commercial use.
-<p>
-<i>Cited from <a href="http://www.swig.org/">SWIG Web site</a>:</i><br>
-SWIG is a software development tool that connects programs written in
-C and C++ with a variety of high-level programming
-languages. SWIG is used with different types of languages including common scripting languages such as
-Perl, PHP, Python, Tcl, Ruby and PHP. The list of
-<a href="http://www.swig.org/compat.html#SupportedLanguages">supported languages</a> also includes
-on-scripting languages such as C#, Common Lisp (CLISP, Allegro CL, UFFI), Java, Modula-3 and OCAML. Also several
-interpreted and compiled Scheme implementations (Guile, MzScheme, Chicken)
-are supported. SWIG is most
-commonly used to create high-level interpreted or compiled programming
-environments, user interfaces, and as a tool for testing and prototyping C/C++
-software. SWIG can also export its parse tree in the form of XML and
-Lisp s-expressions. SWIG may be freely used, distributed, and modified for commercial
-and non-commercial use.
+\section swiglibes Status of GRASS SWIG implementation
-<h2>Status of GRASS SWIG implementation</h2>
+ - \ref GRASS_SWIG_PERL
+ - \ref GRASS_SWIG_PYTHON
-<h3>GRASS SWIG PERL implementation</h3>
+\section discussion Discussions in the Mailing list
-At the moment a prototype is implemented.
-<P>
-See: \ref GRASS_SWIG_PERL
-
-<h3>GRASS SWIG PYTHON implementation</h3>
-
-At the moment a prototype is implemented.
-<P>
-See: \ref GRASS_SWIG_PYTHON
-
-
-<h2>Discussions in the Mailing list</h2>
See
-<ul>
-<li><a href="http://www.google.com/search?num=20&hl=en&lr=&q=swig+%5BGRASS5%5D+site%3Agrass.itc.it&btnG=Search">here</a> for
+ - <a href="http://www.google.com/search?num=20&hl=en&lr=&q=swig+%5BGRASS5%5D+site%3Agrass.itc.it&btnG=Search">here</a> for
discussions in the old developers mailing list.
-<li><a href="http://www.google.com/search?q=swig&as_qdr=all&sa=Google+Search&domains=lists.osgeo.org&sitesearch=lists.osgeo.org%2Fpipermail%2Fgrass-user%2F">here</a>
+ - <a href="http://www.google.com/search?q=swig&as_qdr=all&sa=Google+Search&domains=lists.osgeo.org&sitesearch=lists.osgeo.org%2Fpipermail%2Fgrass-user%2F">here</a>
for discussions in the new developers mailing list.
-</ul>
+\section code Code availability
-<h2>Code availability</h2>
-
The source code is available here:
-<ul>
-<li> in <a href="http://grass.osgeo.org/devel/index.php#software">GRASS SVN</a>
-<li> in the <a href="http://grass.osgeo.org/grass64/source/snapshot/">weekly SVN snapshot</a> (swig/ subdirectory)
-<li> via <a href="http://trac.osgeo.org/grass/browser/grass">SVN TracBrowser interface</a>
-</ul>
+ - in <a href="http://grass.osgeo.org/devel/index.php#software">GRASS SVN</a>
+ - in the <a href="http://grass.osgeo.org/grass65/source/snapshot/">weekly SVN snapshot</a> (swig/ subdirectory)
+ - via <a href="http://trac.osgeo.org/grass/browser/grass/branches/develbranch_6/swig">SVN Trac interface</a>
-<h2>See also</h2>
+\section see_also See also
-<ul>
-<li> <a href="http://download.osgeo.org/grass/grass6_progman/">GRASS Programmer's manual</a>
-</ul>
+ - <a href="http://download.osgeo.org/grass/grass6_progman/">GRASS Programmer's manual</a>
*/
More information about the grass-commit
mailing list