update documentation, generation OK

13 files changed, 19 insertions, 83 deletions

diff --git a/doc/map-viewer/LICENSE b/doc/map-viewer/LICENSE
new file mode 100644
index 0000000..094e4c2
--- /dev/null
+++ b/doc/map-viewer/LICENSE
@@ -0,0 +1,2 @@
+The documentation is published under the terms of the Creative Commons Attribution Share-Alike 4.0 License 
+See here for more details: http://creativecommons.org/
diff --git a/doc/map-viewer/MapViewerAPI.pdf b/doc/map-viewer/MapViewerAPI.pdf
deleted file mode 100644
index 96785a4..0000000
--- a/doc/map-viewer/MapViewerAPI.pdf
+++ /dev/null
diff --git a/doc/map-viewer/MapViewer_ComponentSpecification.pdf b/doc/map-viewer/MapViewer_ComponentSpecification.pdf
new file mode 100644
index 0000000..5d6cf3b
--- /dev/null
+++ b/doc/map-viewer/MapViewer_ComponentSpecification.pdf
diff --git a/doc/map-viewer/tool/.gitignore b/doc/map-viewer/tool/.gitignore
new file mode 100644
index 0000000..1936cc1
--- /dev/null
+++ b/doc/map-viewer/tool/.gitignore
@@ -0,0 +1 @@
+html
diff --git a/doc/map-viewer/tools/Doxyfile b/doc/map-viewer/tool/Doxyfile
index 7820c4a..82d2786 100644
--- a/doc/map-viewer/tools/Doxyfile
+++ b/doc/map-viewer/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           = "MapViewer API"
+PROJECT_NAME           = "MapViewer"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
 # This could be handy for archiving the generated documentation or
@@ -581,7 +581,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = ../../../api/franca/navigation/mapviewer/
+INPUT                  = ../../../api/franca/navigation/mapviewer 
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
diff --git a/doc/map-viewer/tool/GENIVI_MapViewer_ComponentSpecification-part1.docx b/doc/map-viewer/tool/GENIVI_MapViewer_ComponentSpecification-part1.docx
new file mode 100644
index 0000000..7c33841
--- /dev/null
+++ b/doc/map-viewer/tool/GENIVI_MapViewer_ComponentSpecification-part1.docx
diff --git a/doc/map-viewer/tool/GENIVI_MapViewer_ComponentSpecification-part1.pdf b/doc/map-viewer/tool/GENIVI_MapViewer_ComponentSpecification-part1.pdf
new file mode 100644
index 0000000..da88391
--- /dev/null
+++ b/doc/map-viewer/tool/GENIVI_MapViewer_ComponentSpecification-part1.pdf
diff --git a/doc/map-viewer/tool/README b/doc/map-viewer/tool/README
new file mode 100644
index 0000000..1e93277
--- /dev/null
+++ b/doc/map-viewer/tool/README
@@ -0,0 +1,10 @@
+--------------------------------------------
+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.
+
+Run the script generate_doc.sh
+
diff --git a/doc/map-viewer/tools/generate-franca-api-doc.sh b/doc/map-viewer/tool/generate_doc.sh
index e4e08fa..f8cc0ec 100755
--- a/doc/map-viewer/tools/generate-franca-api-doc.sh
+++ b/doc/map-viewer/tool/generate_doc.sh
@@ -4,7 +4,7 @@
 # @licence app begin@
 # SPDX-License-Identifier: MPL-2.0
 #
-# Component Name: EnhancedPositionService
+# Component Name: MapViewer
 # Author: Marco Residori
 #
 # Copyright (C) 2017, Mentor Graphics
@@ -19,9 +19,9 @@
 
 OUTPUT_DIR=..
 
-OUTPUT_FILE=MapViewerAPI.pdf
-FILE1=MapViewerAPI-part1.pdf
-FILE2=MapViewerAPI-part2.pdf
+OUTPUT_FILE=MapViewer_ComponentSpecification.pdf
+FILE1=GENIVI_MapViewer_ComponentSpecification-part1.pdf
+FILE2=GENIVI_MapViewer_ComponentSpecification-part2.pdf
 
 doxygen Doxyfile
 
diff --git a/doc/map-viewer/tools/MapViewerAPI-part1.doc b/doc/map-viewer/tools/MapViewerAPI-part1.doc
deleted file mode 100755
index c27d41d..0000000
--- a/doc/map-viewer/tools/MapViewerAPI-part1.doc
+++ /dev/null
diff --git a/doc/map-viewer/tools/MapViewerAPI-part1.pdf b/doc/map-viewer/tools/MapViewerAPI-part1.pdf
deleted file mode 100755
index 8ac2a48..0000000
--- a/doc/map-viewer/tools/MapViewerAPI-part1.pdf
+++ /dev/null
diff --git a/doc/map-viewer/tools/README.txt b/doc/map-viewer/tools/README.txt
deleted file mode 100755
index ecc15b5..0000000
--- a/doc/map-viewer/tools/README.txt
+++ /dev/null
@@ -1,33 +0,0 @@
----------------------------------
-Document Generation
----------------------------------
-
-0)
-Install the following packages:
-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.
-
-2)
-Convert the <component name>API-part1.doc
-into a pdf document with the same name.
-
-3) 
-Navigate to the directory 'tools'.
-
-4) 
-Generate the documentation:
-./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.
diff --git a/doc/map-viewer/tools/generate-doc.sh b/doc/map-viewer/tools/generate-doc.sh
deleted file mode 100755
index c1497fa..0000000
--- a/doc/map-viewer/tools/generate-doc.sh
+++ /dev/null
@@ -1,44 +0,0 @@
-#! /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
-
-sleep 1
-rm $INPUT_FILE2
-