Doxyfile 8.82 KB
Newer Older
1
# Doxyfile 1.5.3
dickelbeck's avatar
dickelbeck committed
2 3 4 5

#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
6
DOXYFILE_ENCODING      = UTF-8
7
PROJECT_NAME           = "KiCad PCB EDA Suite"
8
PROJECT_NUMBER         =
9
OUTPUT_DIRECTORY       = Documentation/doxygen
dickelbeck's avatar
dickelbeck committed
10 11 12 13
CREATE_SUBDIRS         = NO
OUTPUT_LANGUAGE        = English
BRIEF_MEMBER_DESC      = YES
REPEAT_BRIEF           = YES
14
ABBREVIATE_BRIEF       =
dickelbeck's avatar
dickelbeck committed
15
ALWAYS_DETAILED_SEC    = NO
16
INLINE_INHERITED_MEMB  = YES
dickelbeck's avatar
dickelbeck committed
17
FULL_PATH_NAMES        = NO
18 19
STRIP_FROM_PATH        =
STRIP_FROM_INC_PATH    =
dickelbeck's avatar
dickelbeck committed
20 21
SHORT_NAMES            = NO
JAVADOC_AUTOBRIEF      = YES
22
QT_AUTOBRIEF           = NO
dickelbeck's avatar
dickelbeck committed
23 24 25 26
MULTILINE_CPP_IS_BRIEF = NO
INHERIT_DOCS           = YES
SEPARATE_MEMBER_PAGES  = NO
TAB_SIZE               = 4
27
ALIASES                =
dickelbeck's avatar
dickelbeck committed
28 29 30
OPTIMIZE_OUTPUT_FOR_C  = NO
OPTIMIZE_OUTPUT_JAVA   = NO
BUILTIN_STL_SUPPORT    = NO
31
CPP_CLI_SUPPORT        = NO
dickelbeck's avatar
dickelbeck committed
32 33 34 35 36 37
DISTRIBUTE_GROUP_DOC   = NO
SUBGROUPING            = YES
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL            = YES
38
EXTRACT_PRIVATE        = YES
dickelbeck's avatar
dickelbeck committed
39 40 41
EXTRACT_STATIC         = YES
EXTRACT_LOCAL_CLASSES  = YES
EXTRACT_LOCAL_METHODS  = NO
42
EXTRACT_ANON_NSPACES   = NO
dickelbeck's avatar
dickelbeck committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
HIDE_UNDOC_MEMBERS     = NO
HIDE_UNDOC_CLASSES     = NO
HIDE_FRIEND_COMPOUNDS  = NO
HIDE_IN_BODY_DOCS      = NO
INTERNAL_DOCS          = NO
CASE_SENSE_NAMES       = YES
HIDE_SCOPE_NAMES       = NO
SHOW_INCLUDE_FILES     = YES
INLINE_INFO            = YES
SORT_MEMBER_DOCS       = YES
SORT_BRIEF_DOCS        = NO
SORT_BY_SCOPE_NAME     = NO
GENERATE_TODOLIST      = YES
GENERATE_TESTLIST      = YES
GENERATE_BUGLIST       = YES
GENERATE_DEPRECATEDLIST= YES
59
ENABLED_SECTIONS       =
dickelbeck's avatar
dickelbeck committed
60 61
MAX_INITIALIZER_LINES  = 30
SHOW_USED_FILES        = YES
62
SHOW_DIRECTORIES       = YES
63
FILE_VERSION_FILTER    =
dickelbeck's avatar
dickelbeck committed
64 65 66 67 68 69 70 71
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
QUIET                  = NO
WARNINGS               = YES
WARN_IF_UNDOCUMENTED   = YES
WARN_IF_DOC_ERROR      = YES
WARN_NO_PARAMDOC       = NO
72
WARN_FORMAT            = "$file:$line: $text   "
73
WARN_LOGFILE           =
dickelbeck's avatar
dickelbeck committed
74 75 76 77 78
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT                  = kicad \
                         pcbnew \
79
                         cvpcb \
dickelbeck's avatar
dickelbeck committed
80 81 82 83
                         eeschema \
                         3d-viewer \
                         common \
                         gerbview \
dickelbeck's avatar
dickelbeck committed
84
                         include \
85 86
                         polygon \
                         potrace
87
INPUT_ENCODING         = UTF-8
dickelbeck's avatar
dickelbeck committed
88 89 90
FILE_PATTERNS          = *.h \
                         *.cpp
