Skip to content

Commit 18e73aa

Browse files
author
timlinux
committedMar 26, 2008
Clean ups to doc generation
- filter out non useful / generated / copied in sources - various other small tweaks to formatting git-svn-id: http://svn.osgeo.org/qgis/trunk/qgis@8276 c8812cc2-4d05-0410-92ff-de0c093fc19c

File tree

1 file changed

+28
-9
lines changed

1 file changed

+28
-9
lines changed
 

‎Doxyfile

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ PROJECT_NUMBER = HEAD
3030
# If a relative path is entered, it will be relative to the location
3131
# where doxygen was started. If left blank the current directory will be used.
3232

33-
OUTPUT_DIRECTORY = qgis_api_doc
33+
OUTPUT_DIRECTORY = api_doc
3434

3535
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
3636
# 4096 sub-directories (in 2 levels) under the output directory of each output
@@ -87,7 +87,17 @@ REPEAT_BRIEF = YES
8787
# "The $name file" "is" "provides" "specifies" "contains"
8888
# "represents" "a" "an" "the"
8989

90-
ABBREVIATE_BRIEF =
90+
ABBREVIATE_BRIEF = "The $name class" \
91+
"The $name widget" \
92+
"The $name file" \
93+
is \
94+
provides \
95+
specifies \
96+
contains \
97+
represents \
98+
a \
99+
an \
100+
the
91101

92102
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
93103
# Doxygen will generate a detailed section even if there is only a brief
@@ -153,7 +163,7 @@ MULTILINE_CPP_IS_BRIEF = NO
153163
# If set to NO, the detailed description appears after the member
154164
# documentation.
155165

156-
DETAILS_AT_TOP = NO
166+
DETAILS_AT_TOP = YES
157167

158168
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
159169
# member inherits the documentation from any documented member that it
@@ -170,7 +180,7 @@ SEPARATE_MEMBER_PAGES = NO
170180
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
171181
# Doxygen uses this value to replace tabs by spaces in code fragments.
172182

173-
TAB_SIZE = 8
183+
TAB_SIZE = 2
174184

175185
# This tag can be used to specify a number of aliases that acts
176186
# as commands in the documentation. An alias has the form "name=value".
@@ -233,12 +243,12 @@ EXTRACT_ALL = YES
233243
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
234244
# will be included in the documentation.
235245

236-
EXTRACT_PRIVATE = YES
246+
EXTRACT_PRIVATE = NO
237247

238248
# If the EXTRACT_STATIC tag is set to YES all static members of a file
239249
# will be included in the documentation.
240250

241-
EXTRACT_STATIC = NO
251+
EXTRACT_STATIC = YES
242252

243253
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
244254
# defined locally in source files will be included in the documentation.
@@ -459,7 +469,8 @@ WARN_LOGFILE =
459469
# directories like "/usr/src/myproject". Separate the files or directories
460470
# with spaces.
461471

462-
INPUT = ./src
472+
INPUT = src \
473+
tests
463474

464475
# If the value of the INPUT tag contains directories, you can use the
465476
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
@@ -468,7 +479,11 @@ INPUT = ./src
468479
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
469480
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
470481

471-
FILE_PATTERNS =
482+
FILE_PATTERNS = *.h \
483+
*.cpp \
484+
src/core/spatialindex/* \
485+
src/core/spatialindex/storagemanager/*.** \
486+
*.dox
472487

473488
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
474489
# should be searched for input files as well. Possible values are YES and NO.
@@ -494,7 +509,11 @@ EXCLUDE_SYMLINKS = NO
494509
# against the file with absolute path, so to exclude all test directories
495510
# for example use the pattern */test/*
496511

497-
EXCLUDE_PATTERNS =
512+
EXCLUDE_PATTERNS = moc_* \
513+
ui_* \
514+
qrc_* \
515+
src/core/sqlite/*
516+
498517

499518
# The EXAMPLE_PATH tag can be used to specify one or more files or
500519
# directories that contain example code fragments that are included (see

0 commit comments

Comments
 (0)
Please sign in to comment.