Skip to content

Commit

Permalink
Clean ups to doc generation
Browse files Browse the repository at this point in the history 
 - 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
  • Loading branch information
timlinux committed Mar 26, 2008
1 parent e342450 commit 18e73aa
Showing 1 changed file with 28 additions and 9 deletions.
37 changes: 28 additions & 9 deletions Doxyfile
View file
Expand Up @@ -30,7 +30,7 @@ PROJECT_NUMBER = HEAD
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.

OUTPUT_DIRECTORY = qgis_api_doc
OUTPUT_DIRECTORY = api_doc

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

ABBREVIATE_BRIEF =
ABBREVIATE_BRIEF = "The $name class" \
"The $name widget" \
"The $name file" \
is \
provides \
specifies \
contains \
represents \
a \
an \
the

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

DETAILS_AT_TOP = NO
DETAILS_AT_TOP = YES

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

TAB_SIZE = 8
TAB_SIZE = 2

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

EXTRACT_PRIVATE = YES
EXTRACT_PRIVATE = NO

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

EXTRACT_STATIC = NO
EXTRACT_STATIC = YES

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

INPUT = ./src
INPUT = src \
tests

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

FILE_PATTERNS =
FILE_PATTERNS = *.h \
*.cpp \
src/core/spatialindex/* \
src/core/spatialindex/storagemanager/*.** \
*.dox

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

EXCLUDE_PATTERNS =
EXCLUDE_PATTERNS = moc_* \
ui_* \
qrc_* \
src/core/sqlite/*


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

0 comments on commit 18e73aa

Please sign in to comment.