Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 7309 for code/branches/doc


Ignore:
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:
2 edited

Legend:

Unmodified
Added
Removed
  • code/branches/doc/doc/api/doxy.config.in

    r7306 r7309  
    134134# are normally passed to the compiler using the -I flag.
    135135
    136 STRIP_FROM_INC_PATH    = @CMAKE_SOURCE_DIR@
     136STRIP_FROM_INC_PATH    = @DOXYGEN_INCLUDE_DIRECTORIES@
    137137
    138138# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
  • code/branches/doc/src/CMakeLists.txt

    r7224 r7309  
    116116ADD_SUBDIRECTORY(modules)
    117117
    118 ################ Executable ################
     118################## Executable ###################
    119119
    120120INCLUDE_DIRECTORIES(
     
    161161  CONFIGURE_FILE("${CMAKE_CURRENT_SOURCE_DIR}/orxonox-main.vcproj.user.in" "${CMAKE_CURRENT_BINARY_DIR}/orxonox-main.vcproj.user")
    162162ENDIF(MSVC)
     163
     164#################### Doxygen ####################
     165
     166# Prepare include paths for Doxygen. This is necessary to display
     167# the correct path to use when including a file, e.g.
     168# core/XMLPort.h instead of src/core/XMLPort.h
     169
     170INCLUDE_DIRECTORIES(${CMAKE_CURRENT_SOURCE_DIR}/modules)
     171GET_DIRECTORY_PROPERTY(_temp INCLUDE_DIRECTORIES)
     172# Replace ';' by spaces
     173STRING(REPLACE ";" " " _temp "${_temp}")
     174SET(DOXYGEN_INCLUDE_DIRECTORIES "${_temp}" PARENT_SCOPE)
Note: See TracChangeset for help on using the changeset viewer.