style_structure.txt
792 Bytes
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
Man page style guide and structure
Tricks
use xpsview to view your changes. make file.ps, xpsview file.ps
Style
NAME
name - blah blah
C SPECIFICATION
use .nf and .fi, see gDPFillRectangle for example.
also bound prototype with \f3 and \fP
if arg type + number of args are wide, use row for each arg.
use tab to keep multiline args in line.
space before ")" on the last arg
for gbi docs, do only g* not gs* versions. gs* are redundant.
just g* without *pkt.
PARAMETERS
describe bit width in mbi types of docs.
bound constants with \f3 and \fP
DESCRIPTION
NOTE
EMULATOR
describe emulator caveats
SEE ALSO
use .IR line for each cross-reference. See gDPSetColor for ex.
PERFORMANCE
describe tuning tricks
Structure
in doc/dev/style_structure.txt