Clean up of doc generation

15 files changed, 60 insertions, 153 deletions

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..a2c6caf
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,9 @@
+Release/
+build/
+automotive-dlt.spec
+automotive-dlt.pc
+.cproject
+.project
+config.h
+configure
+
diff --git a/CMakeLists.txt b/CMakeLists.txt
index f19002f..1f222ae 100755
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -42,7 +42,7 @@ SET( CMAKE_ALLOW_LOOSE_LOOP_CONSTRUCTS TRUE )
 

 PROJECT( automotive-dlt )

 

-# Set version parameters

+############## Set version parameters ####################### 

 SET( ${PROJECT_NAME}_MAJOR_VERSION 2 )

 SET( ${PROJECT_NAME}_MINOR_VERSION 4 )

 SET( ${PROJECT_NAME}_PATCH_LEVEL 2 )

@@ -54,14 +54,19 @@ SET( PRINT_MINOR_VERSION ${${PROJECT_NAME}_MINOR_VERSION})
 SET( PRINT_PATCH_LEVEL ${${PROJECT_NAME}_PATCH_LEVEL})

 SET( PRINT_VERSION ${GENIVI_PROJECT_VERSION})

 SET( PRINT_VERSION_STATE ${${PROJECT_NAME}_VERSION_STATE})

-

 SET( DLT_REVISION "")

-IF(NOT DEFINED DLT_REVISION)

-	execute_process(COMMAND git describe --tags WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} 

-	OUTPUT_VARIABLE DLT_REVISION 

-	OUTPUT_STRIP_TRAILING_WHITESPACE)

-        STRING(REPLACE "-" "_" DLT_REVISION ${DLT_REVISION})

-ENDIF(NOT DEFINED DLT_REVISION)

+

+EXECUTE_PROCESS(COMMAND git describe --tags WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} 

+	OUTPUT_VARIABLE DLT_REVISION

+	ERROR_VARIABLE GIT_ERROR 

+	OUTPUT_STRIP_TRAILING_WHITESPACE

+	ERROR_STRIP_TRAILING_WHITESPACE)

+IF( DLT_REVISION MATCHES "^$")

+	SET( PRINT_REVISION "Git revision unavailable")

+ELSE( DLT_REVISION MATCHES "")

+	STRING(REPLACE "-" "_" DLT_REVISION ${DLT_REVISION})

+	SET( PRINT_REVISION ${DLT_REVISION})	

+ENDIF( DLT_REVISION MATCHES "^$")

 

 ##################### RPM SPEC CONFIG ########################

 SET( GENIVI_RPM_RELEASE "1${DLT_REVISION}")

@@ -182,7 +187,6 @@ CHECK_FUNCTION_EXISTS( strtol HAVE_FUNC_STRTOL)
 

 CONFIGURE_FILE(${CMAKE_SOURCE_DIR}/config.h.cmake ${CMAKE_SOURCE_DIR}/config.h @ONLY)

 CONFIGURE_FILE(${CMAKE_SOURCE_DIR}/include/dlt/dlt_version.h.cmake ${CMAKE_SOURCE_DIR}/include/dlt/dlt_version.h @ONLY)

-CONFIGURE_FILE(${CMAKE_SOURCE_DIR}/doxygen.cfg.cmake ${CMAKE_SOURCE_DIR}/doxygen.cfg @ONLY)

 CONFIGURE_FILE(${CMAKE_SOURCE_DIR}/automotive-dlt.pc.cmake ${CMAKE_SOURCE_DIR}/automotive-dlt.pc @ONLY)

 #CONFIGURE_FILE(${CMAKE_SOURCE_DIR}/systemd/dlt.service.cmake ${CMAKE_SOURCE_DIR}/systemd/dlt.service @ONLY)

 #CONFIGURE_FILE(${CMAKE_SOURCE_DIR}/systemd/dlt-syslog.service.cmake ${CMAKE_SOURCE_DIR}/systemd/dlt-syslog.service @ONLY)

@@ -195,7 +199,7 @@ OPTION(ENABLE_BUILD_DOC "Set to ON to build Documentation" OFF)
 

 MESSAGE( STATUS )

 MESSAGE( STATUS "-------------------------------------------------------------------------------" )

-MESSAGE( STATUS "Build for Version ${PRINT_VERSION} build ${DLT_REVISION}")

+MESSAGE( STATUS "Build for Version ${PRINT_VERSION} build ${PRINT_REVISION}")

 MESSAGE( STATUS "VERSION_STATE ${PRINT_VERSION_STATE}")

 MESSAGE( STATUS "BUILD_SHARED_LIBS = ${BUILD_SHARED_LIBS}" )

 MESSAGE( STATUS "CMAKE_INSTALL_PREFIX = ${CMAKE_INSTALL_PREFIX}" )

