← Back to branch summary

~thomas-voss/platform-api/fix-1202309

« back to all changes in this revision

Viewing changes to doc/Doxyfile.in

Add first wave of doxygen documentation and make the documentation known to the packaging setup.

Approved by PS Jenkins bot, Ricardo Salveti.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/Doxyfile.in
26
26
# identify the project. Note that if you do not use Doxywizard you need
27
27
# to put quotes around the project name if it contains spaces.
28
28
 
29
 
PROJECT_NAME           = @CMAKE_PROJECT_NAME@
 
29
PROJECT_NAME           = "Ubuntu Platform API"
30
30
 
31
31
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
32
32
# This could be handy for archiving the generated documentation or
38
38
# for a project that appears at the top of each page and should give viewer
39
39
# a quick idea about the purpose of the project. Keep the description short.
40
40
 
41
 
PROJECT_BRIEF          =
 
41
PROJECT_BRIEF          = "A library helping with tight integration into the Ubuntu platform"
42
42
 
43
43
# With the PROJECT_LOGO tag one can specify an logo or icon that is
44
44
# included in the documentation. The maximum height of the logo should not
668
668
# directories like "/usr/src/myproject". Separate the files or directories
669
669
# with spaces.
670
670
 
671
 
INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/../include
 
671
INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@ @CMAKE_CURRENT_SOURCE_DIR@/../include
672
672
 
673
673
# This tag can be used to specify the character encoding of the source files
674
674
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
728
728
# directories that contain example code fragments that are included (see
729
729
# the \include command).
730
730
 
731
 
EXAMPLE_PATH           = @CMAKE_CURRENT_SOURCE_DIR@/../examples
 
731
EXAMPLE_PATH           = @CMAKE_CURRENT_SOURCE_DIR@/../src
732
732
 
733
733
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
734
734
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
791
791
# This can be useful if you have a project on for instance GitHub and want reuse
792
792
# the introduction page also for the doxygen output.
793
793
 
794
 
USE_MDFILE_AS_MAINPAGE =
 
794
USE_MDFILE_AS_MAINPAGE = @CMAKE_CURRENT_SOURCE_DIR@/mainpage.md
795
795
 
796
796
#---------------------------------------------------------------------------
797
797
# configuration options related to source browsing
807
807
# Setting the INLINE_SOURCES tag to YES will include the body
808
808
# of functions and classes directly in the documentation.
809
809
 
810
 
INLINE_SOURCES         = YES
 
810
INLINE_SOURCES         = NO
811
811
 
812
812
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
813
813
# doxygen to hide any special comment blocks from generated source code
975
975
# documentation will contain sections that can be hidden and shown after the
976
976
# page has loaded.
977
977
 
978
 
HTML_DYNAMIC_SECTIONS  = NO
 
978
HTML_DYNAMIC_SECTIONS  = YES
979
979
 
980
980
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
981
981
# entries shown in the various tree structured indices initially; the user
1145
1145
# navigation tree you can set this option to NO if you already set
1146
1146
# GENERATE_TREEVIEW to YES.
1147
1147
 
1148
 
DISABLE_INDEX          = NO
 
1148
DISABLE_INDEX          = YES
1149
1149
 
1150
1150
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1151
1151
# structure should be generated to display hierarchical information.
1157
1157
# Since the tree basically has the same information as the tab index you
1158
1158
# could consider to set DISABLE_INDEX to NO when enabling this option.
1159
1159
 
1160
 
GENERATE_TREEVIEW      = NO
 
1160
GENERATE_TREEVIEW      = YES
1161
1161
 
1162
1162
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1163
1163
# (range [0,1..20]) that doxygen will group on one line in the generated HTML
1434
1434
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1435
1435
# generate man pages
1436
1436
 
1437
 
GENERATE_MAN           = NO
 
1437
GENERATE_MAN           = YES
1438
1438
 
1439
1439
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1440
1440
# If a relative path is entered the value of OUTPUT_DIRECTORY will be