diff options
| author | Marco Residori <marco_residori@mentor.com> | 2017-01-26 02:40:52 -0800 |
|---|---|---|
| committer | Marco Residori <marco_residori@mentor.com> | 2017-01-26 02:40:52 -0800 |
| commit | 73f74aadc03a1aeffb0937220dca803e8d7149b8 (patch) | |
| tree | c89b96c8734f69b7bb779290dd2a53383659a48f /doc | |
| parent | cd953b8f774e6a24b5f666d4852b42c56339e3bc (diff) | |
| download | poi-service-73f74aadc03a1aeffb0937220dca803e8d7149b8.tar.gz | |
Update description how to generate doxygen documentation from fidl files
Diffstat (limited to 'doc')
| -rwxr-xr-x | doc/map-viewer/tools/README.txt | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/doc/map-viewer/tools/README.txt b/doc/map-viewer/tools/README.txt index 24e2eb2..ecc15b5 100755 --- a/doc/map-viewer/tools/README.txt +++ b/doc/map-viewer/tools/README.txt @@ -8,6 +8,10 @@ sudo apt-get install wkhtmltopdf sudo apt-get install xsltproc sudo apt-get install pdftk +Download Franca2IDL.jar and Franca2IDLFilter.sh from +https://drive.google.com/open?id=0B7JseVbR6jvhfjNoSnMyc19HV2lGZW1Jay1lUVZ5YU9qN1NBZTZnRGg2emxZS2ZCQWU5VWM +, copy them in the folder /usr/local/bin and allow executing these files as programs. + 1) Modify the <component name>API-part1.doc as needed. @@ -20,8 +24,10 @@ Navigate to the directory 'tools'. 4) Generate the documentation: -./generate-doc.sh - +./generate-doc.sh (generation of API documentation from dbus xml files) +or +./generate-franca-api-doc.sh (generation of API documentation from franca fidl files) + 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. |