Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
D
dune-common
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
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
Timo Koch
dune-common
Commits
71250e7f
Commit
71250e7f
authored
13 years ago
by
Markus Blatt
Browse files
Options
Downloads
Patches
Plain Diff
Rudimentarily build the doxygen documentation.
[[Imported from SVN: r6623]]
parent
a6153abf
Branches
Branches containing commit
Tags
Tags containing commit
No related merge requests found
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
cmake/modules/DUNEDoxygen.cmake
+15
-5
15 additions, 5 deletions
cmake/modules/DUNEDoxygen.cmake
cmake/scripts/CreateDoxyFile.cmake
+4
-0
4 additions, 0 deletions
cmake/scripts/CreateDoxyFile.cmake
doc/doxygen/CMakeLists.txt
+1
-2
1 addition, 2 deletions
doc/doxygen/CMakeLists.txt
with
20 additions
and
7 deletions
cmake/modules/DUNEDoxygen.cmake
+
15
−
5
View file @
71250e7f
FIND_PACKAGE
(
Doxygen
)
#
# Set DOT_TRUE for the Doxyfile generation.
#
if
(
NOT DOXYGEN_DOT_FOUND
)
set
(
DOT_TRUE '\
#')
endif
(
NOT DOXYGEN_DOT_FOUND
)
message
(
'
${
DOT_TRUE
}
'
)
#
# prepare_doyfile()
# prepare_do
x
yfile()
# This functions adds the necessary routines for the generation of the Doxyfile[.in] files needed to doxygen.
FUNCTION
(
prepare_doxyfile
)
set
(
make_doxyfile_command
${
CMAKE_COMMAND
}
-D DUNE_MOD_NAME=
${
DUNE_MOD_NAME
}
-D DUNE_MOD_VERSION=
${
DUNE_MOD_VERSION
}
-D DOXYSTYLE=
${
CMAKE_CURRENT_SOURCE_DIR
}
/Doxystyle -D DOXYLOCAL=
${
CMAKE_CURRENT_SOURCE_DIR
}
/Doxylocal -D abs_top_srcdir=
${
CMAKE_SOURCE_DIR
}
-D srcdir=
${
CMAKE_CURRENT_SOURCE_DIR
}
-P
${
CMAKE_SOURCE_DIR
}
/cmake/scripts/CreateDoxyFile.cmake
)
MACRO
(
prepare_doxyfile
)
set
(
make_doxyfile_command
${
CMAKE_COMMAND
}
-D
DOT_TRUE=
${
DOT_TRUE
}
-D DUNEWEB_TRUE=\
# -D
DUNE_MOD_NAME=${DUNE_MOD_NAME} -D DUNE_MOD_VERSION=${DUNE_MOD_VERSION} -D DOXYSTYLE=${CMAKE_CURRENT_SOURCE_DIR}/Doxystyle -D DOXYLOCAL=${CMAKE_CURRENT_SOURCE_DIR}/Doxylocal -D abs_top_srcdir=${CMAKE_SOURCE_DIR} -D srcdir=${CMAKE_CURRENT_SOURCE_DIR}
-D top_srcdir=${CMAKE_SOURCE_DIR}
-P ${CMAKE_SOURCE_DIR}/cmake/scripts/CreateDoxyFile.cmake)
add_custom_command
(
OUTPUT Doxyfile.in Doxyfile
COMMAND
${
make_doxyfile_command
}
COMMENT
"Creating Doxyfile.in"
)
add_custom_target
(
Doxyfile DEPENDS Doxyfile.in Doxyfile
)
ENDFUNCTION
(
prepare_doxyfile
)
ENDMACRO
(
prepare_doxyfile
)
MACRO
(
add_doxygen_target
)
prepare_doxyfile
()
add_custom_target
(
doxygen COMMAND
${
DOXYGEN_EXECUTABLE
}
Doxyfile
COMMENT
"Running doxygen documentation"
DEPENDS Doxyfile
)
add_dependencies
(
doc doxygen
)
ENDMACRO
(
add_doxygen_target
)
This diff is collapsed.
Click to expand it.
cmake/scripts/CreateDoxyFile.cmake
+
4
−
0
View file @
71250e7f
...
...
@@ -5,6 +5,10 @@ FILE(WRITE Doxyfile.in ${file_contents})
FILE
(
READ
${
DOXYLOCAL
}
file_contents
)
FILE
(
APPEND Doxyfile.in
${
file_contents
}
)
message
(
"Generating Doxyfile"
)
# configure_file does not work as it insists an existing input file, which in our
# needs to be generated first.
# Therfore we read the Doxyfile.in and replace the variables using STRING(CONFIGURE)
# and the write the file.
FILE
(
READ Doxyfile.in file_contents
)
STRING
(
CONFIGURE
${
file_contents
}
output
)
FILE
(
WRITE Doxyfile
${
output
}
)
This diff is collapsed.
Click to expand it.
doc/doxygen/CMakeLists.txt
+
1
−
2
View file @
71250e7f
# quickhack for creating the Doxyfile.in and Doxyfile
include
(
DUNEDoxygen
)
prepare_doxyfile
()
add_dependencies
(
doc Doxyfile
)
add_doxygen_target
()
install
(
FILES Doxystyle DESTINATION share/dune-common/doc/doxygen
)
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