Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix the Java compilation and linking
[simgrid.git] / buildtools / Cmake / GenerateDoc.cmake
index fb465a7..36fd526 100644 (file)
@@ -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(doc
+  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,12 +21,19 @@ if(DOXYGEN_PATH)
     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
     )
 
-  execute_process(COMMAND ${DOXYGEN_PATH}/doxygen --version OUTPUT_VARIABLE DOXYGEN_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_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
     )
 
@@ -49,34 +62,22 @@ if(DOXYGEN_PATH)
     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
     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
     )
 
-  ADD_CUSTOM_TARGET(pdf
-    COMMAND ${CMAKE_COMMAND} -E echo "XX First pass simgrid_documentation.pdf"
-    COMMAND make clean
-    COMMAND make pdf || true
-    COMMAND ${CMAKE_COMMAND} -E echo "XX Second pass simgrid_documentation.pdf"
-    COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf
-    COMMAND make pdf || true
-    COMMAND ${CMAKE_COMMAND} -E echo "XX Write Simgrid_documentation.pdf"
-    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 doc)
 
 
-endif()
+
 
 #############################################
 ### Fill in the "make sync-gforge" target ###
@@ -102,3 +103,5 @@ add_custom_target(sync-gforge-dtd
   WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}"
   )
 
+endif()
+