2008-03-04 14:27:48 +00:00
|
|
|
# Doxyfile 1.5.3
|
2007-10-31 14:12:14 +00:00
|
|
|
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
|
# Project related configuration options
|
|
|
|
|
#---------------------------------------------------------------------------
|
2008-03-04 14:27:48 +00:00
|
|
|
DOXYFILE_ENCODING = UTF-8
|
2009-10-27 13:48:24 +00:00
|
|
|
PROJECT_NAME = KiCad PCB EDA Suite
|
2007-10-31 14:12:14 +00:00
|
|
|
PROJECT_NUMBER =
|
2009-10-27 13:48:24 +00:00
|
|
|
OUTPUT_DIRECTORY = Documentation/doxygen
|
2007-10-31 14:12:14 +00:00
|
|
|
CREATE_SUBDIRS = NO
|
|
|
|
|
OUTPUT_LANGUAGE = English
|
|
|
|
|
BRIEF_MEMBER_DESC = YES
|
|
|
|
|
REPEAT_BRIEF = YES
|
|
|
|
|
ABBREVIATE_BRIEF =
|
|
|
|
|
ALWAYS_DETAILED_SEC = NO
|
2008-03-04 14:27:48 +00:00
|
|
|
INLINE_INHERITED_MEMB = YES
|
2007-10-31 14:12:14 +00:00
|
|
|
FULL_PATH_NAMES = NO
|
|
|
|
|
STRIP_FROM_PATH =
|
|
|
|
|
STRIP_FROM_INC_PATH =
|
|
|
|
|
SHORT_NAMES = NO
|
|
|
|
|
JAVADOC_AUTOBRIEF = YES
|
2008-03-04 14:27:48 +00:00
|
|
|
QT_AUTOBRIEF = NO
|
2007-10-31 14:12:14 +00:00
|
|
|
MULTILINE_CPP_IS_BRIEF = NO
|
2008-03-04 14:27:48 +00:00
|
|
|
DETAILS_AT_TOP = YES
|
2007-10-31 14:12:14 +00:00
|
|
|
INHERIT_DOCS = YES
|
|
|
|
|
SEPARATE_MEMBER_PAGES = NO
|
|
|
|
|
TAB_SIZE = 4
|
|
|
|
|
ALIASES =
|
|
|
|
|
OPTIMIZE_OUTPUT_FOR_C = NO
|
2008-12-29 11:52:15 +00:00
|
|
|
OPTIMIZE_OUTPUT_FOR_CPP = YES
|
2007-10-31 14:12:14 +00:00
|
|
|
OPTIMIZE_OUTPUT_JAVA = NO
|
|
|
|
|
BUILTIN_STL_SUPPORT = NO
|
2008-03-04 14:27:48 +00:00
|
|
|
CPP_CLI_SUPPORT = NO
|
2007-10-31 14:12:14 +00:00
|
|
|
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
|
2008-03-04 14:27:48 +00:00
|
|
|
EXTRACT_ANON_NSPACES = NO
|
2007-10-31 14:12:14 +00:00
|
|
|
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
|
|
|
|
|
ENABLED_SECTIONS =
|
|
|
|
|
MAX_INITIALIZER_LINES = 30
|
|
|
|
|
SHOW_USED_FILES = YES
|
2008-03-04 14:27:48 +00:00
|
|
|
SHOW_DIRECTORIES = YES
|
2007-10-31 14:12:14 +00:00
|
|
|
FILE_VERSION_FILTER =
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
|
# 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
|
2008-03-04 14:27:48 +00:00
|
|
|
WARN_FORMAT = "$file:$line: $text "
|
2007-10-31 14:12:14 +00:00
|
|
|
WARN_LOGFILE =
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
|
# configuration options related to the input files
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
|
INPUT = kicad \
|
|
|
|
|
pcbnew \
|
2009-07-05 16:59:12 +00:00
|
|
|
cvpcb \
|
2007-10-31 14:12:14 +00:00
|
|
|
eeschema \
|
|
|
|
|
3d-viewer \
|
|
|
|
|
common \
|
|
|
|
|
gerbview \
|
|
|
|
|
share \
|
2007-12-11 06:35:52 +00:00
|
|
|
include \
|
|
|
|
|
polygon
|
2008-03-04 14:27:48 +00:00
|
|
|
INPUT_ENCODING = UTF-8
|
2007-10-31 14:12:14 +00:00
|
|
|
FILE_PATTERNS = *.h \
|
|
|
|
|
*.cpp
|
|
|
|
|
RECURSIVE = YES
|
|
|
|
|
EXCLUDE =
|
|
|
|
|
EXCLUDE_SYMLINKS = NO
|
|
|
|
|
EXCLUDE_PATTERNS =
|
2008-03-04 14:27:48 +00:00
|
|
|
EXCLUDE_SYMBOLS =
|
2007-10-31 14:12:14 +00:00
|
|
|
EXAMPLE_PATH =
|
|
|
|
|
EXAMPLE_PATTERNS =
|
|
|
|
|
EXAMPLE_RECURSIVE = NO
|
|
|
|
|
IMAGE_PATH =
|
|
|
|
|
INPUT_FILTER =
|
|
|
|
|
FILTER_PATTERNS =
|
|
|
|
|
FILTER_SOURCE_FILES = NO
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
|
# configuration options related to source browsing
|
|
|
|
|
#---------------------------------------------------------------------------
|
2008-03-04 14:27:48 +00:00
|
|
|
SOURCE_BROWSER = YES
|
|
|
|
|
INLINE_SOURCES = YES
|
2007-10-31 14:12:14 +00:00
|
|
|
STRIP_CODE_COMMENTS = YES
|
|
|
|
|
REFERENCED_BY_RELATION = YES
|
|
|
|
|
REFERENCES_RELATION = YES
|
|
|
|
|
REFERENCES_LINK_SOURCE = YES
|
|
|
|
|
USE_HTAGS = NO
|
2008-03-04 14:27:48 +00:00
|
|
|
VERBATIM_HEADERS = YES
|
2007-10-31 14:12:14 +00:00
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
|
# configuration options related to the alphabetical class index
|
|
|
|
|
#---------------------------------------------------------------------------
|
2008-03-04 14:27:48 +00:00
|
|
|
ALPHABETICAL_INDEX = YES
|
2007-10-31 14:12:14 +00:00
|
|
|
COLS_IN_ALPHA_INDEX = 5
|
|
|
|
|
IGNORE_PREFIX =
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
|
# configuration options related to the HTML output
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
|
GENERATE_HTML = YES
|
|
|
|
|
HTML_OUTPUT = doxygen
|
|
|
|
|
HTML_FILE_EXTENSION = .html
|
|
|
|
|
HTML_HEADER =
|
|
|
|
|
HTML_FOOTER =
|
|
|
|
|
HTML_STYLESHEET =
|
|
|
|
|
HTML_ALIGN_MEMBERS = YES
|
|
|
|
|
GENERATE_HTMLHELP = NO
|
2008-03-04 14:27:48 +00:00
|
|
|
HTML_DYNAMIC_SECTIONS = NO
|
2007-10-31 14:12:14 +00:00
|
|
|
CHM_FILE =
|
|
|
|
|
HHC_LOCATION =
|
|
|
|
|
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
|
|
|
|
|
EXTRA_PACKAGES =
|
|
|
|
|
LATEX_HEADER =
|
|
|
|
|
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
|
|
|
|
|
RTF_STYLESHEET_FILE =
|
|
|
|
|
RTF_EXTENSIONS_FILE =
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
|
# 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
|
|
|
|
|
XML_SCHEMA =
|
|
|
|
|
XML_DTD =
|
|
|
|
|
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
|
|
|
|
|
PERLMOD_MAKEVAR_PREFIX =
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
|
# Configuration options related to the preprocessor
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
|
ENABLE_PREPROCESSING = YES
|
|
|
|
|
MACRO_EXPANSION = NO
|
|
|
|
|
EXPAND_ONLY_PREDEF = NO
|
|
|
|
|
SEARCH_INCLUDES = YES
|
2008-03-04 14:27:48 +00:00
|
|
|
INCLUDE_PATH = include \
|
|
|
|
|
pcbnew \
|
|
|
|
|
eeschema \
|
|
|
|
|
gerbview
|
2007-10-31 14:12:14 +00:00
|
|
|
INCLUDE_FILE_PATTERNS = *.h
|
2008-03-04 14:27:48 +00:00
|
|
|
PREDEFINED =
|
2007-10-31 14:12:14 +00:00
|
|
|
EXPAND_AS_DEFINED =
|
|
|
|
|
SKIP_FUNCTION_MACROS = YES
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
|
# Configuration::additions related to external references
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
|
TAGFILES =
|
|
|
|
|
GENERATE_TAGFILE =
|
|
|
|
|
ALLEXTERNALS = NO
|
|
|
|
|
EXTERNAL_GROUPS = YES
|
|
|
|
|
PERL_PATH = /usr/bin/perl
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
|
# Configuration options related to the dot tool
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
|
CLASS_DIAGRAMS = YES
|
2008-03-04 14:27:48 +00:00
|
|
|
MSCGEN_PATH =
|
2007-10-31 14:12:14 +00:00
|
|
|
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
|
|
|
|
|
DOT_PATH =
|
|
|
|
|
DOTFILE_DIRS =
|
2008-03-04 14:27:48 +00:00
|
|
|
DOT_GRAPH_MAX_NODES = 50
|
2007-10-31 14:12:14 +00:00
|
|
|
MAX_DOT_GRAPH_DEPTH = 0
|
|
|
|
|
DOT_TRANSPARENT = NO
|
|
|
|
|
DOT_MULTI_TARGETS = NO
|
|
|
|
|
GENERATE_LEGEND = YES
|
|
|
|
|
DOT_CLEANUP = YES
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
|
# Configuration::additions related to the search engine
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
|
SEARCHENGINE = NO
|
