Skip to content

Commit e16a8c0

Browse files
committed
Merge pull request #477 from xlz/api-docs
API documentation
2 parents 552644e + fee452d commit e16a8c0

14 files changed

+563
-134
lines changed

CMakeLists.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -257,10 +257,10 @@ INSTALL(FILES "${PROJECT_BINARY_DIR}/freenect2.pc" DESTINATION lib/pkgconfig/)
257257

258258
find_package(Doxygen)
259259
IF(DOXYGEN_FOUND)
260+
CONFIGURE_FILE(Doxyfile.in "${PROJECT_BINARY_DIR}/Doxyfile" @ONLY)
260261
add_custom_target(
261262
doc
262-
COMMAND "DOXYGEN_OUTPUT_DIR=${PROJECT_BINARY_DIR}/doc" ${DOXYGEN_EXECUTABLE} Doxyfile
263-
WORKING_DIRECTORY "${MY_DIR}"
263+
COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile
264264
)
265265
ENDIF()
266266

Doxyextra.css

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
@import url(https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Mono:400);
2+
3+
body, table, div, p, dl, table.directory, div.toc li, div.toc h3, div.summary, div.ingroups, .tabsearch, .directory .levels, span.mlabel {
4+
font: 400 18px/24px Lato,sans-serif;
5+
}
6+
.title, .icon, .navpath li.navelem a, #projectname, #projectbrief, #projectnumber, #powerTip div, .tabs, .tabs2, .tabs3 {
7+
font-family: Lato,sans-serif;
8+
}
9+
10+
#projectname {
11+
font-weight: bold;
12+
}
13+
14+
.icon {
15+
height: 100%;
16+
}
17+
.title {
18+
font-size: 200%;
19+
}
20+
21+
code {
22+
font: 400 16px/20px Roboto Mono,monospace;
23+
}
24+
pre.fragment, div.line, .params .paramdir {
25+
font-family: Roboto Mono,monospace;
26+
}
27+
28+
p, li {
29+
max-width: 50em;
30+
}
31+
32+
div.contents, #titlearea, div.header, div.navpath ul, .tabs, .tabs2, .tabs3 {
33+
padding-left: 5em;
34+
padding-right: 5em;
35+
}
36+

Doxyfile renamed to Doxyfile.in

Lines changed: 25 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ DOXYFILE_ENCODING = UTF-8
3232
# title of most generated pages and in a few other places.
3333
# The default value is: My Project.
3434

35-
PROJECT_NAME = "libfreenect2"
35+
PROJECT_NAME = @PROJECT_NAME@
3636

3737
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
3838
# could be handy for archiving the generated documentation or if some version
3939
# control system is used.
4040

41-
PROJECT_NUMBER =
41+
PROJECT_NUMBER = @PROJECT_VERSION@
4242

4343
# Using the PROJECT_BRIEF tag one can provide an optional one line description
4444
# for a project that appears at the top of each page and should give viewer a
@@ -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 = "$(DOXYGEN_OUTPUT_DIR)"
61+
OUTPUT_DIRECTORY = @PROJECT_BINARY_DIR@/doc
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
@@ -144,7 +144,7 @@ FULL_PATH_NAMES = YES
144144
# will be relative from the directory where doxygen is started.
145145
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
146146

147-
STRIP_FROM_PATH = .
147+
STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@
148148

149149
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
150150
# path mentioned in the documentation of a class, which tells the reader which
@@ -153,7 +153,7 @@ STRIP_FROM_PATH = .
153153
# specify the list of include paths that are normally passed to the compiler
154154
# using the -I flag.
155155

156-
STRIP_FROM_INC_PATH = .
156+
STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/include
157157

158158
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
159159
# less readable) file names. This can be useful is your file systems doesn't
@@ -169,7 +169,7 @@ SHORT_NAMES = NO
169169
# description.)
170170
# The default value is: NO.
171171

172-
JAVADOC_AUTOBRIEF = NO
172+
JAVADOC_AUTOBRIEF = YES
173173

174174
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
175175
# line (until the first dot) of a Qt-style comment as the brief description. If
@@ -404,13 +404,13 @@ EXTRACT_ALL = YES
404404
# be included in the documentation.
405405
# The default value is: NO.
406406

407-
EXTRACT_PRIVATE = YES
407+
EXTRACT_PRIVATE = NO
408408

409409
# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
410410
# scope will be included in the documentation.
411411
# The default value is: NO.
412412

413-
EXTRACT_PACKAGE = YES
413+
EXTRACT_PACKAGE = NO
414414

415415
# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
416416
# included in the documentation.
@@ -494,7 +494,7 @@ CASE_SENSE_NAMES = YES
494494
# scope will be hidden.
495495
# The default value is: NO.
496496

497-
HIDE_SCOPE_NAMES = NO
497+
HIDE_SCOPE_NAMES = YES
498498

499499
# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
500500
# the files that are included by a file in the documentation of that file.
@@ -526,7 +526,7 @@ INLINE_INFO = YES
526526
# name. If set to NO the members will appear in declaration order.
527527
# The default value is: YES.
528528

529-
SORT_MEMBER_DOCS = YES
529+
SORT_MEMBER_DOCS = NO
530530

531531
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
532532
# descriptions of file, namespace and class members alphabetically by member
@@ -546,14 +546,14 @@ SORT_BRIEF_DOCS = NO
546546
# detailed member documentation.
547547
# The default value is: NO.
548548

