blob: 24e2eb25b66cae4b34d7024fc8e117cda9de522b (
plain)
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
|
---------------------------------
Document Generation
---------------------------------
0)
Install the following packages:
sudo apt-get install wkhtmltopdf
sudo apt-get install xsltproc
sudo apt-get install pdftk
1)
Modify the <component name>API-part1.doc as needed.
2)
Convert the <component name>API-part1.doc
into a pdf document with the same name.
3)
Navigate to the directory 'tools'.
4)
Generate the documentation:
./generate-doc.sh
A document called <component name>API-part2.pdf will be automatically generated.
The final component documentation (<component name>API.pdf) will be created in
the parent directory.
|
