Changeset 7309 for code/branches/doc

Timestamp:

Sep 1, 2010, 11:51:39 AM (14 years ago)

Author:

rgrieder

Message:

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.

Location:

code/branches/doc

Files:

• doc/api/doxy.config.in (modified) (1 diff)
• src/CMakeLists.txt (modified) (2 diffs)

code/branches/doc/doc/api/doxy.config.in

@@ -134 +134 @@
 # 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

code/branches/doc/src/CMakeLists.txt

@@ -116 +116 @@
 ADD_SUBDIRECTORY(modules)
 
-################ Executable ################
+################## Executable ###################
 
 INCLUDE_DIRECTORIES(
@@ -161 +161 @@
   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)