Skip to content

Commit 04bfe83

Browse files
committed
Add doxygen configuration and target to cmake
After generating the Makefile, documentation is generated by issueing "make doc", and ends up in the "doc" sub-directory in the build directory.
1 parent b8aaef1 commit 04bfe83

File tree

2 files changed

+13
-16
lines changed

2 files changed

+13
-16
lines changed

CMakeLists.txt

+9
Original file line numberDiff line numberDiff line change
@@ -231,6 +231,15 @@ INSTALL(FILES "${PROJECT_BINARY_DIR}/libfreenect2_export.h" DESTINATION include/
231231
INSTALL(FILES "${PROJECT_BINARY_DIR}/freenect2Config.cmake" DESTINATION lib/cmake/freenect2/)
232232
INSTALL(FILES "${PROJECT_BINARY_DIR}/freenect2.pc" DESTINATION lib/pkgconfig/)
233233

234+
find_package(Doxygen)
235+
IF(DOXYGEN_FOUND)
236+
add_custom_target(
237+
doc
238+
COMMAND "DOXYGEN_OUTPUT_DIR=${PROJECT_BINARY_DIR}/doc" ${DOXYGEN_EXECUTABLE} Doxyfile
239+
WORKING_DIRECTORY "${MY_DIR}"
240+
)
241+
ENDIF()
242+
234243
IF(BUILD_EXAMPLES)
235244
MESSAGE(STATUS "Configurating examples")
236245
ADD_SUBDIRECTORY(${MY_DIR}/examples)

Doxyfile

+4-16
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ PROJECT_LOGO =
5858
# entered, it will be relative to the location where doxygen was started. If
5959
# left blank the current directory will be used.
6060

61-
OUTPUT_DIRECTORY = doc
61+
OUTPUT_DIRECTORY = "$(DOXYGEN_OUTPUT_DIR)"
6262

6363
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
6464
# directories (in 2 levels) under the output directory of each output format and
@@ -731,7 +731,7 @@ WARN_FORMAT = "$file:$line: $text"
731731
# messages should be written. If left blank the output is written to standard
732732
# error (stderr).
733733

734-
WARN_LOGFILE = DoxyWarnings.txt
734+
WARN_LOGFILE =
735735

736736
#---------------------------------------------------------------------------
737737
# Configuration options related to the input files
@@ -795,7 +795,7 @@ EXCLUDE_SYMLINKS = NO
795795
# Note that the wildcards are matched against the file with absolute path, so to
796796
# exclude all test directories for example use the pattern */test/*
797797

798-
EXCLUDE_PATTERNS =
798+
EXCLUDE_PATTERNS = */include/internal/*
799799

800800
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
801801
# (namespaces, classes, functions, etc.) that should be excluded from the
@@ -1790,18 +1790,6 @@ GENERATE_XML = NO
17901790

17911791
XML_OUTPUT = xml
17921792

1793-
# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
1794-
# validating XML parser to check the syntax of the XML files.
1795-
# This tag requires that the tag GENERATE_XML is set to YES.
1796-
1797-
XML_SCHEMA =
1798-
1799-
# The XML_DTD tag can be used to specify a XML DTD, which can be used by a
1800-
# validating XML parser to check the syntax of the XML files.
1801-
# This tag requires that the tag GENERATE_XML is set to YES.
1802-
1803-
XML_DTD =
1804-
18051793
# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
18061794
# listings (including syntax highlighting and cross-referencing information) to
18071795
# the XML output. Note that enabling this will significantly increase the size
@@ -2050,7 +2038,7 @@ HIDE_UNDOC_RELATIONS = NO
20502038
# set to NO
20512039
# The default value is: NO.
20522040

2053-
HAVE_DOT = YES
2041+
HAVE_DOT = NO
20542042

20552043
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
20562044
# to run in parallel. When set to 0 doxygen will base this on the number of

0 commit comments

Comments
 (0)