Преглед на файлове

Move to Doxygen 1.9.8 and later

Camilla Löwy преди 1 година
родител
ревизия
e3e41ba339
променени са 3 файла, в които са добавени 25 реда и са изтрити 24 реда
  1. 1 11
      CMakeLists.txt
  2. 23 12
      docs/CMakeLists.txt
  3. 1 1
      docs/DoxygenLayout.xml

+ 1 - 11
CMakeLists.txt

@@ -59,11 +59,6 @@ list(APPEND CMAKE_MODULE_PATH "${GLFW_SOURCE_DIR}/CMake/modules")
 
 find_package(Threads REQUIRED)
 
-if (GLFW_BUILD_DOCS)
-    set(DOXYGEN_SKIP_DOT TRUE)
-    find_package(Doxygen)
-endif()
-
 #--------------------------------------------------------------------
 # Report backend selection
 #--------------------------------------------------------------------
@@ -134,7 +129,7 @@ if (GLFW_BUILD_TESTS)
     add_subdirectory(tests)
 endif()
 
-if (DOXYGEN_FOUND AND GLFW_BUILD_DOCS)
+if (GLFW_BUILD_DOCS)
     add_subdirectory(docs)
 endif()
 
@@ -156,11 +151,6 @@ if (GLFW_INSTALL)
     install(FILES "${GLFW_BINARY_DIR}/src/glfw3.pc"
             DESTINATION "${CMAKE_INSTALL_LIBDIR}/pkgconfig")
 
-    if (DOXYGEN_FOUND AND GLFW_BUILD_DOCS)
-        install(DIRECTORY "${GLFW_BINARY_DIR}/docs/html"
-                DESTINATION "${CMAKE_INSTALL_DOCDIR}")
-    endif()
-
     # Only generate this target if no higher-level project already has
     if (NOT TARGET uninstall)
         configure_file(CMake/cmake_uninstall.cmake.in

+ 23 - 12
docs/CMakeLists.txt

@@ -31,16 +31,27 @@ foreach(file IN LISTS source_files)
     string(APPEND GLFW_DOXYGEN_INPUT " \\\n\"${CMAKE_CURRENT_SOURCE_DIR}/${file}\"")
 endforeach()
 
-configure_file(Doxyfile.in Doxyfile @ONLY)
-
-add_custom_command(OUTPUT "html/index.html"
-                   COMMAND "${DOXYGEN_EXECUTABLE}"
-                   WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
-                   MAIN_DEPENDENCY Doxyfile
-                   DEPENDS ${header_paths} ${source_files} ${extra_files}
-                   COMMENT "Generating HTML documentation"
-                   VERBATIM)
-
-add_custom_target(docs ALL SOURCES "html/index.html")
-set_target_properties(docs PROPERTIES FOLDER "GLFW3")
+set(DOXYGEN_SKIP_DOT TRUE)
+find_package(Doxygen)
+
+if (NOT DOXYGEN_FOUND OR DOXYGEN_VERSION VERSION_LESS "1.9.8")
+    message(STATUS "Documentation generation requires Doxygen 1.9.8 or later")
+else()
+    configure_file(Doxyfile.in Doxyfile @ONLY)
+    add_custom_command(OUTPUT "html/index.html"
+                       COMMAND "${DOXYGEN_EXECUTABLE}"
+                       WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
+                       MAIN_DEPENDENCY Doxyfile
+                       DEPENDS ${header_paths} ${source_files} ${extra_files}
+                       COMMENT "Generating HTML documentation"
+                       VERBATIM)
+
+    add_custom_target(docs ALL SOURCES "html/index.html")
+    set_target_properties(docs PROPERTIES FOLDER "GLFW3")
+
+    if (GLFW_INSTALL)
+        install(DIRECTORY "${GLFW_BINARY_DIR}/docs/html"
+                DESTINATION "${CMAKE_INSTALL_DOCDIR}")
+    endif()
+endif()
 

+ 1 - 1
docs/DoxygenLayout.xml

@@ -5,7 +5,7 @@
     <tab type="mainpage" visible="yes" title="Introduction"/>
     <tab type="user" url="quick_guide.html" title="Tutorial"/>
     <tab type="pages" visible="yes" title="Guides" intro=""/>
-    <tab type="modules" visible="yes" title="Reference" intro=""/>
+    <tab type="topics" visible="yes" title="Reference" intro=""/>
     <tab type="filelist" visible="yes" title="Files"/>
   </navindex>