RECURSIVE              = YES
91
EXCLUDE                = include/boost polygon/kbool
dickelbeck's avatar
dickelbeck committed
92
EXCLUDE_SYMLINKS       = NO
93 94 95 96
EXCLUDE_PATTERNS       =
EXCLUDE_SYMBOLS        =
EXAMPLE_PATH           =
EXAMPLE_PATTERNS       =
dickelbeck's avatar
dickelbeck committed
97
EXAMPLE_RECURSIVE      = NO
98 99 100
IMAGE_PATH             =
INPUT_FILTER           =
FILTER_PATTERNS        =
dickelbeck's avatar
dickelbeck committed
101 102 103 104
FILTER_SOURCE_FILES    = NO
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
105 106
SOURCE_BROWSER         = YES
INLINE_SOURCES         = YES
dickelbeck's avatar
dickelbeck committed
107 108 109 110 111
STRIP_CODE_COMMENTS    = YES
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION    = YES
REFERENCES_LINK_SOURCE = YES
USE_HTAGS              = NO
112
VERBATIM_HEADERS       = YES
dickelbeck's avatar
dickelbeck committed
113 114 115
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
116
ALPHABETICAL_INDEX     = YES
dickelbeck's avatar
dickelbeck committed
117
COLS_IN_ALPHA_INDEX    = 5
118
IGNORE_PREFIX          =
dickelbeck's avatar
dickelbeck committed
119 120 121 122
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
GENERATE_HTML          = YES
123
HTML_OUTPUT            = html
dickelbeck's avatar
dickelbeck committed
124
HTML_FILE_EXTENSION    = .html
125 126 127
HTML_HEADER            =
HTML_FOOTER            =
HTML_STYLESHEET        =
dickelbeck's avatar
dickelbeck committed
128 129
HTML_ALIGN_MEMBERS     = YES
GENERATE_HTMLHELP      = NO
130
HTML_DYNAMIC_SECTIONS  = NO
131 132
CHM_FILE               =
HHC_LOCATION           =
dickelbeck's avatar
dickelbeck committed
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
GENERATE_CHI           = NO
BINARY_TOC             = NO
TOC_EXPAND             = NO
DISABLE_INDEX          = NO
ENUM_VALUES_PER_LINE   = 4
GENERATE_TREEVIEW      = YES
TREEVIEW_WIDTH         = 250
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
GENERATE_LATEX         = NO
LATEX_OUTPUT           = latex
LATEX_CMD_NAME         = latex
MAKEINDEX_CMD_NAME     = makeindex
COMPACT_LATEX          = NO
PAPER_TYPE             = a4wide
149 150
EXTRA_PACKAGES         =
LATEX_HEADER           =
dickelbeck's avatar
dickelbeck committed
151 152 153 154 155 156 157 158 159 160 161
PDF_HYPERLINKS         = NO
USE_PDFLATEX           = NO
LATEX_BATCHMODE        = NO
LATEX_HIDE_INDICES     = NO
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------
GENERATE_RTF           = NO
RTF_OUTPUT             = rtf
COMPACT_RTF            = NO
RTF_HYPERLINKS         = NO
162 163
RTF_STYLESHEET_FILE    =
RTF_EXTENSIONS_FILE    =
dickelbeck's avatar
dickelbeck committed
164 165 166 167 168 169 170 171 172 173 174 175
#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------
GENERATE_MAN           = NO
MAN_OUTPUT             = man
MAN_EXTENSION          = .3
MAN_LINKS              = NO
#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------
GENERATE_XML           = NO
XML_OUTPUT             = xml
176 177
XML_SCHEMA             =
XML_DTD                =
dickelbeck's avatar
dickelbeck committed
178 179 180 181 182 183 184 185 186 187 188
XML_PROGRAMLISTING     = YES
#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
GENERATE_AUTOGEN_DEF   = NO
#---------------------------------------------------------------------------
# configuration options related to the Perl module output
#---------------------------------------------------------------------------
GENERATE_PERLMOD       = NO
PERLMOD_LATEX          = NO
PERLMOD_PRETTY         = YES
189
PERLMOD_MAKEVAR_PREFIX =
dickelbeck's avatar
dickelbeck committed
190
#---------------------------------------------------------------------------
191
# Configuration options related to the preprocessor
dickelbeck's avatar
dickelbeck committed
192 193 194 195 196
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = NO
EXPAND_ONLY_PREDEF     = NO
SEARCH_INCLUDES        = YES
197 198 199 200
INCLUDE_PATH           = include \
                         pcbnew \
                         eeschema \
                         gerbview
dickelbeck's avatar
dickelbeck committed
201
INCLUDE_FILE_PATTERNS  = *.h
202 203
PREDEFINED             =
EXPAND_AS_DEFINED      =
dickelbeck's avatar
dickelbeck committed
204 205
SKIP_FUNCTION_MACROS   = YES
#---------------------------------------------------------------------------
206
# Configuration::additions related to external references
dickelbeck's avatar
dickelbeck committed
207
#---------------------------------------------------------------------------
208 209
TAGFILES               =
GENERATE_TAGFILE       =
dickelbeck's avatar
dickelbeck committed
210 211 212 213
ALLEXTERNALS           = NO
EXTERNAL_GROUPS        = YES
PERL_PATH              = /usr/bin/perl
#---------------------------------------------------------------------------
214
# Configuration options related to the dot tool
dickelbeck's avatar
dickelbeck committed
215 216
#---------------------------------------------------------------------------
CLASS_DIAGRAMS         = YES
217
MSCGEN_PATH            =
dickelbeck's avatar
dickelbeck committed
218 219 220 221 222 223 224 225 226 227 228 229 230 231
HIDE_UNDOC_RELATIONS   = YES
HAVE_DOT               = NO
CLASS_GRAPH            = YES
COLLABORATION_GRAPH    = YES
GROUP_GRAPHS           = YES
UML_LOOK               = NO
TEMPLATE_RELATIONS     = YES
INCLUDE_GRAPH          = YES
INCLUDED_BY_GRAPH      = YES
CALL_GRAPH             = NO
CALLER_GRAPH           = NO
GRAPHICAL_HIERARCHY    = YES
DIRECTORY_GRAPH        = YES
DOT_IMAGE_FORMAT       = png
232 233
DOT_PATH               =
DOTFILE_DIRS           =
234
DOT_GRAPH_MAX_NODES    = 50
dickelbeck's avatar
dickelbeck committed
235 236 237 238 239 240
MAX_DOT_GRAPH_DEPTH    = 0
DOT_TRANSPARENT        = NO
DOT_MULTI_TARGETS      = NO
GENERATE_LEGEND        = YES
DOT_CLEANUP            = YES
#---------------------------------------------------------------------------
241
# Configuration::additions related to the search engine
dickelbeck's avatar
dickelbeck committed
242 243
#---------------------------------------------------------------------------
SEARCHENGINE           = NO