Skip to content
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

Added an option to include auto generated code in the ign_create_docs function #108

Merged
merged 1 commit into from
Aug 13, 2020
Merged

Added an option to include auto generated code in the ign_create_docs function #108

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
9 changes: 6 additions & 3 deletions cmake/IgnCreateDocs.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,15 @@
#################################################
# ign_create_docs(
# [API_MAINPAGE_MD <api_markdown_mainpage>]
# [AUTOGENERATED_DOC <generated doc dir>]
# [TUTORIALS_MAINPAGE_MD <tutorials_markdown_mainpage>]
# [TAGFILES <tagfile_list>])
#
# This function will configure doxygen templates and install them.
#
# API_MAINPAGE_MD: Optional. Specify a Markdown page to use as the main page
# for API documentation.
# AUTOGENERATED_DOC: Optional. Directory with the generated code.
# TUTORIALS_MAINPAGE_MD: Optional. Specify a Markdown page to use as the
# main page for tutorial documentation.
# TAGFILES: Optional. Specify tagfiles for doxygen to use. It should be a list of strings like:
Expand All @@ -40,7 +42,7 @@ function(ign_create_docs)
#------------------------------------
# Define the expected arguments
set(options)
set(oneValueArgs API_MAINPAGE_MD TUTORIALS_MAINPAGE_MD)
set(oneValueArgs API_MAINPAGE_MD AUTOGENERATED_DOC TUTORIALS_MAINPAGE_MD)
set(multiValueArgs "TAGFILES")

#------------------------------------
Expand Down Expand Up @@ -107,6 +109,7 @@ function(ign_create_docs)
ign_add_manpage_target()

set(IGNITION_DOXYGEN_API_MAINPAGE_MD ${ign_create_docs_API_MAINPAGE_MD})
set(IGNITION_DOXYGEN_AUTOGENERATED_DOC ${ign_create_docs_AUTOGENERATED_DOC})
set(IGNITION_DOXYGEN_TUTORIALS_MAINPAGE_MD
${ign_create_docs_TUTORIALS_MAINPAGE_MD})

Expand Down Expand Up @@ -134,7 +137,7 @@ function(ign_create_docs)
# about the spaces between input files/directories. If you put each cmake
# variable on a separate line to make this `set` command more readable,
# then doxygen will not generate the correct/complete output.
set(IGNITION_DOXYGEN_INPUT "${IGNITION_DOXYGEN_API_MAINPAGE_MD} ${IGNITION_DOXYGEN_TUTORIALS_DIR} ${IGNITION_DOXYGEN_TUTORIALS_MAINPAGE_MD} ${ign_doxygen_component_input_dirs}")
set(IGNITION_DOXYGEN_INPUT "${IGNITION_DOXYGEN_API_MAINPAGE_MD} ${IGNITION_DOXYGEN_AUTOGENERATED_DOC} ${IGNITION_DOXYGEN_TUTORIALS_DIR} ${IGNITION_DOXYGEN_TUTORIALS_MAINPAGE_MD} ${ign_doxygen_component_input_dirs}")
configure_file(${IGNITION_CMAKE_DOXYGEN_DIR}/api.in
${CMAKE_BINARY_DIR}/api.dox @ONLY)

Expand All @@ -148,7 +151,7 @@ function(ign_create_docs)
set(IGNITION_DOXYGEN_GENHTML "NO")
set(IGNITION_DOXYGEN_GENTAGFILE
"${CMAKE_BINARY_DIR}/${PROJECT_NAME_LOWER}.tag.xml")
set(IGNITION_DOXYGEN_INPUT "${ign_doxygen_component_input_dirs}")
set(IGNITION_DOXYGEN_INPUT "${ign_doxygen_component_input_dirs} ${IGNITION_DOXYGEN_AUTOGENERATED_DOC}")
configure_file(${IGNITION_CMAKE_DOXYGEN_DIR}/api.in
${CMAKE_BINARY_DIR}/api_tagfile.dox @ONLY)

Expand Down