Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
pugs
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
code
pugs
Commits
0a259f7e
Commit
0a259f7e
authored
4 years ago
by
Stéphane Del Pino
Browse files
Options
Downloads
Plain Diff
Merge branch 'feature/doxygen' into 'develop'
Add Doxygen generation using CMake Closes
#12
See merge request
!40
parents
722dd68e
13914155
No related branches found
No related tags found
1 merge request
!40
Add Doxygen generation using CMake
Changes
3
Expand all
Show whitespace changes
Inline
Side-by-side
Showing
3 changed files
CMakeLists.txt
+3
-0
3 additions, 0 deletions
CMakeLists.txt
cmake/PugsDoxygen.cmake
+31
-0
31 additions, 0 deletions
cmake/PugsDoxygen.cmake
doc/Doxyfile.in
+2579
-0
2579 additions, 0 deletions
doc/Doxyfile.in
with
2613 additions
and
0 deletions
CMakeLists.txt
+
3
−
0
View file @
0a259f7e
...
...
@@ -436,6 +436,9 @@ target_link_libraries(
${
PUGS_STD_LINK_FLAGS
}
)
# ---------------------- Doxygen ----------------------
include
(
PugsDoxygen
)
# ------------------- Installation --------------------
# temporary version workaround
if
(
${
CMAKE_VERSION
}
VERSION_LESS
"3.13.0"
)
...
...
This diff is collapsed.
Click to expand it.
cmake/PugsDoxygen.cmake
0 → 100644
+
31
−
0
View file @
0a259f7e
# ---------------------- Doxygen ----------------------
# check for Doxygen and eventually configure it
# define the option
option
(
BUILD_DOXYGEN_DOC
"Build Doxygen documentation"
ON
)
# this is very much inspired by https://vicrucann.github.io/tutorials/quick-cmake-doxygen/
# check if Doxygen is installed
find_package
(
Doxygen
)
if
(
DOXYGEN_FOUND
)
# set input and output files
set
(
DOXYGEN_IN
"
${
PUGS_SOURCE_DIR
}
/doc/Doxyfile.in"
)
set
(
DOXYGEN_OUT
"
${
PUGS_BINARY_DIR
}
/Doxyfile"
)
# request to configure the file
configure_file
(
${
DOXYGEN_IN
}
${
DOXYGEN_OUT
}
@ONLY
)
message
(
STATUS
"Configuring Doxygen"
)
# note the option ALL which allows to build the docs together with the application
add_custom_target
(
doxygen
COMMAND
${
DOXYGEN_EXECUTABLE
}
${
DOXYGEN_OUT
}
WORKING_DIRECTORY
${
CMAKE_CURRENT_BINARY_DIR
}
COMMENT
"Generating API documentation with Doxygen"
VERBATIM
)
# building doc builds doxygen
add_custom_target
(
doc doxygen
)
else
(
DOXYGEN_FOUND
)
message
(
"Doxygen need to be installed to generate the doxygen documentation"
)
endif
(
DOXYGEN_FOUND
)
This diff is collapsed.
Click to expand it.
doc/Doxyfile.in
0 → 100644
+
2579
−
0
View file @
0a259f7e
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment