diff options
Diffstat (limited to 'doc/poi-service')
| -rw-r--r-- | doc/poi-service/tool/.gitignore | 1 | ||||
| -rw-r--r-- | doc/poi-service/tool/Doxyfile | 2 | ||||
| -rw-r--r-- | doc/poi-service/tool/GENIVI_POIService_ComponentSpecification-part1.pdf | bin | 631133 -> 0 bytes | |||
| -rw-r--r-- | doc/poi-service/tool/README | 10 |
4 files changed, 11 insertions, 2 deletions
diff --git a/doc/poi-service/tool/.gitignore b/doc/poi-service/tool/.gitignore index 1936cc1..5cfb94b 100644 --- a/doc/poi-service/tool/.gitignore +++ b/doc/poi-service/tool/.gitignore @@ -1 +1,2 @@ html +*.pdf diff --git a/doc/poi-service/tool/Doxyfile b/doc/poi-service/tool/Doxyfile index ce61699..49f615b 100644 --- a/doc/poi-service/tool/Doxyfile +++ b/doc/poi-service/tool/Doxyfile @@ -25,7 +25,7 @@ DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. -PROJECT_NAME = "NavigationCore" +PROJECT_NAME = "POIService" # The PROJECT_NUMBER tag can be used to enter a project or revision number. # This could be handy for archiving the generated documentation or diff --git a/doc/poi-service/tool/GENIVI_POIService_ComponentSpecification-part1.pdf b/doc/poi-service/tool/GENIVI_POIService_ComponentSpecification-part1.pdf Binary files differdeleted file mode 100644 index bf65eb0..0000000 --- a/doc/poi-service/tool/GENIVI_POIService_ComponentSpecification-part1.pdf +++ /dev/null diff --git a/doc/poi-service/tool/README b/doc/poi-service/tool/README index 1e93277..cdb8dd4 100644 --- a/doc/poi-service/tool/README +++ b/doc/poi-service/tool/README @@ -4,7 +4,15 @@ How to generate the component specification 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. + +NB: For some reason the relative path in Franca2IDLFilter.sh doesn't work, so it's needed to change it to an absolute path + +copy them in the folder /usr/local/bin and allow executing these files as programs. + +Generate the pdf file from the xxx-part1.docx Run the script generate_doc.sh +NB: For some reason it's necessary to run it under sudo (don't miss to manage proxy if needed because it gets something on the Internet) + + |