1# Doxyfile 1.5.6 2 3#--------------------------------------------------------------------------- 4# Project related configuration options 5#--------------------------------------------------------------------------- 6DOXYFILE_ENCODING = UTF-8 7PROJECT_NAME = pdk 8PROJECT_NUMBER = 9OUTPUT_DIRECTORY = 10CREATE_SUBDIRS = NO 11OUTPUT_LANGUAGE = English 12BRIEF_MEMBER_DESC = YES 13REPEAT_BRIEF = YES 14ABBREVIATE_BRIEF = "The $name class" \ 15 "The $name widget" \ 16 "The $name file" \ 17 is \ 18 provides \ 19 specifies \ 20 contains \ 21 represents \ 22 a \ 23 an \ 24 the 25ALWAYS_DETAILED_SEC = YES 26INLINE_INHERITED_MEMB = NO 27FULL_PATH_NAMES = NO 28STRIP_FROM_PATH = 29STRIP_FROM_INC_PATH = 30SHORT_NAMES = NO 31JAVADOC_AUTOBRIEF = YES 32QT_AUTOBRIEF = NO 33MULTILINE_CPP_IS_BRIEF = NO 34DETAILS_AT_TOP = NO 35INHERIT_DOCS = YES 36SEPARATE_MEMBER_PAGES = NO 37TAB_SIZE = 8 38ALIASES = 39OPTIMIZE_OUTPUT_FOR_C = NO 40OPTIMIZE_OUTPUT_JAVA = NO 41OPTIMIZE_FOR_FORTRAN = NO 42OPTIMIZE_OUTPUT_VHDL = NO 43BUILTIN_STL_SUPPORT = NO 44CPP_CLI_SUPPORT = NO 45SIP_SUPPORT = NO 46IDL_PROPERTY_SUPPORT = YES 47DISTRIBUTE_GROUP_DOC = NO 48SUBGROUPING = YES 49TYPEDEF_HIDES_STRUCT = NO 50#--------------------------------------------------------------------------- 51# Build related configuration options 52#--------------------------------------------------------------------------- 53EXTRACT_ALL = YES 54EXTRACT_PRIVATE = NO 55EXTRACT_STATIC = NO 56EXTRACT_LOCAL_CLASSES = NO 57EXTRACT_LOCAL_METHODS = NO 58EXTRACT_ANON_NSPACES = YES 59HIDE_UNDOC_MEMBERS = NO 60HIDE_UNDOC_CLASSES = NO 61HIDE_FRIEND_COMPOUNDS = NO 62HIDE_IN_BODY_DOCS = NO 63INTERNAL_DOCS = NO 64CASE_SENSE_NAMES = YES 65HIDE_SCOPE_NAMES = NO 66SHOW_INCLUDE_FILES = NO 67# MIGHT WANT TO TWEAK LEATER 68INLINE_INFO = YES 69SORT_MEMBER_DOCS = YES 70SORT_BRIEF_DOCS = YES 71SORT_GROUP_NAMES = NO 72SORT_BY_SCOPE_NAME = NO 73GENERATE_TODOLIST = NO 74GENERATE_TESTLIST = NO 75GENERATE_BUGLIST = NO 76GENERATE_DEPRECATEDLIST= YES 77ENABLED_SECTIONS = 78MAX_INITIALIZER_LINES = 30 79SHOW_USED_FILES = NO 80SHOW_DIRECTORIES = NO 81SHOW_FILES = YES 82SHOW_NAMESPACES = YES 83FILE_VERSION_FILTER = 84#--------------------------------------------------------------------------- 85# configuration options related to warning and progress messages 86#--------------------------------------------------------------------------- 87QUIET = NO 88WARNINGS = YES 89WARN_IF_UNDOCUMENTED = YES 90WARN_IF_DOC_ERROR = YES 91WARN_NO_PARAMDOC = NO 92WARN_FORMAT = "$file:$line: $text" 93WARN_LOGFILE = 94#--------------------------------------------------------------------------- 95# configuration options related to the input files 96#--------------------------------------------------------------------------- 97INPUT = 98INPUT_ENCODING = UTF-8 99FILE_PATTERNS = *.c \ 100 *.cpp \ 101 *.dox \ 102 *.h \ 103 *.htm \ 104 *.html 105RECURSIVE = YES 106EXCLUDE = 107# ecxlude entire directories or files 108EXCLUDE_SYMLINKS = NO 109EXCLUDE_PATTERNS = 110EXCLUDE_SYMBOLS = 111EXAMPLE_PATH = 112EXAMPLE_PATTERNS = * 113EXAMPLE_RECURSIVE = NO 114IMAGE_PATH = 115INPUT_FILTER = 116FILTER_PATTERNS = 117FILTER_SOURCE_FILES = NO 118#--------------------------------------------------------------------------- 119# configuration options related to source browsing 120#--------------------------------------------------------------------------- 121SOURCE_BROWSER = YES 122INLINE_SOURCES = NO 123STRIP_CODE_COMMENTS = YES 124REFERENCED_BY_RELATION = NO 125REFERENCES_RELATION = YES 126REFERENCES_LINK_SOURCE = NO 127USE_HTAGS = NO 128VERBATIM_HEADERS = NO 129#--------------------------------------------------------------------------- 130# configuration options related to the alphabetical class index 131#--------------------------------------------------------------------------- 132ALPHABETICAL_INDEX = NO 133COLS_IN_ALPHA_INDEX = 1 134IGNORE_PREFIX = 135#--------------------------------------------------------------------------- 136# configuration options related to the HTML output 137#--------------------------------------------------------------------------- 138GENERATE_HTML = YES 139HTML_OUTPUT = html 140HTML_FILE_EXTENSION = .html 141HTML_HEADER = 142# FILL IN PATH TO HEADER BLOB WANTED IN EVERY FILE 143# RELATIVE PATH TO WHER ERUNNING DOXYGEN FROM 144HTML_FOOTER = 145HTML_STYLESHEET = 146# PATH TO STYLE SHEET 147HTML_ALIGN_MEMBERS = YES 148GENERATE_HTMLHELP = NO 149GENERATE_DOCSET = NO 150DOCSET_FEEDNAME = "Doxygen generated docs" 151DOCSET_BUNDLE_ID = org.doxygen.Project 152HTML_DYNAMIC_SECTIONS = NO 153CHM_FILE = 154HHC_LOCATION = 155GENERATE_CHI = NO 156CHM_INDEX_ENCODING = 157BINARY_TOC = NO 158TOC_EXPAND = NO 159DISABLE_INDEX = NO 160ENUM_VALUES_PER_LINE = 4 161GENERATE_TREEVIEW = NONE 162TREEVIEW_WIDTH = 250 163FORMULA_FONTSIZE = 10 164#--------------------------------------------------------------------------- 165# configuration options related to the LaTeX output 166#--------------------------------------------------------------------------- 167GENERATE_LATEX = NO 168LATEX_OUTPUT = latex 169LATEX_CMD_NAME = latex 170MAKEINDEX_CMD_NAME = makeindex 171COMPACT_LATEX = NO 172PAPER_TYPE = a4wide 173EXTRA_PACKAGES = 174LATEX_HEADER = 175PDF_HYPERLINKS = YES 176USE_PDFLATEX = YES 177LATEX_BATCHMODE = NO 178LATEX_HIDE_INDICES = NO 179#--------------------------------------------------------------------------- 180# configuration options related to the RTF output 181#--------------------------------------------------------------------------- 182GENERATE_RTF = NO 183RTF_OUTPUT = rtf 184COMPACT_RTF = NO 185RTF_HYPERLINKS = NO 186RTF_STYLESHEET_FILE = 187RTF_EXTENSIONS_FILE = 188#--------------------------------------------------------------------------- 189# configuration options related to the man page output 190#--------------------------------------------------------------------------- 191GENERATE_MAN = NO 192MAN_OUTPUT = man 193MAN_EXTENSION = .3 194MAN_LINKS = NO 195#--------------------------------------------------------------------------- 196# configuration options related to the XML output 197#--------------------------------------------------------------------------- 198GENERATE_XML = NO 199XML_OUTPUT = xml 200XML_SCHEMA = 201XML_DTD = 202XML_PROGRAMLISTING = YES 203#--------------------------------------------------------------------------- 204# configuration options for the AutoGen Definitions output 205#--------------------------------------------------------------------------- 206GENERATE_AUTOGEN_DEF = NO 207#--------------------------------------------------------------------------- 208# configuration options related to the Perl module output 209#--------------------------------------------------------------------------- 210GENERATE_PERLMOD = NO 211PERLMOD_LATEX = NO 212PERLMOD_PRETTY = YES 213PERLMOD_MAKEVAR_PREFIX = 214#--------------------------------------------------------------------------- 215# Configuration options related to the preprocessor 216#--------------------------------------------------------------------------- 217ENABLE_PREPROCESSING = NO 218# KEY CONSIDERATION TWEAK BACK AND FORTH. function in an # if/def preprocessor directive. Processor evalutes whether true. Should doxygen follow compiles behavior or document everything? 219# usually have optional things that people may want to tweak. 220MACRO_EXPANSION = YES 221EXPAND_ONLY_PREDEF = YES 222SEARCH_INCLUDES = NO 223INCLUDE_PATH = 224INCLUDE_FILE_PATTERNS = 225PREDEFINED = 226#to mimic preprocessor behaviors. 227EXPAND_AS_DEFINED = 228SKIP_FUNCTION_MACROS = YES 229#--------------------------------------------------------------------------- 230# Configuration::additions related to external references 231#--------------------------------------------------------------------------- 232TAGFILES = 233GENERATE_TAGFILE = 234ALLEXTERNALS = NO 235EXTERNAL_GROUPS = NO 236PERL_PATH = 237#--------------------------------------------------------------------------- 238# Configuration options related to the dot tool 239#--------------------------------------------------------------------------- 240CLASS_DIAGRAMS = NO 241#CHANGE WHEN HAVE DIAGRAMS 242MSCGEN_PATH = YES 243HIDE_UNDOC_RELATIONS = YES 244HAVE_DOT = NO 245DOT_FONTNAME = FreeSans 246DOT_FONTPATH = 247CLASS_GRAPH = YES 248COLLABORATION_GRAPH = YES 249GROUP_GRAPHS = YES 250UML_LOOK = NO 251TEMPLATE_RELATIONS = NO 252INCLUDE_GRAPH = YES 253INCLUDED_BY_GRAPH = YES 254CALL_GRAPH = NO 255CALLER_GRAPH = NO 256GRAPHICAL_HIERARCHY = YES 257DIRECTORY_GRAPH = YES 258DOT_IMAGE_FORMAT = png 259DOT_PATH = 260DOTFILE_DIRS = 261DOT_GRAPH_MAX_NODES = 50 262MAX_DOT_GRAPH_DEPTH = 1000 263DOT_TRANSPARENT = YES 264DOT_MULTI_TARGETS = NO 265GENERATE_LEGEND = YES 266DOT_CLEANUP = YES 267#--------------------------------------------------------------------------- 268# Configuration::additions related to the search engine 269#--------------------------------------------------------------------------- 270SEARCHENGINE = NO 271@INCLUDE = overrideconfig.conf 272# relative to where running doxygen from 273# @INCLUDE = $(PROJECTCONF) 274