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