OilfieldToolsNet/opm-core
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rename docu_dir -> doxy_dir to reflect its purpose

Browse Source
This commit is contained in:
Roland Kaufmann 2013-02-21 10:08:38 +01:00
parent 5810819b95
commit 192e4595a5
4 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CMakeLists.txt
View File

@ -249,9 +249,9 @@ add_custom_target (check
# generate documentation from source code with Doxygen; # generate documentation from source code with Doxygen;
# setup install target for this documentation # setup install target for this documentation
set (docu_dir "Documentation") set (doxy_dir "Documentation")
include (OpmDoc) include (OpmDoc)
opm_doc (opm-core ${docu_dir}) opm_doc (opm-core ${doxy_dir})
# provide compatibility with using this build in dunecontrol # provide compatibility with using this build in dunecontrol
include (DuneCompat) include (DuneCompat)

6
Documentation/Doxylocal
View File

@ -27,13 +27,13 @@ EXAMPLE_PATH = @PROJECT_SOURCE_DIR@/tutorials/
# If a relative path is entered, it will be relative to the location # 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. # where doxygen was started. If left blank the current directory will be used.
OUTPUT_DIRECTORY = @PROJECT_BINARY_DIR@/@docu_dir@ OUTPUT_DIRECTORY = @PROJECT_BINARY_DIR@/@doxy_dir@
# The IMAGE_PATH tag can be used to specify one or more files or # The IMAGE_PATH tag can be used to specify one or more files or
# directories that contain image that are included in the documentation (see # directories that contain image that are included in the documentation (see
# the \image command). # the \image command).
IMAGE_PATH = @PROJECT_SOURCE_DIR@/@docu_dir@/Figure IMAGE_PATH = @PROJECT_SOURCE_DIR@/@doxy_dir@/Figure
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
# by doxygen. The layout file controls the global structure of the generated # by doxygen. The layout file controls the global structure of the generated
@ -42,7 +42,7 @@ IMAGE_PATH = @PROJECT_SOURCE_DIR@/@docu_dir@/Figure
# You can optionally specify a file name after the option, if omitted # You can optionally specify a file name after the option, if omitted
# DoxygenLayout.xml will be used as the name of the layout file. # DoxygenLayout.xml will be used as the name of the layout file.
LAYOUT_FILE = @PROJECT_SOURCE_DIR@/@docu_dir@/DoxygenLayout.xml LAYOUT_FILE = @PROJECT_SOURCE_DIR@/@doxy_dir@/DoxygenLayout.xml
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
# style sheet that is used by each HTML page. It can be used to # style sheet that is used by each HTML page. It can be used to

6
cmake/Modules/OpmDistClean.cmake
View File

@ -22,8 +22,8 @@ macro (opm_dist_clean opm)
${${opm}_NAME}-install.cmake ${${opm}_NAME}-install.cmake
${${opm}_NAME}.pc ${${opm}_NAME}.pc
${${opm}_NAME}-install.pc ${${opm}_NAME}-install.pc
${docu_dir}/Doxyfile ${doxy_dir}/Doxyfile
${docu_dir}/Doxyfile.in ${doxy_dir}/Doxyfile.in
CTestTestfile.cmake CTestTestfile.cmake
DartConfiguration.tcl DartConfiguration.tcl
lib/${${opm}_LIBTOOL_ARCHIVE} lib/${${opm}_LIBTOOL_ARCHIVE}
@ -49,7 +49,7 @@ macro (opm_dist_clean opm)
COMMAND ${CMAKE_COMMAND} -E remove_directory Testing/ COMMAND ${CMAKE_COMMAND} -E remove_directory Testing/
COMMAND ${CMAKE_COMMAND} -DDIR=${CMAKE_LIBRARY_OUTPUT_DIRECTORY} -P ${rmdir} COMMAND ${CMAKE_COMMAND} -DDIR=${CMAKE_LIBRARY_OUTPUT_DIRECTORY} -P ${rmdir}
COMMAND ${CMAKE_COMMAND} -DDIR=${CMAKE_RUNTIME_OUTPUT_DIRECTORY} -P ${rmdir} COMMAND ${CMAKE_COMMAND} -DDIR=${CMAKE_RUNTIME_OUTPUT_DIRECTORY} -P ${rmdir}
COMMAND ${CMAKE_COMMAND} -DDIR:LOCATION=${docu_dir} -P ${rmdir} COMMAND ${CMAKE_COMMAND} -DDIR:LOCATION=${doxy_dir} -P ${rmdir}
COMMAND ${CMAKE_COMMAND} -DDIR:LOCATION=${tests_DIR} -P ${rmdir} COMMAND ${CMAKE_COMMAND} -DDIR:LOCATION=${tests_DIR} -P ${rmdir}
# cannot depend on clean because it is only defined in the master Makefile # cannot depend on clean because it is only defined in the master Makefile
# not in CMakeFiles/Makefile where this target will end up # not in CMakeFiles/Makefile where this target will end up

32
cmake/Modules/OpmDoc.cmake
View File

@ -11,30 +11,30 @@
# Output the following variables: # Output the following variables:
# ${opm}_STYLESHEET_COPIED Location of stylesheet to be removed in distclean # ${opm}_STYLESHEET_COPIED Location of stylesheet to be removed in distclean
macro (opm_doc opm docu_dir) macro (opm_doc opm doxy_dir)
# combine the template with local customization # combine the template with local customization
file (READ ${PROJECT_SOURCE_DIR}/cmake/Templates/Doxyfile _doxy_templ) file (READ ${PROJECT_SOURCE_DIR}/cmake/Templates/Doxyfile _doxy_templ)
string (REPLACE ";" "\\;" _doxy_templ "${_doxy_templ}") string (REPLACE ";" "\\;" _doxy_templ "${_doxy_templ}")
if (EXISTS ${PROJECT_SOURCE_DIR}/${docu_dir}/Doxylocal) if (EXISTS ${PROJECT_SOURCE_DIR}/${doxy_dir}/Doxylocal)
file (READ ${PROJECT_SOURCE_DIR}/${docu_dir}/Doxylocal _doxy_local) file (READ ${PROJECT_SOURCE_DIR}/${doxy_dir}/Doxylocal _doxy_local)
string (REPLACE ";" "\\;" _doxy_local "${_doxy_local}") string (REPLACE ";" "\\;" _doxy_local "${_doxy_local}")
else (EXISTS ${PROJECT_SOURCE_DIR}/${docu_dir}/Doxylocal) else (EXISTS ${PROJECT_SOURCE_DIR}/${doxy_dir}/Doxylocal)
set (_doxy_local) set (_doxy_local)
endif (EXISTS ${PROJECT_SOURCE_DIR}/${docu_dir}/Doxylocal) endif (EXISTS ${PROJECT_SOURCE_DIR}/${doxy_dir}/Doxylocal)
file (MAKE_DIRECTORY ${PROJECT_BINARY_DIR}/${docu_dir}) file (MAKE_DIRECTORY ${PROJECT_BINARY_DIR}/${doxy_dir})
file (WRITE ${PROJECT_BINARY_DIR}/${docu_dir}/Doxyfile.in ${_doxy_templ} ${_doxy_local}) file (WRITE ${PROJECT_BINARY_DIR}/${doxy_dir}/Doxyfile.in ${_doxy_templ} ${_doxy_local})
# replace variables in this combined file # replace variables in this combined file
configure_file ( configure_file (
${PROJECT_BINARY_DIR}/${docu_dir}/Doxyfile.in ${PROJECT_BINARY_DIR}/${doxy_dir}/Doxyfile.in
${PROJECT_BINARY_DIR}/${docu_dir}/Doxyfile ${PROJECT_BINARY_DIR}/${doxy_dir}/Doxyfile
@ONLY @ONLY
) )
find_package (Doxygen) find_package (Doxygen)
if (DOXYGEN_FOUND) if (DOXYGEN_FOUND)
add_custom_target (doc add_custom_target (doc
COMMAND ${DOXYGEN_EXECUTABLE} ${PROJECT_BINARY_DIR}/${docu_dir}/Doxyfile COMMAND ${DOXYGEN_EXECUTABLE} ${PROJECT_BINARY_DIR}/${doxy_dir}/Doxyfile
SOURCES ${PROJECT_BINARY_DIR}/${docu_dir}/Doxyfile SOURCES ${PROJECT_BINARY_DIR}/${doxy_dir}/Doxyfile
WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/${docu_dir} WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/${doxy_dir}
COMMENT "Generating API documentation with Doxygen" COMMENT "Generating API documentation with Doxygen"
VERBATIM VERBATIM
) )
@ -47,7 +47,7 @@ macro (opm_doc opm docu_dir)
foreach (format IN LISTS _formats) foreach (format IN LISTS _formats)
string (TOUPPER ${format} FORMAT) string (TOUPPER ${format} FORMAT)
install ( install (
DIRECTORY ${PROJECT_BINARY_DIR}/${docu_dir}/${format} DIRECTORY ${PROJECT_BINARY_DIR}/${doxy_dir}/${format}
DESTINATION ${CMAKE_INSTALL_DOCDIR} DESTINATION ${CMAKE_INSTALL_DOCDIR}
COMPONENT ${format} COMPONENT ${format}
OPTIONAL OPTIONAL
@ -68,10 +68,10 @@ macro (opm_doc opm docu_dir)
# thus, we'll need to copy the stylesheet to this path relative to where # thus, we'll need to copy the stylesheet to this path relative to where
# Doxygen will be run (in the output tree) # Doxygen will be run (in the output tree)
if (NOT PROJECT_SOURCE_DIR STREQUAL PROJECT_BINARY_DIR) if (NOT PROJECT_SOURCE_DIR STREQUAL PROJECT_BINARY_DIR)
file (COPY ${PROJECT_SOURCE_DIR}/${docu_dir}/style.css file (COPY ${PROJECT_SOURCE_DIR}/${doxy_dir}/style.css
DESTINATION ${PROJECT_BINARY_DIR}/${docu_dir} DESTINATION ${PROJECT_BINARY_DIR}/${doxy_dir}
) )
set (${opm}_STYLESHEET_COPIED "${docu_dir}/style.css") set (${opm}_STYLESHEET_COPIED "${doxy_dir}/style.css")
else (NOT PROJECT_SOURCE_DIR STREQUAL PROJECT_BINARY_DIR) else (NOT PROJECT_SOURCE_DIR STREQUAL PROJECT_BINARY_DIR)
set (${opm}_STYLESHEET_COPIED "") set (${opm}_STYLESHEET_COPIED "")
endif (NOT PROJECT_SOURCE_DIR STREQUAL PROJECT_BINARY_DIR) endif (NOT PROJECT_SOURCE_DIR STREQUAL PROJECT_BINARY_DIR)