File: html_documentation.txt

package info (click to toggle)
grass 8.4.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 277,040 kB
  • sloc: ansic: 460,798; python: 227,732; cpp: 42,026; sh: 11,262; makefile: 7,007; xml: 3,637; sql: 968; lex: 520; javascript: 484; yacc: 450; asm: 387; perl: 157; sed: 25; objc: 6; ruby: 4
file content (22 lines) | stat: -rw-r--r-- 734 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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:  utils/build_html_index.html

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