[Orxonox-commit 2604] r7309 - in code/branches/doc: doc/api src

[rgrieder at orxonox.net]

Author: rgrieder
Date: 2010-09-01 11:51:39 +0200 (Wed, 01 Sep 2010)
New Revision: 7309

Modified:
   code/branches/doc/doc/api/doxy.config.in
   code/branches/doc/src/CMakeLists.txt
Log:
Strip correct paths from includes in Doxygen. That only affects the include file denoted for the documentation of a symbol (like a class).
That way the documentation already shows the correct path in order to include the file required to use the class in question.

Modified: code/branches/doc/doc/api/doxy.config.in
===================================================================
--- code/branches/doc/doc/api/doxy.config.in	2010-09-01 09:48:31 UTC (rev 7308)
+++ code/branches/doc/doc/api/doxy.config.in	2010-09-01 09:51:39 UTC (rev 7309)
@@ -133,7 +133,7 @@
 # definition is used. Otherwise one should specify the include paths that
 # are normally passed to the compiler using the -I flag.
 
-STRIP_FROM_INC_PATH    = @CMAKE_SOURCE_DIR@
+STRIP_FROM_INC_PATH    = @DOXYGEN_INCLUDE_DIRECTORIES@
 
 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
 # (but less readable) file names. This can be useful is your file systems

Modified: code/branches/doc/src/CMakeLists.txt
===================================================================
--- code/branches/doc/src/CMakeLists.txt	2010-09-01 09:48:31 UTC (rev 7308)
+++ code/branches/doc/src/CMakeLists.txt	2010-09-01 09:51:39 UTC (rev 7309)
@@ -115,7 +115,7 @@
 ADD_SUBDIRECTORY(orxonox)
 ADD_SUBDIRECTORY(modules)
 
-################ Executable ################
+################## Executable ###################
 
 INCLUDE_DIRECTORIES(
   ${CMAKE_CURRENT_SOURCE_DIR}/libraries
@@ -160,3 +160,15 @@
          VISUAL_STUDIO_VERSION_SIMPLE "${CMAKE_GENERATOR}")
   CONFIGURE_FILE("${CMAKE_CURRENT_SOURCE_DIR}/orxonox-main.vcproj.user.in" "${CMAKE_CURRENT_BINARY_DIR}/orxonox-main.vcproj.user")
 ENDIF(MSVC)
+
+#################### Doxygen ####################
+
+# Prepare include paths for Doxygen. This is necessary to display
+# the correct path to use when including a file, e.g.
+# core/XMLPort.h instead of src/core/XMLPort.h
+
+INCLUDE_DIRECTORIES(${CMAKE_CURRENT_SOURCE_DIR}/modules)
+GET_DIRECTORY_PROPERTY(_temp INCLUDE_DIRECTORIES)
+# Replace ';' by spaces
+STRING(REPLACE ";" " " _temp "${_temp}")
+SET(DOXYGEN_INCLUDE_DIRECTORIES "${_temp}" PARENT_SCOPE)