Doxyfile 8.88 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
MULTILINE_CPP_IS_BRIEF = NO
24
DETAILS_AT_TOP         = YES
dickelbeck's avatar
dickelbeck committed
25 26 27
INHERIT_DOCS           = YES
SEPARATE_MEMBER_PAGES  = NO
TAB_SIZE               = 4
28
ALIASES                =
dickelbeck's avatar
dickelbeck committed
29
OPTIMIZE_OUTPUT_FOR_C  = NO
30
OPTIMIZE_OUTPUT_FOR_CPP = YES
dickelbeck's avatar
dickelbeck committed
31 32
OPTIMIZE_OUTPUT_JAVA   = NO
BUILTIN_STL_SUPPORT    = NO
33
CPP_CLI_SUPPORT        = NO
dickelbeck's avatar
dickelbeck committed
34 35 36 37 38 39 40 41 42 43
DISTRIBUTE_GROUP_DOC   = NO
SUBGROUPING            = YES
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = NO
EXTRACT_STATIC         = YES
EXTRACT_LOCAL_CLASSES  = YES
EXTRACT_LOCAL_METHODS  = NO
44
EXTRACT_ANON_NSPACES   = NO
dickelbeck's avatar
dickelbeck committed
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
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
61
ENABLED_SECTIONS       =
dickelbeck's avatar
dickelbeck committed
62 63
MAX_INITIALIZER_LINES  = 30
SHOW_USED_FILES        = YES
64
SHOW_DIRECTORIES       = YES
65
FILE_VERSION_FILTER    =
dickelbeck's avatar
dickelbeck committed
66 67 68 69 70 71 72 73
#---------------------------------------------------------------------------
# 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
74
WARN_FORMAT            = "$file:$line: $text   "
75
WARN_LOGFILE           =
dickelbeck's avatar
dickelbeck committed
76 77 78 79 80
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT                  = kicad \
                         pcbnew \
81
                         cvpcb \
dickelbeck's avatar
dickelbeck committed
82 83 84 85 86
                         eeschema \
                         3d-viewer \
                         common \
                         gerbview \
                         share \
dickelbeck's avatar
dickelbeck committed
87
                         include \
88 89
                         polygon \
                         potrace
90
INPUT_ENCODING         = UTF-8
dickelbeck's avatar
dickelbeck committed
91 92 93
FILE_PATTERNS          = *.h \
                         *.cpp
RECURSIVE              = YES
94
EXCLUDE                =
dickelbeck's avatar
dickelbeck committed
95
EXCLUDE_SYMLINKS       = NO
96 97 98 99
EXCLUDE_PATTERNS       =
EXCLUDE_SYMBOLS        =
EXAMPLE_PATH           =
EXAMPLE_PATTERNS       =
dickelbeck's avatar
dickelbeck committed
100
EXAMPLE_RECURSIVE      = NO
101 102 103
IMAGE_PATH             =
INPUT_FILTER           =
FILTER_PATTERNS        =
dickelbeck's avatar
dickelbeck committed
104 105 106 107
FILTER_SOURCE_FILES    = NO
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
108 109
SOURCE_BROWSER         = YES
INLINE_SOURCES         = YES
dickelbeck's avatar
dickelbeck committed
110 111 112 113 114
STRIP_CODE_COMMENTS    = YES
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION    = YES
REFERENCES_LINK_SOURCE = YES
USE_HTAGS              = NO
115
VERBATIM_HEADERS       = YES
dickelbeck's avatar
dickelbeck committed
116 117 118
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
119
ALPHABETICAL_INDEX     = YES
dickelbeck's avatar
dickelbeck committed
120
COLS_IN_ALPHA_INDEX    = 5
121
IGNORE_PREFIX          =
dickelbeck's avatar
dickelbeck committed
122 123 124 125
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
GENERATE_HTML          = YES
126
HTML_OUTPUT            = html
dickelbeck's avatar
dickelbeck committed
127
HTML_FILE_EXTENSION    = .html
128 129 130
HTML_HEADER            =
HTML_FOOTER            =
HTML_STYLESHEET        =
dickelbeck's avatar
dickelbeck committed
131 132
HTML_ALIGN_MEMBERS     = YES
GENERATE_HTMLHELP      = NO
133
HTML_DYNAMIC_SECTIONS  = NO
134 135
CHM_FILE               =
HHC_LOCATION           =
dickelbeck's avatar
dickelbeck committed
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
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
152 153
EXTRA_PACKAGES         =
LATEX_HEADER           =
dickelbeck's avatar
dickelbeck committed
154 155 156 157 158 159 160 161 162 163 164
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
165 166
RTF_STYLESHEET_FILE    =
RTF_EXTENSIONS_FILE    =
dickelbeck's avatar
dickelbeck committed
167 168 169 170 171 172 173 174 175 176 177 178
#---------------------------------------------------------------------------
# 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
179 180
XML_SCHEMA             =
XML_DTD                =
dickelbeck's avatar
dickelbeck committed
181 182 183 184 185 186 187 188 189 190 191
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
192
PERLMOD_MAKEVAR_PREFIX =
dickelbeck's avatar
dickelbeck committed
193
#---------------------------------------------------------------------------
194
# Configuration options related to the preprocessor
dickelbeck's avatar
dickelbeck committed
195 196 197 198 199
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = NO
EXPAND_ONLY_PREDEF     = NO
SEARCH_INCLUDES        = YES
200 201 202 203
INCLUDE_PATH           = include \
                         pcbnew \
                         eeschema \
                         gerbview
dickelbeck's avatar
dickelbeck committed
204
INCLUDE_FILE_PATTERNS  = *.h
205 206
PREDEFINED             =
EXPAND_AS_DEFINED      =
dickelbeck's avatar
dickelbeck committed
207 208
SKIP_FUNCTION_MACROS   = YES
#---------------------------------------------------------------------------
209
# Configuration::additions related to external references
dickelbeck's avatar
dickelbeck committed
210
#---------------------------------------------------------------------------
211 212
TAGFILES               =
GENERATE_TAGFILE       =
dickelbeck's avatar
dickelbeck committed
213 214 215 216
ALLEXTERNALS           = NO
EXTERNAL_GROUPS        = YES
PERL_PATH              = /usr/bin/perl
#---------------------------------------------------------------------------
217
# Configuration options related to the dot tool
dickelbeck's avatar
dickelbeck committed
218 219
#---------------------------------------------------------------------------
CLASS_DIAGRAMS         = YES
220
MSCGEN_PATH            =
dickelbeck's avatar
dickelbeck committed
221 222 223 224 225 226 227 228 229 230 231 232 233 234
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
235 236
DOT_PATH               =
DOTFILE_DIRS           =
237
DOT_GRAPH_MAX_NODES    = 50
dickelbeck's avatar
dickelbeck committed
238 239 240 241 242 243
MAX_DOT_GRAPH_DEPTH    = 0
DOT_TRANSPARENT        = NO
DOT_MULTI_TARGETS      = NO
GENERATE_LEGEND        = YES
DOT_CLEANUP            = YES
#---------------------------------------------------------------------------
244
# Configuration::additions related to the search engine
dickelbeck's avatar
dickelbeck committed
245 246
#---------------------------------------------------------------------------
SEARCHENGINE           = NO