@@ -217,17 +221,6 @@ ADD_SUBDIRECTORY( testscripts )
 

 IF (ENABLE_BUILD_DOC)

 	ADD_SUBDIRECTORY( doc )

-

-	ADD_CUSTOM_COMMAND(

-		OUTPUT ${CMAKE_SOURCE_DIR}/doxygen-execute

-		DEPENDS  ${CMAKE_SOURCE_DIR}/doxygen.cfg

-		COMMAND doxygen

-		ARGS ${CMAKE_SOURCE_DIR}/doxygen.cfg

-	)

-

-	ADD_CUSTOM_TARGET(doxygen-doc ALL DEPENDS ${CMAKE_SOURCE_DIR}/doxygen-execute)

-

-	SET( DOC_COMPONENT doc)

 ENDIF(ENABLE_BUILD_DOC)

 

 INSTALL(FILES automotive-dlt.pc

diff --git a/ReleaseNotes.txt b/ReleaseNotes.txt
index 2a24478..764ba02 100755
--- a/ReleaseNotes.txt
+++ b/ReleaseNotes.txt
@@ -28,7 +28,8 @@ Changes in this release
 Improvements

    * [GSW-138] API Extension to resend the log messages in the user buffer fixed

    * [GSW-135] Fixed compile warnings 

-

+   * Update of doxygen documentation/generation

+   

 2.4.2

 

 Improvements

diff --git a/automotive-dlt.spec.cmake b/automotive-dlt.spec.cmake
deleted file mode 100644
index 8c000bf..0000000
--- a/automotive-dlt.spec.cmake
+++ /dev/null
@@ -1,92 +0,0 @@
-Name: @PROJECT_NAME@
-Summary: %{name} - Diagnostic Log and Trace
-Version: @PRINT_MAJOR_VERSION@.@PRINT_MINOR_VERSION@.@PRINT_PATCH_LEVEL@
-Release: @GENIVI_RPM_RELEASE@
-License: @LICENSE@
-Group: System Environment/Base
-Vendor: BMW Group AG
-Source: %{name}-%{version}.tar.gz
-BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-root
-Requires: %{name} = %{version}-%{release}, pkgconfig
-
-%description
-This component provides a standardised log and trace interface, based on the
-standardised protocol specified in the AUTOSAR standard 4.0 DLT.
-This component can be used by GENIVI components and other applications as
-logging facility providing
-- the DLT shared library
-- the DLT daemon, including startup scripts
-- the DLT daemon adaptors
-- the DLT client console utilities
-- the DLT test applications
-
-%package doc
-Summary:        %{name} - Diagnostic Log and Trace: Documentation
-Group:          Documentation
-
-%description doc
-This component provides the documentation for %{name}.
-
-%package devel
-Summary:        %{name} - Diagnostic Log and Trace: Development files
-Group:          Development/Libraries
-Requires:       %{name} = %{version}-%{release}, pkgconfig
-
-%description devel
-This component provides the development libraries and includes for %{name}.
-
-%prep
-%setup
-echo "building package automotive-dlt"
-
-%build
-%configure
-make
-
-%install
-rm -rf $RPM_BUILD_ROOT
-make install DESTDIR=$RPM_BUILD_ROOT
-mkdir -p $RPM_BUILD_ROOT/etc/init.d
-/usr/bin/install -c -m 755 testscripts/Ubuntu/dlt-daemon $RPM_BUILD_ROOT/etc/init.d
-
-%clean
-rm -rf $RPM_BUILD_ROOT
-
-%files
-#/etc/init.d/dlt-daemon
-/etc/dlt-system.conf
-/etc/dlt.conf
-/usr/share/dlt-filetransfer/dlt-test-filetransfer-file
-/usr/share/dlt-filetransfer/dlt-test-filetransfer-image.png
-%{_libdir}/libdlt.so.@PRINT_MAJOR_VERSION@
-%{_libdir}/libdlt.so.@GENIVI_PROJECT_VERSION@
-%{_libdir}/libdlt.so
-%{_bindir}/dlt-system
-%{_bindir}/dlt-convert
-%{_bindir}/dlt-receive
-%{_bindir}/dlt-adaptor-stdin
-%{_bindir}/dlt-adaptor-udp
-%{_bindir}/dlt-test-client
-%{_bindir}/dlt-test-user
-%{_bindir}/dlt-test-stress
-%{_bindir}/dlt-test-internal
-%{_bindir}/dlt-test-filetransfer
-
-%attr(0755,root,root) 
-%{_bindir}/dlt-daemon
-%{_bindir}/dlt-example-user
-%{_bindir}/dlt-example-user-func
-%{_bindir}/dlt-example-filetransfer
-
-%files devel
-%{_libdir}/pkgconfig/*.pc
-%{_includedir}/dlt/*.h
-%{_libdir}/pkgconfig/automotive-dlt.pc
-
-%pre
-
-%post
-
-%changelog
-* Wed Nov 24 2010 dlt_maintainer <dlt_maintainer@genivi.org> 2.2.0
-- Creation
diff --git a/automotive-dlt.spec.in b/automotive-dlt.spec.in
index 6f4038d..e1b9236 100644
--- a/automotive-dlt.spec.in
+++ b/automotive-dlt.spec.in
@@ -81,7 +81,8 @@ rm -rf $RPM_BUILD_ROOT
 %{_bindir}/dlt-test-stress-user
 %{_bindir}/dlt-test-internal
 %{_bindir}/dlt-test-filetransfer
-%attr(0755,root,root) %{_bindir}/dlt-daemon
+%attr(0755,root,root) 
+%{_bindir}/dlt-daemon
 %{_bindir}/dlt-example-user
 %{_bindir}/dlt-example-user-func
 %{_bindir}/dlt-example-filetransfer
diff --git a/distfiles b/distfiles
index 70e40d4..687b1e1 100755
--- a/distfiles
+++ b/distfiles
@@ -5,7 +5,6 @@ include/dlt/.*(\.h|\.cpp|\.cmake)
 #testscripts/Ubuntu/.*(\.h|\.cpp|\.cmake)
 #testscripts/Meego/.*(\.h|\.cpp|\.cmake)
 #systemd/.*(\.h|\.cpp|\.cmake)
-doc/.*\.(odt|vsd)
 configure
 distfiles
 automotive-dlt.spec.in
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index 82f730c..d28c230 100755
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -35,33 +35,27 @@
  # @licence end@
 ########
 
-function(convert_odt ODT_FILE)
-  set(pdf "${CMAKE_CURRENT_BINARY_DIR}/${ODT_FILE}.pdf")
-  set(odt "${CMAKE_CURRENT_SOURCE_DIR}/${ODT_FILE}.odt")
-  add_custom_command(
-    OUTPUT ${pdf}
-    DEPENDS ${odt}
-    COMMAND unoconv
-    ARGS --format=pdf --stdout ${odt} > ${pdf}
-  )
-endfunction(convert_odt) 
+CONFIGURE_FILE(${CMAKE_SOURCE_DIR}/doc/doxygen.cfg.cmake ${CMAKE_SOURCE_DIR}/doc/doxygen.cfg @ONLY)
+CONFIGURE_FILE(${CMAKE_SOURCE_DIR}/doc/filetransfer_doxygen.cfg.cmake ${CMAKE_SOURCE_DIR}/doc/filetransfer_doxygen.cfg @ONLY)
+	
+ADD_CUSTOM_COMMAND(
+	OUTPUT ${CMAKE_SOURCE_DIR}/doxygen-execute
+	DEPENDS  ${CMAKE_SOURCE_DIR}/doc/doxygen.cfg
+	COMMAND doxygen
+	ARGS ${CMAKE_SOURCE_DIR}/doc/doxygen.cfg
+)
 
-convert_odt("GENIVI_UserManual_DLT_Client")
-convert_odt("GENIVI_UserManual_DLT_Daemon")
-convert_odt("GENIVI_Specification_DLT_Daemon")
+ADD_CUSTOM_COMMAND(
+	OUTPUT ${CMAKE_SOURCE_DIR}/doxygen-execute2
+	DEPENDS  ${CMAKE_SOURCE_DIR}/doc/filetransfer_doxygen.cfg
+	COMMAND doxygen
+	ARGS ${CMAKE_SOURCE_DIR}/doc/filetransfer_doxygen.cfg
+)
+
+ADD_CUSTOM_TARGET(doc ALL DEPENDS ${CMAKE_SOURCE_DIR}/doxygen-execute)
+ADD_CUSTOM_TARGET(doc-filetransfer ALL DEPENDS ${CMAKE_SOURCE_DIR}/doxygen-execute2)
+
+SET( DOC_COMPONENT doc) 
 
-ADD_CUSTOM_TARGET(Documents ALL echo DEPENDS 
-${CMAKE_CURRENT_BINARY_DIR}/GENIVI_UserManual_DLT_Client.pdf 
-${CMAKE_CURRENT_BINARY_DIR}/GENIVI_UserManual_DLT_Daemon.pdf 
-${CMAKE_CURRENT_BINARY_DIR}/GENIVI_Specification_DLT_Daemon.pdf)
 
-INSTALL(FILES 	${CMAKE_CURRENT_SOURCE_DIR}/GENIVI_UserManual_DLT_Client.odt
-		${CMAKE_CURRENT_SOURCE_DIR}/GENIVI_UserManual_DLT_Daemon.odt
-		${CMAKE_CURRENT_SOURCE_DIR}/GENIVI_Specification_DLT_Daemon.odt
-		${CMAKE_CURRENT_BINARY_DIR}/GENIVI_UserManual_DLT_Client.pdf 
-		${CMAKE_CURRENT_BINARY_DIR}/GENIVI_UserManual_DLT_Daemon.pdf 
-		${CMAKE_CURRENT_BINARY_DIR}/GENIVI_Specification_DLT_Daemon.pdf
-		${CMAKE_CURRENT_SOURCE_DIR}/GENIVI_Specification_DLT_Daemon.vsd
-	DESTINATION "doc/${CMAKE_PROJECT_NAME}"
-	COMPONENT doc)
 
diff --git a/doc/GENIVI_Specification_DLT_Daemon.odt b/doc/GENIVI_Specification_DLT_Daemon.odt
deleted file mode 100755
index 1110997..0000000
--- a/doc/GENIVI_Specification_DLT_Daemon.odt
+++ /dev/null
diff --git a/doc/GENIVI_Specification_DLT_Daemon.vsd b/doc/GENIVI_Specification_DLT_Daemon.vsd
deleted file mode 100755
index a9ec7b0..0000000
--- a/doc/GENIVI_Specification_DLT_Daemon.vsd
+++ /dev/null
diff --git a/doc/GENIVI_UserManual_DLT_Client.odt b/doc/GENIVI_UserManual_DLT_Client.odt
deleted file mode 100755
index 584f147..0000000
--- a/doc/GENIVI_UserManual_DLT_Client.odt
+++ /dev/null
diff --git a/doc/GENIVI_UserManual_DLT_Daemon.odt b/doc/GENIVI_UserManual_DLT_Daemon.odt
deleted file mode 100755
index a7dcb86..0000000
--- a/doc/GENIVI_UserManual_DLT_Daemon.odt
+++ /dev/null
diff --git a/doc/Message_Flow.odg b/doc/Message_Flow.odg
deleted file mode 100755
index 487f9c2..0000000
--- a/doc/Message_Flow.odg
+++ /dev/null
diff --git a/doxygen.cfg.cmake b/doc/doxygen.cfg.cmake
index b695b5a..ded84c3 100755
--- a/doxygen.cfg.cmake
+++ b/doc/doxygen.cfg.cmake
@@ -25,20 +25,20 @@ 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           = @PACKAGE@
+PROJECT_NAME           = @PROJECT_NAME@
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
 # This could be handy for archiving the generated documentation or
 # if some version control system is used.
 
-PROJECT_NUMBER         = @VERSION@
+PROJECT_NUMBER         = @GENIVI_PROJECT_VERSION@
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
 # base path where the generated documentation will be put.
 # If a relative path is entered, it will be relative to the location
 # where doxygen was started. If left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = doc
+OUTPUT_DIRECTORY       = ./DOC_DLT
 
 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
 # 4096 sub-directories (in 2 levels) under the output directory of each output
@@ -573,7 +573,9 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT = src/ include/ 
+INPUT = ./../../src/ \ 
+        ./../../include
+
 
 # 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/filetransfer_doxygen.cfg b/doc/filetransfer_doxygen.cfg.cmake
index 529d32b..c3a091a 100755
--- a/doc/filetransfer_doxygen.cfg
+++ b/doc/filetransfer_doxygen.cfg.cmake
@@ -25,20 +25,20 @@ 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           = DLT Filetransfer
+PROJECT_NAME           = @PROJECT_NAME@ - Filetransfer
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
 # This could be handy for archiving the generated documentation or
 # if some version control system is used.
 
-PROJECT_NUMBER         = 2.3.0
+PROJECT_NUMBER         = @GENIVI_PROJECT_VERSION@
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
 # base path where the generated documentation will be put.
 # If a relative path is entered, it will be relative to the location
 # where doxygen was started. If left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = ./DLT_Filetransfer
+OUTPUT_DIRECTORY       = ./DOC_DLT_Filetransfer
 
 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
 # 4096 sub-directories (in 2 levels) under the output directory of each output
diff --git a/include/dlt/dlt_version.h b/include/dlt/dlt_version.h
index ca2bfc3..fd37867 100755
--- a/include/dlt/dlt_version.h
+++ b/include/dlt/dlt_version.h
@@ -3,10 +3,10 @@
 #define __VERSION_H_
 
 #define PACKAGE_VERSION_STATE ""
-#define PACKAGE_VERSION "2.4.2"
-#define PACKAGE_MAJOR_VERSION "2"
-#define PACKAGE_MINOR_VERSION "4"
-#define PACKAGE_PATCH_LEVEL "2"
+#define PACKAGE_VERSION ""
+#define PACKAGE_MAJOR_VERSION ""
+#define PACKAGE_MINOR_VERSION ""
+#define PACKAGE_PATCH_LEVEL ""
 #define PACKAGE_REVISION ""
 
 #endif