X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/4b2b01eff3a1b860aed60642848a6e1000011c22..bca34544d743e984cc9a66edc89df4c7b9905bff:/buildtools/Cmake/GenerateDoc.cmake diff --git a/buildtools/Cmake/GenerateDoc.cmake b/buildtools/Cmake/GenerateDoc.cmake index d4f482c298..bcae064765 100644 --- a/buildtools/Cmake/GenerateDoc.cmake +++ b/buildtools/Cmake/GenerateDoc.cmake @@ -1,13 +1,19 @@ #### Generate the whole html documentation -find_path(DOXYGEN_PATH NAMES doxygen PATHS NO_DEFAULT_PATHS) +if (enable_documentation) + find_package(Doxygen REQUIRED) + set(DocAll "ALL") +else() + find_package(Doxygen) +endif() + find_path(JAVADOC_PATH NAMES javadoc PATHS NO_DEFAULT_PATHS) find_path(FIG2DEV_PATH NAMES fig2dev PATHS NO_DEFAULT_PATHS) mark_as_advanced(JAVADOC_PATH) -if(DOXYGEN_PATH) +if(DOXYGEN_FOUND) - ADD_CUSTOM_TARGET(simgrid_documentation + ADD_CUSTOM_TARGET(doc ${DocAll} COMMENT "Generating the SimGrid documentation..." DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen} COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html @@ -15,21 +21,23 @@ if(DOXYGEN_PATH) WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc ) - execute_process(COMMAND ${DOXYGEN_PATH}/doxygen --version OUTPUT_VARIABLE DOXYGEN_VERSION ) - string(REGEX MATCH "^[0-9]" DOXYGEN_MAJOR_VERSION "${DOXYGEN_VERSION}") - string(REGEX MATCH "^[0-9].[0-9]" DOXYGEN_MINOR_VERSION "${DOXYGEN_VERSION}") - string(REGEX MATCH "^[0-9].[0-9].[0-9]" DOXYGEN_PATCH_VERSION "${DOXYGEN_VERSION}") - string(REGEX REPLACE "^${DOXYGEN_MINOR_VERSION}." "" DOXYGEN_PATCH_VERSION "${DOXYGEN_PATCH_VERSION}") - string(REGEX REPLACE "^${DOXYGEN_MAJOR_VERSION}." "" DOXYGEN_MINOR_VERSION "${DOXYGEN_MINOR_VERSION}") - message(STATUS "Doxygen version : ${DOXYGEN_MAJOR_VERSION}.${DOXYGEN_MINOR_VERSION}.${DOXYGEN_PATCH_VERSION}") + message(STATUS "Doxygen version: ${DOXYGEN_VERSION}") + + # This is a workaround for older cmake versions + # (such as 2.8.7 on Ubuntu 12.04). These cmake versions do not provide the + # DOXYGEN_VERSION variable and hence, building the documentation will always + # fail. This code is the same as used in the cmake library, version 3. + if(DOXYGEN_EXECUTABLE) + execute_process(COMMAND ${DOXYGEN_EXECUTABLE} "--version" OUTPUT_VARIABLE DOXYGEN_VERSION OUTPUT_STRIP_TRAILING_WHITESPACE) + endif() - if(DOXYGEN_MAJOR_VERSION STRLESS "2" AND DOXYGEN_MINOR_VERSION STRLESS "8") + if(DOXYGEN_VERSION VERSION_LESS "1.8") ADD_CUSTOM_TARGET(error_doxygen - COMMAND ${CMAKE_COMMAND} -E echo "Doxygen must be at least version 1.8 to generate documentation" + COMMAND ${CMAKE_COMMAND} -E echo "Doxygen must be at least version 1.8 to generate documentation. Version found: ${DOXYGEN_VERSION}" COMMAND false ) - add_dependencies(simgrid_documentation error_doxygen) + add_dependencies(doc error_doxygen) endif() configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY) @@ -37,30 +45,30 @@ if(DOXYGEN_PATH) foreach(file ${DOC_FIGS}) string(REPLACE ".fig" ".png" tmp_file ${file}) string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/shared/fig/" "${CMAKE_HOME_DIRECTORY}/doc/html/" tmp_file ${tmp_file}) - ADD_CUSTOM_COMMAND(TARGET simgrid_documentation + ADD_CUSTOM_COMMAND(TARGET doc COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng -S 4 ${file} ${tmp_file} ) endforeach() foreach(file ${DOC_IMG}) ADD_CUSTOM_COMMAND( - TARGET simgrid_documentation + TARGET doc COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/ ) endforeach() - ADD_CUSTOM_COMMAND(TARGET simgrid_documentation + ADD_CUSTOM_COMMAND(TARGET doc COMMAND ${FIG2DEV_PATH}/fig2dev -Lmap ${CMAKE_HOME_DIRECTORY}/doc/shared/fig/simgrid_modules.fig | perl -pe 's/imagemap/simgrid_modules/g'| perl -pe 's/ ${CMAKE_HOME_DIRECTORY}/doc/simgrid_modules.map COMMAND pwd COMMAND ${CMAKE_COMMAND} -E tar czf html/msg-tuto-src.tgz msg-tuto-src/ COMMAND ${CMAKE_COMMAND} -E echo "XX Run doxygen" - COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile + COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile COMMAND ${CMAKE_COMMAND} -E echo "XX Generate the index files" - COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc + COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_HOME_DIRECTORY}/doc/doxygen/logcategories.doc COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/doxygen/logcategories.doc COMMAND ${CMAKE_COMMAND} -E echo "XX Run doxygen again" - COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile + COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_HOME_DIRECTORY}/doc/simgrid_modules.map COMMAND ${CMAKE_COMMAND} -E echo "XX Javadoc pass" COMMAND ${JAVADOC_PATH}/javadoc -quiet -d ${CMAKE_HOME_DIRECTORY}/doc/html/javadoc/ ${CMAKE_HOME_DIRECTORY}/src/bindings/java/org/simgrid/*.java ${CMAKE_HOME_DIRECTORY}/src/bindings/java/org/simgrid/*/*.java @@ -78,10 +86,10 @@ if(DOXYGEN_PATH) COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf ${CMAKE_HOME_DIRECTORY}/doc/latex/simgrid_documentation.pdf WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/latex/ ) - add_dependencies(pdf simgrid_documentation) + add_dependencies(pdf doc) + -endif() ############################################# ### Fill in the "make sync-gforge" target ### @@ -99,7 +107,7 @@ add_custom_target(sync-gforge-doc WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}" ) -add_dependencies(sync-gforge-doc simgrid_documentation) +add_dependencies(sync-gforge-doc doc) add_custom_target(sync-gforge-dtd COMMAND ${RSYNC_CMD} src/surf/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/simgrid.dtd @@ -107,3 +115,5 @@ add_custom_target(sync-gforge-dtd WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}" ) +endif() +