549-
SORT_MEMBERS_CTORS_1ST = NO
549+
SORT_MEMBERS_CTORS_1ST = YES
550550

551551
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
552552
# of group names into alphabetical order. If set to NO the group names will
553553
# appear in their defined order.
554554
# The default value is: NO.
555555

556-
SORT_GROUP_NAMES = NO
556+
SORT_GROUP_NAMES = YES
557557

558558
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
559559
# fully-qualified names, including namespaces. If set to NO, the class list will
@@ -624,7 +624,7 @@ MAX_INITIALIZER_LINES = 30
624624
# will mention the files that were used to generate the documentation.
625625
# The default value is: YES.
626626

627-
SHOW_USED_FILES = YES
627+
SHOW_USED_FILES = NO
628628

629629
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
630630
# will remove the Files entry from the Quick Index and from the Folder Tree View
@@ -638,7 +638,7 @@ SHOW_FILES = YES
638638
# Folder Tree View (if specified).
639639
# The default value is: YES.
640640

641-
SHOW_NAMESPACES = YES
641+
SHOW_NAMESPACES = NO
642642

643643
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
644644
# doxygen should invoke to get the current version for each file (typically from
@@ -743,8 +743,7 @@ WARN_LOGFILE =
743743
# spaces.
744744
# Note: If this tag is empty the current directory is searched.
745745

746-
INPUT = include \
747-
examples
746+
INPUT = @CMAKE_SOURCE_DIR@/include
748747

749748
# This tag can be used to specify the character encoding of the source files
750749
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -812,7 +811,7 @@ EXCLUDE_SYMBOLS =
812811
# that contain example code fragments that are included (see the \include
813812
# command).
814813

815-
EXAMPLE_PATH =
814+
EXAMPLE_PATH = @CMAKE_SOURCE_DIR@/examples
816815

817816
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
818817
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
@@ -893,7 +892,7 @@ USE_MDFILE_AS_MAINPAGE =
893892
# also VERBATIM_HEADERS is set to NO.
894893
# The default value is: NO.
895894

896-
SOURCE_BROWSER = YES
895+
SOURCE_BROWSER = NO
897896

898897
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
899898
# classes and enums directly into the documentation.
@@ -966,7 +965,7 @@ USE_HTAGS = NO
966965
# See also: Section \class.
967966
# The default value is: YES.
968967

969-
VERBATIM_HEADERS = YES
968+
VERBATIM_HEADERS = NO
970969

971970
#---------------------------------------------------------------------------
972971
# Configuration options related to the alphabetical class index
@@ -977,7 +976,7 @@ VERBATIM_HEADERS = YES
977976
# classes, structs, unions or interfaces.
978977
# The default value is: YES.
979978

980-
ALPHABETICAL_INDEX = YES
979+
ALPHABETICAL_INDEX = NO
981980

982981
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
983982
# which the alphabetical index list will be split.
@@ -1069,7 +1068,7 @@ HTML_STYLESHEET =
10691068
# see the documentation.
10701069
# This tag requires that the tag GENERATE_HTML is set to YES.
10711070

1072-
HTML_EXTRA_STYLESHEET =
1071+
HTML_EXTRA_STYLESHEET = @CMAKE_SOURCE_DIR@/Doxyextra.css
10731072

10741073
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
10751074
# other source files which should be copied to the HTML output directory. Note
@@ -1467,7 +1466,7 @@ MATHJAX_CODEFILE =
14671466
# The default value is: YES.
14681467
# This tag requires that the tag GENERATE_HTML is set to YES.
14691468

1470-
SEARCHENGINE = YES
1469+
SEARCHENGINE = NO
14711470

14721471
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
14731472
# implemented using a web server instead of a web client using Javascript. There
@@ -1884,15 +1883,15 @@ ENABLE_PREPROCESSING = YES
18841883
# The default value is: NO.
18851884
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
18861885

1887-
MACRO_EXPANSION = NO
1886+
MACRO_EXPANSION = YES
18881887

18891888
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
18901889
# the macro expansion is limited to the macros specified with the PREDEFINED and
18911890
# EXPAND_AS_DEFINED tags.
18921891
# The default value is: NO.
18931892
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
18941893

1895-
EXPAND_ONLY_PREDEF = NO
1894+
EXPAND_ONLY_PREDEF = YES
18961895

18971896
# If the SEARCH_INCLUDES tag is set to YES the includes files in the
18981897
# INCLUDE_PATH will be searched if a #include is found.
@@ -1906,7 +1905,7 @@ SEARCH_INCLUDES = YES
19061905
# preprocessor.
19071906
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
19081907

1909-
INCLUDE_PATH =
1908+
INCLUDE_PATH = @PROJECT_BINARY_DIR@
19101909

19111910
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
19121911
# patterns (like *.h and *.hpp) to filter out the header-files in the
@@ -1924,7 +1923,7 @@ INCLUDE_FILE_PATTERNS =
19241923
# recursively expanded use the := operator instead of the = operator.
19251924
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
19261925

1927-
PREDEFINED =
1926+
PREDEFINED = LIBFREENECT2_API
19281927

19291928
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
19301929
# tag can be used to specify a list of macro names that should be expanded. The

0 commit comments

Comments
 (0)