[GRASS-SVN] r36434 - grass/branches/develbranch_6
svn_grass at osgeo.org
svn_grass at osgeo.org
Fri Mar 20 08:42:27 EDT 2009
Author: neteler
Date: 2009-03-20 08:42:27 -0400 (Fri, 20 Mar 2009)
New Revision: 36434
Modified:
grass/branches/develbranch_6/SUBMITTING_DOCS
Log:
say how the docs are handled and generated
Modified: grass/branches/develbranch_6/SUBMITTING_DOCS
===================================================================
--- grass/branches/develbranch_6/SUBMITTING_DOCS 2009-03-20 10:47:14 UTC (rev 36433)
+++ grass/branches/develbranch_6/SUBMITTING_DOCS 2009-03-20 12:42:27 UTC (rev 36434)
@@ -13,6 +13,24 @@
[ see SUBMITTING_PYTHON for Python code hints ]
+0. Introduction
+
+ There are two types of documentation
+ - Libraries programmers docs: we use doxygen and document the functions
+ directly in the source code. See lib/*/*.c and lib/*/*.dox for examples
+
+ - User manual: we write it in simple HTML, storing the manual in a
+ file "description.html" within the subdirectory of the module.
+ The file contains no header nor footer. The complete HTML file is
+ autogenerated during the compilation process (indeed, it is generated
+ in a virtual session directly after compilation of the module).
+ In this virtual session the module is called internally with
+ --html-description which generates the parameters/flags list in
+ HTML format, along with "description.html", HTML header and footer
+ the final HTML manual page is created and stored in the target
+ binaries directory. In a separate process the MAN format is
+ generated from the complete HTML files.
+
1. Editing of HTML pages
To avoid insertion of too complicated HTML tags (see also below),
we strongly suggest to use a plain text editor rather than a
More information about the grass-commit
mailing list