Changes between Version 3 and Version 4 of Submitting/Docs


Ignore:
Timestamp:
Jun 21, 2014, 8:50:02 AM (10 years ago)
Author:
neteler
Comment:

cosmetics

Legend:

Unmodified
Added
Removed
Modified

  • Submitting/Docs

    v3 v4  
    66
    77   There are two types of documentation
    8    - Libraries programmers docs: we [http://grass.osgeo.org/programming7/ use doxygen and document the functions]
    9       directly in the source code. See lib/gis/*.c and lib/gis/gislib.dox for examples
     8   - Libraries programmers docs: we [http://grass.osgeo.org/programming7/ use doxygen and document the functions] directly in the source code. See lib/gis/*.c and lib/gis/gislib.dox for examples
    109
    11    - User manual: we write it in simple HTML, storing the manual in a
    12       file '<module>.html' within the subdirectory of the module.
    13       The file contains no header nor footer. The complete HTML file is
    14       autogenerated during the compilation process (indeed, it is generated
    15       in a virtual session directly after compilation of the module).
    16       In this virtual session the module is called internally with
    17       --html-description which generates the parameters/flags list in
    18       HTML format, along with '<module>.html', HTML header and footer
    19       the final HTML manual page is created and stored in the target
    20       binaries directory. In a separate process the MAN format is
    21       generated from the complete HTML files.
     10   - User manual: we write it in simple HTML, storing the manual in a file '<module>.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 '<module>.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.
    2211
    2312See also