diff options
| author | Marco Residori <marco_residori@mentor.com> | 2017-01-26 02:40:16 -0800 |
|---|---|---|
| committer | Marco Residori <marco_residori@mentor.com> | 2017-01-26 02:40:16 -0800 |
| commit | cd953b8f774e6a24b5f666d4852b42c56339e3bc (patch) | |
| tree | 14e5fec200ce418761ee2c5c5b5245bbc82232f2 /doc | |
| parent | 531eff0e54afddbfdb22af4222460a9a9aa1030e (diff) | |
| download | poi-service-cd953b8f774e6a24b5f666d4852b42c56339e3bc.tar.gz | |
Update description how to generate doxygen documentation from fidl files
Diffstat (limited to 'doc')
| -rwxr-xr-x | doc/navigation-core/tools/README.txt | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/navigation-core/tools/README.txt b/doc/navigation-core/tools/README.txt index 24e2eb2..fd134af 100755 --- a/doc/navigation-core/tools/README.txt +++ b/doc/navigation-core/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,7 +24,9 @@ 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 |