Skip to content

Add opt-in standalone Doxygen XML documentation target #97

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jdumas wants to merge 1 commit into from
Closed

Add opt-in standalone Doxygen XML documentation target #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/cpp/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,23 @@ add_custom_target(doc
COMMENT "Generating docs")

add_dependencies(doc doxygen-awesome)

option(LAGRANGE_DOCS_XML "Enable the standalone Doxygen XML target" OFF)
if(LAGRANGE_DOCS_XML)
set(DOXYGEN_OUTPUT_XML xml CACHE STRING "Output subdir for doxygen XML")
set(DOXYGEN_XML_PROGRAMLISTING NO CACHE STRING "Include source listings in doxygen XML (YES or NO)")
get_filename_component(DOXYGEN_XML_SOURCE_ROOT "${DOXYGEN_WORKING_DIR}" ABSOLUTE)

# Reuse the HTML extraction settings without depending on its theme/download.
configure_file(
"${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.xml.in"
"${CMAKE_CURRENT_BINARY_DIR}/Doxyfile.xml"
@ONLY
)
add_custom_target(doc-xml
COMMAND "${DOXYGEN_EXECUTABLE}" "${CMAKE_CURRENT_BINARY_DIR}/Doxyfile.xml"
WORKING_DIRECTORY "${DOXYGEN_WORKING_DIR}"
COMMENT "Generating Doxygen XML"
VERBATIM
)
endif()
12 changes: 12 additions & 0 deletions docs/cpp/Doxyfile.xml.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Reuse the complete module/source configuration, including module Markdown.
@INCLUDE = "@DOXYFILE_OUT@"
# Keep exported source locations independent of the build machine.
STRIP_FROM_PATH += "@DOXYGEN_XML_SOURCE_ROOT@"
STRIP_FROM_INC_PATH += "@DOXYGEN_XML_SOURCE_ROOT@"
GENERATE_HTML = NO
GENERATE_LATEX = NO
GENERATE_RTF = NO
GENERATE_MAN = NO
GENERATE_XML = YES
XML_OUTPUT = "@DOXYGEN_OUTPUT_XML@"
XML_PROGRAMLISTING = @DOXYGEN_XML_PROGRAMLISTING@
Loading