File: html_documentation.txt

package info (click to toggle)
grass 6.0.2-6
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 40,044 kB
  • ctags: 31,303
  • sloc: ansic: 321,125; tcl: 25,676; sh: 11,176; cpp: 10,098; makefile: 5,025; fortran: 1,846; yacc: 493; lex: 462; perl: 133; sed: 1
file content (23 lines) | stat: -rw-r--r-- 737 bytes parent folder | download | duplicates (9) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
HOWTO document in this GRASS version?

- source code docs: use doxygen style 
  example: lib/proj/
           other libs

- modules:
   - write a file 'description.html' (see other modules for how to do that)
   - you can add figures (PNG format), the figure name prefix
     should be the module name

- header information: auto-generated
   The header information is automatically added during the build
   process. You can generate the header HTML to stdout by running 
   the module with the --html-description qualifier:
     g.module --html-description

- see also this script:  tools/build_html_index.html

- The Programmers' manual can by created from the inline Doxygen comments with:
     make htmldocs (or)
     make pdfdocs