kicad/Doxyfile

244 lines
8.8 KiB
Plaintext
Raw Normal View History

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
PROJECT_NAME = "KiCad PCB EDA Suite"
PROJECT_NUMBER =
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 =
2007-10-31 14:12:14 +00:00
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 =
2007-10-31 14:12:14 +00:00
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
INHERIT_DOCS = YES
SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 4
ALIASES =
2007-10-31 14:12:14 +00:00
OPTIMIZE_OUTPUT_FOR_C = NO
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 = YES
2007-10-31 14:12:14 +00:00
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 =
2007-10-31 14:12:14 +00:00
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = YES
2008-03-04 14:27:48 +00:00
SHOW_DIRECTORIES = YES
FILE_VERSION_FILTER =
2007-10-31 14:12:14 +00:00
#---------------------------------------------------------------------------
# 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 "
WARN_LOGFILE =
2007-10-31 14:12:14 +00:00
#---------------------------------------------------------------------------
# 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 \
2007-12-11 06:35:52 +00:00
include \
polygon \
potrace
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 = include\boost
2007-10-31 14:12:14 +00:00
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXCLUDE_SYMBOLS =
EXAMPLE_PATH =
EXAMPLE_PATTERNS =
2007-10-31 14:12:14 +00:00
EXAMPLE_RECURSIVE = NO
IMAGE_PATH =
INPUT_FILTER =
FILTER_PATTERNS =
2007-10-31 14:12:14 +00:00
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 =
2007-10-31 14:12:14 +00:00
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
GENERATE_HTML = YES
HTML_OUTPUT = html
2007-10-31 14:12:14 +00:00
HTML_FILE_EXTENSION = .html
HTML_HEADER =
HTML_FOOTER =
HTML_STYLESHEET =
2007-10-31 14:12:14 +00:00
HTML_ALIGN_MEMBERS = YES
GENERATE_HTMLHELP = NO
2008-03-04 14:27:48 +00:00
HTML_DYNAMIC_SECTIONS = NO
CHM_FILE =
HHC_LOCATION =
2007-10-31 14:12:14 +00:00
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 =
2007-10-31 14:12:14 +00:00
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 =
2007-10-31 14:12:14 +00:00
#---------------------------------------------------------------------------
# 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 =
2007-10-31 14:12:14 +00:00
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 =
2007-10-31 14:12:14 +00:00
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
2007-10-31 14:12:14 +00:00
#---------------------------------------------------------------------------
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
PREDEFINED =
EXPAND_AS_DEFINED =
2007-10-31 14:12:14 +00:00
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration::additions related to external references
2007-10-31 14:12:14 +00:00
#---------------------------------------------------------------------------
TAGFILES =
GENERATE_TAGFILE =
2007-10-31 14:12:14 +00:00
ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
2007-10-31 14:12:14 +00:00
#---------------------------------------------------------------------------
CLASS_DIAGRAMS = YES
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
2007-10-31 14:12:14 +00:00
#---------------------------------------------------------------------------
SEARCHENGINE = NO