From b801bad8b61d53d44871c7be2ee0f3e9760712ca Mon Sep 17 00:00:00 2001 From: Marco Residori Date: Thu, 22 May 2014 09:51:34 +0200 Subject: Add API documentation.Update copyright notes --- doc/map-viewer/MapViewerAPI.pdf | Bin 0 -> 411890 bytes doc/map-viewer/tools/MapViewerAPI-part1.doc | Bin 0 -> 181248 bytes doc/map-viewer/tools/MapViewerAPI-part1.pdf | Bin 0 -> 292677 bytes doc/map-viewer/tools/README.txt | 27 +++++++++++++ doc/map-viewer/tools/generate-doc.sh | 41 +++++++++++++++++++ doc/navigation-core/NavigationCoreAPI.pdf | Bin 0 -> 553634 bytes .../tools/NavigationCoreAPI-part1.doc | Bin 0 -> 353280 bytes .../tools/NavigationCoreAPI-part1.pdf | Bin 0 -> 374801 bytes doc/navigation-core/tools/README.txt | 27 +++++++++++++ doc/navigation-core/tools/generate-doc.sh | 44 +++++++++++++++++++++ 10 files changed, 139 insertions(+) create mode 100755 doc/map-viewer/MapViewerAPI.pdf create mode 100755 doc/map-viewer/tools/MapViewerAPI-part1.doc create mode 100755 doc/map-viewer/tools/MapViewerAPI-part1.pdf create mode 100755 doc/map-viewer/tools/README.txt create mode 100755 doc/map-viewer/tools/generate-doc.sh create mode 100755 doc/navigation-core/NavigationCoreAPI.pdf create mode 100755 doc/navigation-core/tools/NavigationCoreAPI-part1.doc create mode 100755 doc/navigation-core/tools/NavigationCoreAPI-part1.pdf create mode 100755 doc/navigation-core/tools/README.txt create mode 100755 doc/navigation-core/tools/generate-doc.sh (limited to 'doc') diff --git a/doc/map-viewer/MapViewerAPI.pdf b/doc/map-viewer/MapViewerAPI.pdf new file mode 100755 index 0000000..9a2fa01 Binary files /dev/null and b/doc/map-viewer/MapViewerAPI.pdf differ diff --git a/doc/map-viewer/tools/MapViewerAPI-part1.doc b/doc/map-viewer/tools/MapViewerAPI-part1.doc new file mode 100755 index 0000000..1fc231e Binary files /dev/null and b/doc/map-viewer/tools/MapViewerAPI-part1.doc differ diff --git a/doc/map-viewer/tools/MapViewerAPI-part1.pdf b/doc/map-viewer/tools/MapViewerAPI-part1.pdf new file mode 100755 index 0000000..7081382 Binary files /dev/null and b/doc/map-viewer/tools/MapViewerAPI-part1.pdf differ diff --git a/doc/map-viewer/tools/README.txt b/doc/map-viewer/tools/README.txt new file mode 100755 index 0000000..24e2eb2 --- /dev/null +++ b/doc/map-viewer/tools/README.txt @@ -0,0 +1,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 API-part1.doc as needed. + +2) +Convert the 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 API-part2.pdf will be automatically generated. +The final component documentation (API.pdf) will be created in +the parent directory. diff --git a/doc/map-viewer/tools/generate-doc.sh b/doc/map-viewer/tools/generate-doc.sh new file mode 100755 index 0000000..0d501e3 --- /dev/null +++ b/doc/map-viewer/tools/generate-doc.sh @@ -0,0 +1,41 @@ +#! /bin/bash + +########################################################################### +# @licence app begin@ +# SPDX-License-Identifier: MPL-2.0 +# +# Component Name: MapViewer +# Author: Marco Residori +# +# Copyright (C) 2013, XS Embedded GmbH +# +# License: +# This Source Code Form is subject to the terms of the +# Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with +# this file, You can obtain one at http://mozilla.org/MPL/2.0/. +# +# @licence end@ +########################################################################### + +API_DIR=../../../api/map-viewer +OUTPUT_DIR=.. +OUTPUT_FILE=MapViewerAPI.pdf + +INPUT_FILE1=MapViewerAPI-part1.pdf +INPUT_FILE2=MapViewerAPI-part2.pdf + +#convert xml files into html files +xsltproc -o ./genivi-mapviewer-session.html $API_DIR/introspect.xsl $API_DIR/genivi-mapviewer-session.xml +xsltproc -o ./genivi-mapviewer-configuration.html $API_DIR/introspect.xsl $API_DIR/genivi-mapviewer-configuration.xml +xsltproc -o ./genivi-mapviewer-mapviewercontrol.html $API_DIR/introspect.xsl $API_DIR/genivi-mapviewer-mapviewercontrol.xml +xsltproc -o ./genivi-mapviewer-constants.html $API_DIR/constants.xsl $API_DIR/genivi-mapviewer-constants.xml + +#concatenate html files into a single pdf file +wkhtmltopdf ./genivi-mapviewer-mapviewercontrol.html ./genivi-mapviewer-session.html ./genivi-mapviewer-configuration.html ./genivi-mapviewer-constants.html $INPUT_FILE2 + +#remove temporary html files +rm *.html + +#concatenate pdf files +pdftk $INPUT_FILE1 $INPUT_FILE2 cat output $OUTPUT_DIR/$OUTPUT_FILE + diff --git a/doc/navigation-core/NavigationCoreAPI.pdf b/doc/navigation-core/NavigationCoreAPI.pdf new file mode 100755 index 0000000..4ede81e Binary files /dev/null and b/doc/navigation-core/NavigationCoreAPI.pdf differ diff --git a/doc/navigation-core/tools/NavigationCoreAPI-part1.doc b/doc/navigation-core/tools/NavigationCoreAPI-part1.doc new file mode 100755 index 0000000..664125e Binary files /dev/null and b/doc/navigation-core/tools/NavigationCoreAPI-part1.doc differ diff --git a/doc/navigation-core/tools/NavigationCoreAPI-part1.pdf b/doc/navigation-core/tools/NavigationCoreAPI-part1.pdf new file mode 100755 index 0000000..29eaa2d Binary files /dev/null and b/doc/navigation-core/tools/NavigationCoreAPI-part1.pdf differ diff --git a/doc/navigation-core/tools/README.txt b/doc/navigation-core/tools/README.txt new file mode 100755 index 0000000..24e2eb2 --- /dev/null +++ b/doc/navigation-core/tools/README.txt @@ -0,0 +1,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 API-part1.doc as needed. + +2) +Convert the 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 API-part2.pdf will be automatically generated. +The final component documentation (API.pdf) will be created in +the parent directory. diff --git a/doc/navigation-core/tools/generate-doc.sh b/doc/navigation-core/tools/generate-doc.sh new file mode 100755 index 0000000..80d1709 --- /dev/null +++ b/doc/navigation-core/tools/generate-doc.sh @@ -0,0 +1,44 @@ +#! /bin/bash + +########################################################################### +# @licence app begin@ +# SPDX-License-Identifier: MPL-2.0 +# +# Component Name: GNSSService +# Author: Marco Residori +# +# Copyright (C) 2013, XS Embedded GmbH +# +# License: +# This Source Code Form is subject to the terms of the +# Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with +# this file, You can obtain one at http://mozilla.org/MPL/2.0/. +# +# @licence end@ +########################################################################### + +API_DIR=../../../api/navigation-core +OUTPUT_DIR=.. +OUTPUT_FILE=NavigationCoreAPI.pdf + +INPUT_FILE1=NavigationCoreAPI-part1.pdf +INPUT_FILE2=NavigationCoreAPI-part2.pdf + +#convert xml files into html files +xsltproc -o ./genivi-navigationcore-session.html $API_DIR/introspect.xsl $API_DIR/genivi-navigationcore-session.xml +xsltproc -o ./genivi-navigationcore-configuration.html $API_DIR/introspect.xsl $API_DIR/genivi-navigationcore-configuration.xml +xsltproc -o ./genivi-navigationcore-routing.html $API_DIR/introspect.xsl $API_DIR/genivi-navigationcore-routing.xml +xsltproc -o ./genivi-navigationcore-guidance.html $API_DIR/introspect.xsl $API_DIR/genivi-navigationcore-guidance.xml +xsltproc -o ./genivi-navigationcore-locationinput.html $API_DIR/introspect.xsl $API_DIR/genivi-navigationcore-locationinput.xml +xsltproc -o ./genivi-navigationcore-mapmatchedposition.html $API_DIR/introspect.xsl $API_DIR/genivi-navigationcore-mapmatchedposition.xml +xsltproc -o ./genivi-navigationcore-constants.html $API_DIR/constants.xsl $API_DIR/genivi-navigationcore-constants.xml + +#concatenate html files into a single pdf file +wkhtmltopdf ./genivi-navigationcore-routing.html ./genivi-navigationcore-session.html ./genivi-navigationcore-configuration.html ./genivi-navigationcore-guidance.html ./genivi-navigationcore-mapmatchedposition.html ./genivi-navigationcore-locationinput.html ./genivi-navigationcore-constants.html $INPUT_FILE2 + +#remove temporary html files +rm *.html + +#concatenate pdf files +pdftk $INPUT_FILE1 $INPUT_FILE2 cat output $OUTPUT_DIR/$OUTPUT_FILE + -- cgit v1.2.1