Browse Source

Doxygen cleanup: changed references from old itc.it web page/mailing lists to osgeo.org ones;
Removed unused <title> tags;
Doxygen now includes images in HTML from current folder.
[merged from devbr6, https://trac.osgeo.org/grass/changeset/32082, 32083]


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

Martin Landa 17 years ago
parent
commit
bc2c15ac5c

+ 15 - 0
Makefile

@@ -399,6 +399,21 @@ pdfdocs:
 	(cd swig/; $(MAKE) cleandocs ; $(MAKE) pdfdocs)
 	(cd swig/; $(MAKE) cleandocs ; $(MAKE) pdfdocs)
 	@echo "Written PDF docs in: lib/db/latex/, lib/g3d/latex/, lib/gis/latex/, lib/gmath/latex/ lib/gpde/latex/ lib/ogsf/latex/, lib/proj//latex/, lib/segment/latex/, lib/vector/latex/ lib/vector/dglib/latex/ rfc/latex/ swig/latex/"
 	@echo "Written PDF docs in: lib/db/latex/, lib/g3d/latex/, lib/gis/latex/, lib/gmath/latex/ lib/gpde/latex/ lib/ogsf/latex/, lib/proj//latex/, lib/segment/latex/, lib/vector/latex/ lib/vector/dglib/latex/ rfc/latex/ swig/latex/"
 
 
+cleandocs:
+	(cd lib/db/ ; $(MAKE) cleandocs)
+	(cd lib/g3d/ ; $(MAKE) cleandocs)
+	(cd lib/gis/ ; $(MAKE) cleandocs)
+	(cd lib/gmath/ ; $(MAKE) cleandocs)
+	(cd lib/gpde/ ; $(MAKE) cleandocs)
+	(cd lib/ogsf/ ; $(MAKE) cleandocs)
+	(cd lib/proj/ ; $(MAKE) cleandocs)
+	(cd lib/segment/; $(MAKE) cleandocs)
+	(cd lib/vector/ ; $(MAKE) cleandocs)
+	(cd lib/vector/dglib/ ; $(MAKE) cleandocs)
+	(cd lib/ ; $(MAKE) cleandocs)
+	(cd rfc/ ; $(MAKE) cleandocs)
+	(cd swig/; $(MAKE) cleandocs)
+
 html2pdfdoc:
 html2pdfdoc:
 	@ echo "Light PDF document from modules' HTML documentation"
 	@ echo "Light PDF document from modules' HTML documentation"
 	@ # http://www.htmldoc.org
 	@ # http://www.htmldoc.org

+ 3 - 1
README

@@ -33,7 +33,9 @@ Graphviz dot (http://www.research.att.com/sw/tools/graphviz/).
 
 
 To build the GRASS programmer's documentation, run
 To build the GRASS programmer's documentation, run
    make htmldocs
    make htmldocs
-here. This takes quite some time. The result is in doxygenhtml/index.html
+or to generate documentation as single html file (recommended for simple reading)
+   make htmldocs-single
+here. This takes quite some time. The result is in lib/html/index.html
 which refers to further document repositories in
 which refers to further document repositories in
    lib/vector/html/index.html
    lib/vector/html/index.html
    lib/db/html/index.html
    lib/db/html/index.html

+ 1 - 1
include/Make/Doxyfile_arch_html

@@ -485,7 +485,7 @@ EXAMPLE_RECURSIVE      = NO
 # directories that contain image that are included in the documentation (see 
 # directories that contain image that are included in the documentation (see 
 # the \image command).
 # the \image command).
 
 
-IMAGE_PATH             = 
+IMAGE_PATH             = .
 
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should 
 # invoke to filter for each input file. Doxygen will invoke the filter program 
 # invoke to filter for each input file. Doxygen will invoke the filter program 

+ 1 - 1
lib/db/dbmilib.dox

@@ -595,7 +595,7 @@ int #db_driver ()
 
 
 \section contacts Contacts
 \section contacts Contacts
 
 
- GRASS Development Team: http://grass.itc.it (preferably developers mailing list)
+ GRASS Development Team: http://grass.osgeo.org (preferably developers mailing list)
 
 
 
 
 \section references References
 \section references References

+ 0 - 2
lib/display/displaylib.dox

@@ -1,7 +1,5 @@
 /*! \page displaylib GRASS Display Library
 /*! \page displaylib GRASS Display Library
 
 
-<title>GRASS Display Library</title>
-
 \section displayintro Display Library
 \section displayintro Display Library
 
 
 <P>
 <P>

+ 0 - 1
lib/g3d/g3dlib.dox

@@ -2,7 +2,6 @@
 <!-- doxygenized from "GRASS 5 Programmer's Manual" 
 <!-- doxygenized from "GRASS 5 Programmer's Manual" 
      by M. Neteler 5/2004, 8/2005
      by M. Neteler 5/2004, 8/2005
   -->
   -->
-<title>GRASS Grid3D raster volume Library</title>
 
 
 \section g3dintro Grid3D raster volume Library
 \section g3dintro Grid3D raster volume Library
 
 

+ 0 - 1
lib/gmath/gmathlib.dox

@@ -2,7 +2,6 @@
 <!-- doxygenized from "GRASS 5 Programmer's Manual" 
 <!-- doxygenized from "GRASS 5 Programmer's Manual" 
      by M. Neteler 8/2005
      by M. Neteler 8/2005
   -->
   -->
-<title>GRASS Numerical math interface</title>
 
 
 \section gmathintro Numerical math interface with optional support of LAPACK/BLAS
 \section gmathintro Numerical math interface with optional support of LAPACK/BLAS
 
 

+ 1 - 1
lib/gpde/gpdelib.dox

@@ -223,7 +223,7 @@ void #N_write_array_2d_to_rast (N_array_2d * array, char *name);
 
 
 <P>
 <P>
 <b>Example implementation:</b><br>
 <b>Example implementation:</b><br>
-The GRASS module <a href="http://grass.itc.it/grass63/manuals/html63_user/r.gwflow.html">r.gwflow</a>
+The GRASS module <a href="http://grass.osgeo.org/grass63/manuals/html63_user/r.gwflow.html">r.gwflow</a>
 implements numerical calculation program for transient,
 implements numerical calculation program for transient,
 confined and unconfined groundwater flow in two dimensions.
 confined and unconfined groundwater flow in two dimensions.
 
 

+ 2 - 2
lib/grasslib.dox

@@ -104,7 +104,7 @@ from GRASS 5 Programmer's manual) or are simply undocumented.</I>
 <h3>Interfaces</h3>
 <h3>Interfaces</h3>
 
 
 <ul>
 <ul>
-<li> GRASS SWIG interface <a href=../../swig/html/>see here</a>.
+<li> GRASS SWIG interface <a href="../../swig/html/index.html">see here</a>.
 </ul>
 </ul>
 
 
 <h3>File structure of GRASS Location</h3>
 <h3>File structure of GRASS Location</h3>
@@ -155,6 +155,6 @@ as follows:
   storage in database (DBMS).</li>
   storage in database (DBMS).</li>
 </ul>
 </ul>
 
 
-<img src="http://grass.osgeo.org/images/loc_struct.png" alt="Diagram of GRASS file structure">
+\image html "loc_struct.png" "Diagram of GRASS file structure"
 
 
 */
 */

+ 0 - 1
lib/imagery/imagerylib.dox

@@ -2,7 +2,6 @@
 <!-- doxygenized from "GRASS 5 Programmer's Manual" 
 <!-- doxygenized from "GRASS 5 Programmer's Manual" 
      by M. Neteler 2/2004
      by M. Neteler 2/2004
   -->
   -->
-<title>GRASS Imagery Library</title>
 
 
 \section imageryintro Introduction to Imagery Library
 \section imageryintro Introduction to Imagery Library
 
 

+ 1 - 1
lib/init/README

@@ -78,5 +78,5 @@ o GRASS non-interactive startup examples
 			# GISDBASE/loc2-1/map1-1 location
 			# GISDBASE/loc2-1/map1-1 location
 
 
 
 
-  Any suggestionss to <grass-dev@grass.itc.it>
+  Any suggestionss to <grass-dev@lists.osgeo.org>
 
 

+ 1 - 1
lib/init/init.bat

@@ -118,7 +118,7 @@ FOR /F "usebackq delims==" %%i IN (`g.gisenv "get=LOCATION_NAME"`) DO @set LOCAT
 type "%WINGISBASE%\etc\welcome"
 type "%WINGISBASE%\etc\welcome"
 
 
 "%WINGISBASE%\etc\echo" ""
 "%WINGISBASE%\etc\echo" ""
-"%WINGISBASE%\etc\echo" "GRASS homepage:                          http://grass.itc.it/"
+"%WINGISBASE%\etc\echo" "GRASS homepage:                          http://grass.osgeo.org/"
 "%WINGISBASE%\etc\echo" "This version running thru:               Windows Command Shell (cmd.exe)"
 "%WINGISBASE%\etc\echo" "This version running thru:               Windows Command Shell (cmd.exe)"
 "%WINGISBASE%\etc\echo" "When ready to quit enter:                exit"
 "%WINGISBASE%\etc\echo" "When ready to quit enter:                exit"
 "%WINGISBASE%\etc\echo" "Help is available with the command:      g.manual -i"
 "%WINGISBASE%\etc\echo" "Help is available with the command:      g.manual -i"

+ 0 - 1
lib/segment/segmentlib.dox

@@ -2,7 +2,6 @@
 <!-- doxygenized from "GRASS 5 Programmer's Manual" 
 <!-- doxygenized from "GRASS 5 Programmer's Manual" 
      by M. Neteler 8/2005
      by M. Neteler 8/2005
   -->
   -->
-<title>GRASS Segment Library</title>
 
 
 \section segmentintro Segment Library
 \section segmentintro Segment Library
 
 

+ 1 - 1
lib/vector/dglib/dglib.dox

@@ -2,7 +2,7 @@
 
 
 by GRASS Development Team
 by GRASS Development Team
 
 
-http://grass.itc.it/dglib/
+http://grass.osgeo.org/dglib/
 
 
 \section intro Introduction
 \section intro Introduction
 
 

+ 2 - 2
lib/vector/vectorlib.dox

@@ -2,7 +2,7 @@
 
 
 by GRASS Development Team
 by GRASS Development Team
 
 
-http://www.grass-gis.org
+http://grass.osgeo.org
 
 
 <h2>Table of contents</h2>
 <h2>Table of contents</h2>
 
 
@@ -810,7 +810,7 @@ map river because table is stored in a reliable RDBMS.
 \section grassdglib DGLib (Directed Graph Library)
 \section grassdglib DGLib (Directed Graph Library)
 
 
 The Directed Graph Library or DGLib (Micarelli 2002, \ref dglib ,
 The Directed Graph Library or DGLib (Micarelli 2002, \ref dglib ,
-http://grass.itc.it/dglib/) provides functionality for vector network
+http://grass.osgeo.org/dglib/) provides functionality for vector network
 analysis. This library released under GPL is hosted by the GRASS
 analysis. This library released under GPL is hosted by the GRASS
 project (within the GRASS source code). As a stand-alone library it
 project (within the GRASS source code). As a stand-alone library it
 may also be used by other software projects.
 may also be used by other software projects.