From cd953b8f774e6a24b5f666d4852b42c56339e3bc Mon Sep 17 00:00:00 2001 From: Marco Residori Date: Thu, 26 Jan 2017 02:40:16 -0800 Subject: Update description how to generate doxygen documentation from fidl files --- doc/navigation-core/tools/README.txt | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) (limited to 'doc') 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 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 API-part2.pdf will be automatically generated. The final component documentation (API.pdf) will be created in -- cgit v1.2.1