Clarify Doxyfile INPUT value generation

This commit is contained in:
Camilla Löwy 2019-05-20 19:02:08 +02:00
parent 84ec99bb01
commit e1d9e2ba73
2 changed files with 23 additions and 20 deletions

View File

@ -1,24 +1,27 @@
set(glfw_DOCS_SOURCES # NOTE: The order of this list determines the order of items in the Guides
"${GLFW_SOURCE_DIR}/include/GLFW/glfw3.h" # (i.e. Pages) list in the generated documentation
"${GLFW_SOURCE_DIR}/include/GLFW/glfw3native.h" set(GLFW_DOXYGEN_SOURCES
"${GLFW_SOURCE_DIR}/docs/main.dox" "include/GLFW/glfw3.h"
"${GLFW_SOURCE_DIR}/docs/news.dox" "include/GLFW/glfw3native.h"
"${GLFW_SOURCE_DIR}/docs/quick.dox" "docs/main.dox"
"${GLFW_SOURCE_DIR}/docs/moving.dox" "docs/news.dox"
"${GLFW_SOURCE_DIR}/docs/compile.dox" "docs/quick.dox"
"${GLFW_SOURCE_DIR}/docs/build.dox" "docs/moving.dox"
"${GLFW_SOURCE_DIR}/docs/intro.dox" "docs/compile.dox"
"${GLFW_SOURCE_DIR}/docs/context.dox" "docs/build.dox"
"${GLFW_SOURCE_DIR}/docs/monitor.dox" "docs/intro.dox"
"${GLFW_SOURCE_DIR}/docs/window.dox" "docs/context.dox"
"${GLFW_SOURCE_DIR}/docs/input.dox" "docs/monitor.dox"
"${GLFW_SOURCE_DIR}/docs/vulkan.dox" "docs/window.dox"
"${GLFW_SOURCE_DIR}/docs/compat.dox" "docs/input.dox"
"${GLFW_SOURCE_DIR}/docs/internal.dox") "docs/vulkan.dox"
"docs/compat.dox"
"docs/internal.dox")
foreach(arg ${glfw_DOCS_SOURCES}) # Format the source list into a Doxyfile INPUT value that Doxygen can parse
set(GLFW_DOCS_SOURCES "${GLFW_DOCS_SOURCES} \\\n\"${arg}\"") foreach(path IN LISTS GLFW_DOXYGEN_SOURCES)
set(GLFW_DOXYGEN_INPUT "${GLFW_DOXYGEN_INPUT} \\\n\"${GLFW_SOURCE_DIR}/${path}\"")
endforeach() endforeach()
configure_file(Doxyfile.in Doxyfile @ONLY) configure_file(Doxyfile.in Doxyfile @ONLY)

View File

@ -662,7 +662,7 @@ WARN_LOGFILE = "@GLFW_BINARY_DIR@/docs/warnings.txt"
# directories like "/usr/src/myproject". Separate the files or directories # directories like "/usr/src/myproject". Separate the files or directories
# with spaces. # with spaces.
INPUT = @GLFW_DOCS_SOURCES@ INPUT = @GLFW_DOXYGEN_INPUT@
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is