u-blox
/
battery-charger-bq24295
Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: example-battery-charger-bq24295 example-C030-out-of-box-demo example-C030-out-of-box-demo Amit
Doxyfile@1:ed57b6ca43ab, 2017-04-10 (annotated)
- Committer:
- rob.meades@u-blox.com
- Date:
- Mon Apr 10 11:04:15 2017 +0100
- Revision:
- 1:ed57b6ca43ab
Add files to repo, removing README.md as that description is now in the repo description of the on-line IDE.
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1 | # Doxyfile 1.8.7 |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 3 | # This file describes the settings to be used by the documentation system |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 4 | # doxygen (www.doxygen.org) for a project. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 5 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 6 | # All text after a double hash (##) is considered a comment and is placed in |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 7 | # front of the TAG it is preceding. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 8 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 9 | # All text after a single hash (#) is considered a comment and will be ignored. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 10 | # The format is: |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 11 | # TAG = value [value, ...] |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 12 | # For lists, items can also be appended using: |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 13 | # TAG += value [value, ...] |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 14 | # Values that contain spaces should be placed between quotes (\" \"). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 15 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 16 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 17 | # Project related configuration options |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 18 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 19 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 20 | # This tag specifies the encoding used for all characters in the config file |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 21 | # that follow. The default is UTF-8 which is also the encoding used for all text |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 22 | # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 23 | # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 24 | # for the list of possible encodings. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 25 | # The default value is: UTF-8. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 26 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 27 | DOXYFILE_ENCODING = UTF-8 |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 28 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 29 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 30 | # double-quotes, unless you are using Doxywizard) that should identify the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 31 | # project for which the documentation is generated. This name is used in the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 32 | # title of most generated pages and in a few other places. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 33 | # The default value is: My Project. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 34 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 35 | PROJECT_NAME = "Battery Charger BQ24295" |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 36 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 37 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. This |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 38 | # could be handy for archiving the generated documentation or if some version |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 39 | # control system is used. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 40 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 41 | PROJECT_NUMBER = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 42 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 43 | # Using the PROJECT_BRIEF tag one can provide an optional one line description |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 44 | # for a project that appears at the top of each page and should give viewer a |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 45 | # quick idea about the purpose of the project. Keep the description short. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 46 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 47 | PROJECT_BRIEF = "mbed driver for the BQ24295 battery charger chip." |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 48 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 49 | # With the PROJECT_LOGO tag one can specify an logo or icon that is included in |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 50 | # the documentation. The maximum height of the logo should not exceed 55 pixels |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 51 | # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 52 | # to the output directory. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 53 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 54 | PROJECT_LOGO = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 55 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 56 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 57 | # into which the generated documentation will be written. If a relative path is |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 58 | # entered, it will be relative to the location where doxygen was started. If |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 59 | # left blank the current directory will be used. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 60 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 61 | OUTPUT_DIRECTORY = ./doc |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 62 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 63 | # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 64 | # directories (in 2 levels) under the output directory of each output format and |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 65 | # will distribute the generated files over these directories. Enabling this |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 66 | # option can be useful when feeding doxygen a huge amount of source files, where |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 67 | # putting all generated files in the same directory would otherwise causes |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 68 | # performance problems for the file system. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 69 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 70 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 71 | CREATE_SUBDIRS = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 72 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 73 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 74 | # characters to appear in the names of generated files. If set to NO, non-ASCII |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 75 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 76 | # U+3044. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 77 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 78 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 79 | ALLOW_UNICODE_NAMES = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 80 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 81 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 82 | # documentation generated by doxygen is written. Doxygen will use this |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 83 | # information to generate all constant output in the proper language. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 84 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 85 | # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 86 | # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 87 | # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 88 | # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 89 | # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 90 | # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 91 | # Ukrainian and Vietnamese. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 92 | # The default value is: English. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 93 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 94 | OUTPUT_LANGUAGE = English |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 95 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 96 | # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 97 | # descriptions after the members that are listed in the file and class |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 98 | # documentation (similar to Javadoc). Set to NO to disable this. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 99 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 100 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 101 | BRIEF_MEMBER_DESC = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 102 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 103 | # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 104 | # description of a member or function before the detailed description |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 105 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 106 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 107 | # brief descriptions will be completely suppressed. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 108 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 109 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 110 | REPEAT_BRIEF = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 111 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 112 | # This tag implements a quasi-intelligent brief description abbreviator that is |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 113 | # used to form the text in various listings. Each string in this list, if found |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 114 | # as the leading text of the brief description, will be stripped from the text |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 115 | # and the result, after processing the whole list, is used as the annotated |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 116 | # text. Otherwise, the brief description is used as-is. If left blank, the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 117 | # following values are used ($name is automatically replaced with the name of |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 118 | # the entity):The $name class, The $name widget, The $name file, is, provides, |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 119 | # specifies, contains, represents, a, an and the. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 120 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 121 | ABBREVIATE_BRIEF = "The $name class" \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 122 | "The $name widget" \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 123 | "The $name file" \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 124 | is \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 125 | provides \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 126 | specifies \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 127 | contains \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 128 | represents \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 129 | a \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 130 | an \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 131 | the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 132 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 133 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 134 | # doxygen will generate a detailed section even if there is only a brief |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 135 | # description. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 136 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 137 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 138 | ALWAYS_DETAILED_SEC = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 139 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 140 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 141 | # inherited members of a class in the documentation of that class as if those |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 142 | # members were ordinary class members. Constructors, destructors and assignment |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 143 | # operators of the base classes will not be shown. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 144 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 145 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 146 | INLINE_INHERITED_MEMB = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 147 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 148 | # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 149 | # before files name in the file list and in the header files. If set to NO the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 150 | # shortest path that makes the file name unique will be used |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 151 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 152 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 153 | FULL_PATH_NAMES = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 154 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 155 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 156 | # Stripping is only done if one of the specified strings matches the left-hand |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 157 | # part of the path. The tag can be used to show relative paths in the file list. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 158 | # If left blank the directory from which doxygen is run is used as the path to |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 159 | # strip. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 160 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 161 | # Note that you can specify absolute paths here, but also relative paths, which |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 162 | # will be relative from the directory where doxygen is started. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 163 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 164 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 165 | STRIP_FROM_PATH = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 166 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 167 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 168 | # path mentioned in the documentation of a class, which tells the reader which |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 169 | # header file to include in order to use a class. If left blank only the name of |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 170 | # the header file containing the class definition is used. Otherwise one should |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 171 | # specify the list of include paths that are normally passed to the compiler |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 172 | # using the -I flag. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 173 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 174 | STRIP_FROM_INC_PATH = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 175 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 176 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 177 | # less readable) file names. This can be useful is your file systems doesn't |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 178 | # support long names like on DOS, Mac, or CD-ROM. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 179 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 180 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 181 | SHORT_NAMES = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 182 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 183 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 184 | # first line (until the first dot) of a Javadoc-style comment as the brief |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 185 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 186 | # style comments (thus requiring an explicit @brief command for a brief |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 187 | # description.) |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 188 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 189 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 190 | JAVADOC_AUTOBRIEF = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 191 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 192 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 193 | # line (until the first dot) of a Qt-style comment as the brief description. If |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 194 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 195 | # requiring an explicit \brief command for a brief description.) |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 196 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 197 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 198 | QT_AUTOBRIEF = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 199 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 200 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 201 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 202 | # a brief description. This used to be the default behavior. The new default is |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 203 | # to treat a multi-line C++ comment block as a detailed description. Set this |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 204 | # tag to YES if you prefer the old behavior instead. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 205 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 206 | # Note that setting this tag to YES also means that rational rose comments are |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 207 | # not recognized any more. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 208 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 209 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 210 | MULTILINE_CPP_IS_BRIEF = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 211 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 212 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 213 | # documentation from any documented member that it re-implements. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 214 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 215 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 216 | INHERIT_DOCS = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 217 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 218 | # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 219 | # new page for each member. If set to NO, the documentation of a member will be |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 220 | # part of the file/class/namespace that contains it. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 221 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 222 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 223 | SEPARATE_MEMBER_PAGES = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 224 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 225 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 226 | # uses this value to replace tabs by spaces in code fragments. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 227 | # Minimum value: 1, maximum value: 16, default value: 4. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 228 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 229 | TAB_SIZE = 4 |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 230 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 231 | # This tag can be used to specify a number of aliases that act as commands in |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 232 | # the documentation. An alias has the form: |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 233 | # name=value |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 234 | # For example adding |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 235 | # "sideeffect=@par Side Effects:\n" |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 236 | # will allow you to put the command \sideeffect (or @sideeffect) in the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 237 | # documentation, which will result in a user-defined paragraph with heading |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 238 | # "Side Effects:". You can put \n's in the value part of an alias to insert |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 239 | # newlines. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 240 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 241 | ALIASES = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 242 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 243 | # This tag can be used to specify a number of word-keyword mappings (TCL only). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 244 | # A mapping has the form "name=value". For example adding "class=itcl::class" |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 245 | # will allow you to use the command class in the itcl::class meaning. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 246 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 247 | TCL_SUBST = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 248 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 249 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 250 | # only. Doxygen will then generate output that is more tailored for C. For |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 251 | # instance, some of the names that are used will be different. The list of all |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 252 | # members will be omitted, etc. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 253 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 254 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 255 | OPTIMIZE_OUTPUT_FOR_C = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 256 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 257 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 258 | # Python sources only. Doxygen will then generate output that is more tailored |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 259 | # for that language. For instance, namespaces will be presented as packages, |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 260 | # qualified scopes will look different, etc. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 261 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 262 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 263 | OPTIMIZE_OUTPUT_JAVA = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 264 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 265 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 266 | # sources. Doxygen will then generate output that is tailored for Fortran. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 267 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 268 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 269 | OPTIMIZE_FOR_FORTRAN = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 270 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 271 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 272 | # sources. Doxygen will then generate output that is tailored for VHDL. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 273 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 274 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 275 | OPTIMIZE_OUTPUT_VHDL = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 276 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 277 | # Doxygen selects the parser to use depending on the extension of the files it |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 278 | # parses. With this tag you can assign which parser to use for a given |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 279 | # extension. Doxygen has a built-in mapping, but you can override or extend it |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 280 | # using this tag. The format is ext=language, where ext is a file extension, and |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 281 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 282 | # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 283 | # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 284 | # Fortran. In the later case the parser tries to guess whether the code is fixed |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 285 | # or free formatted code, this is the default for Fortran type files), VHDL. For |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 286 | # instance to make doxygen treat .inc files as Fortran files (default is PHP), |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 287 | # and .f files as C (default is Fortran), use: inc=Fortran f=C. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 288 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 289 | # Note For files without extension you can use no_extension as a placeholder. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 290 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 291 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 292 | # the files are not read by doxygen. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 293 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 294 | EXTENSION_MAPPING = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 295 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 296 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 297 | # according to the Markdown format, which allows for more readable |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 298 | # documentation. See http://daringfireball.net/projects/markdown/ for details. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 299 | # The output of markdown processing is further processed by doxygen, so you can |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 300 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 301 | # case of backward compatibilities issues. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 302 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 303 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 304 | MARKDOWN_SUPPORT = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 305 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 306 | # When enabled doxygen tries to link words that correspond to documented |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 307 | # classes, or namespaces to their corresponding documentation. Such a link can |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 308 | # be prevented in individual cases by by putting a % sign in front of the word |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 309 | # or globally by setting AUTOLINK_SUPPORT to NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 310 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 311 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 312 | AUTOLINK_SUPPORT = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 313 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 314 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 315 | # to include (a tag file for) the STL sources as input, then you should set this |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 316 | # tag to YES in order to let doxygen match functions declarations and |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 317 | # definitions whose arguments contain STL classes (e.g. func(std::string); |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 318 | # versus func(std::string) {}). This also make the inheritance and collaboration |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 319 | # diagrams that involve STL classes more complete and accurate. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 320 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 321 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 322 | BUILTIN_STL_SUPPORT = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 323 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 324 | # If you use Microsoft's C++/CLI language, you should set this option to YES to |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 325 | # enable parsing support. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 326 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 327 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 328 | CPP_CLI_SUPPORT = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 329 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 330 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 331 | # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 332 | # will parse them like normal C++ but will assume all classes use public instead |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 333 | # of private inheritance when no explicit protection keyword is present. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 334 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 335 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 336 | SIP_SUPPORT = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 337 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 338 | # For Microsoft's IDL there are propget and propput attributes to indicate |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 339 | # getter and setter methods for a property. Setting this option to YES will make |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 340 | # doxygen to replace the get and set methods by a property in the documentation. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 341 | # This will only work if the methods are indeed getting or setting a simple |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 342 | # type. If this is not the case, or you want to show the methods anyway, you |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 343 | # should set this option to NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 344 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 345 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 346 | IDL_PROPERTY_SUPPORT = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 347 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 348 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 349 | # tag is set to YES, then doxygen will reuse the documentation of the first |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 350 | # member in the group (if any) for the other members of the group. By default |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 351 | # all members of a group must be documented explicitly. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 352 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 353 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 354 | DISTRIBUTE_GROUP_DOC = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 355 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 356 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 357 | # (for instance a group of public functions) to be put as a subgroup of that |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 358 | # type (e.g. under the Public Functions section). Set it to NO to prevent |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 359 | # subgrouping. Alternatively, this can be done per class using the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 360 | # \nosubgrouping command. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 361 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 362 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 363 | SUBGROUPING = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 364 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 365 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 366 | # are shown inside the group in which they are included (e.g. using \ingroup) |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 367 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 368 | # and RTF). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 369 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 370 | # Note that this feature does not work in combination with |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 371 | # SEPARATE_MEMBER_PAGES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 372 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 373 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 374 | INLINE_GROUPED_CLASSES = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 375 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 376 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 377 | # with only public data fields or simple typedef fields will be shown inline in |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 378 | # the documentation of the scope in which they are defined (i.e. file, |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 379 | # namespace, or group documentation), provided this scope is documented. If set |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 380 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 381 | # Man pages) or section (for LaTeX and RTF). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 382 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 383 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 384 | INLINE_SIMPLE_STRUCTS = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 385 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 386 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 387 | # enum is documented as struct, union, or enum with the name of the typedef. So |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 388 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 389 | # with name TypeT. When disabled the typedef will appear as a member of a file, |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 390 | # namespace, or class. And the struct will be named TypeS. This can typically be |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 391 | # useful for C code in case the coding convention dictates that all compound |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 392 | # types are typedef'ed and only the typedef is referenced, never the tag name. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 393 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 394 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 395 | TYPEDEF_HIDES_STRUCT = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 396 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 397 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 398 | # cache is used to resolve symbols given their name and scope. Since this can be |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 399 | # an expensive process and often the same symbol appears multiple times in the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 400 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 401 | # doxygen will become slower. If the cache is too large, memory is wasted. The |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 402 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 403 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 404 | # symbols. At the end of a run doxygen will report the cache usage and suggest |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 405 | # the optimal cache size from a speed point of view. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 406 | # Minimum value: 0, maximum value: 9, default value: 0. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 407 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 408 | LOOKUP_CACHE_SIZE = 0 |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 409 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 410 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 411 | # Build related configuration options |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 412 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 413 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 414 | # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 415 | # documentation are documented, even if no documentation was available. Private |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 416 | # class members and static file members will be hidden unless the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 417 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 418 | # Note: This will also disable the warnings about undocumented members that are |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 419 | # normally produced when WARNINGS is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 420 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 421 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 422 | EXTRACT_ALL = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 423 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 424 | # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 425 | # be included in the documentation. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 426 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 427 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 428 | EXTRACT_PRIVATE = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 429 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 430 | # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 431 | # scope will be included in the documentation. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 432 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 433 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 434 | EXTRACT_PACKAGE = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 435 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 436 | # If the EXTRACT_STATIC tag is set to YES all static members of a file will be |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 437 | # included in the documentation. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 438 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 439 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 440 | EXTRACT_STATIC = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 441 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 442 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 443 | # locally in source files will be included in the documentation. If set to NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 444 | # only classes defined in header files are included. Does not have any effect |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 445 | # for Java sources. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 446 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 447 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 448 | EXTRACT_LOCAL_CLASSES = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 449 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 450 | # This flag is only useful for Objective-C code. When set to YES local methods, |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 451 | # which are defined in the implementation section but not in the interface are |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 452 | # included in the documentation. If set to NO only methods in the interface are |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 453 | # included. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 454 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 455 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 456 | EXTRACT_LOCAL_METHODS = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 457 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 458 | # If this flag is set to YES, the members of anonymous namespaces will be |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 459 | # extracted and appear in the documentation as a namespace called |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 460 | # 'anonymous_namespace{file}', where file will be replaced with the base name of |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 461 | # the file that contains the anonymous namespace. By default anonymous namespace |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 462 | # are hidden. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 463 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 464 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 465 | EXTRACT_ANON_NSPACES = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 466 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 467 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 468 | # undocumented members inside documented classes or files. If set to NO these |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 469 | # members will be included in the various overviews, but no documentation |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 470 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 471 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 472 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 473 | HIDE_UNDOC_MEMBERS = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 474 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 475 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 476 | # undocumented classes that are normally visible in the class hierarchy. If set |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 477 | # to NO these classes will be included in the various overviews. This option has |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 478 | # no effect if EXTRACT_ALL is enabled. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 479 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 480 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 481 | HIDE_UNDOC_CLASSES = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 482 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 483 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 484 | # (class|struct|union) declarations. If set to NO these declarations will be |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 485 | # included in the documentation. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 486 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 487 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 488 | HIDE_FRIEND_COMPOUNDS = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 489 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 490 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 491 | # documentation blocks found inside the body of a function. If set to NO these |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 492 | # blocks will be appended to the function's detailed documentation block. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 493 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 494 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 495 | HIDE_IN_BODY_DOCS = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 496 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 497 | # The INTERNAL_DOCS tag determines if documentation that is typed after a |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 498 | # \internal command is included. If the tag is set to NO then the documentation |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 499 | # will be excluded. Set it to YES to include the internal documentation. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 500 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 501 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 502 | INTERNAL_DOCS = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 503 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 504 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 505 | # names in lower-case letters. If set to YES upper-case letters are also |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 506 | # allowed. This is useful if you have classes or files whose names only differ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 507 | # in case and if your file system supports case sensitive file names. Windows |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 508 | # and Mac users are advised to set this option to NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 509 | # The default value is: system dependent. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 510 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 511 | CASE_SENSE_NAMES = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 512 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 513 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 514 | # their full class and namespace scopes in the documentation. If set to YES the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 515 | # scope will be hidden. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 516 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 517 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 518 | HIDE_SCOPE_NAMES = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 519 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 520 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 521 | # the files that are included by a file in the documentation of that file. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 522 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 523 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 524 | SHOW_INCLUDE_FILES = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 525 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 526 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 527 | # grouped member an include statement to the documentation, telling the reader |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 528 | # which file to include in order to use the member. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 529 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 530 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 531 | SHOW_GROUPED_MEMB_INC = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 532 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 533 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 534 | # files with double quotes in the documentation rather than with sharp brackets. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 535 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 536 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 537 | FORCE_LOCAL_INCLUDES = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 538 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 539 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 540 | # documentation for inline members. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 541 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 542 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 543 | INLINE_INFO = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 544 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 545 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 546 | # (detailed) documentation of file and class members alphabetically by member |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 547 | # name. If set to NO the members will appear in declaration order. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 548 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 549 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 550 | SORT_MEMBER_DOCS = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 551 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 552 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 553 | # descriptions of file, namespace and class members alphabetically by member |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 554 | # name. If set to NO the members will appear in declaration order. Note that |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 555 | # this will also influence the order of the classes in the class list. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 556 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 557 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 558 | SORT_BRIEF_DOCS = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 559 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 560 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 561 | # (brief and detailed) documentation of class members so that constructors and |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 562 | # destructors are listed first. If set to NO the constructors will appear in the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 563 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 564 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 565 | # member documentation. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 566 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 567 | # detailed member documentation. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 568 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 569 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 570 | SORT_MEMBERS_CTORS_1ST = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 571 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 572 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 573 | # of group names into alphabetical order. If set to NO the group names will |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 574 | # appear in their defined order. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 575 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 576 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 577 | SORT_GROUP_NAMES = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 578 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 579 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 580 | # fully-qualified names, including namespaces. If set to NO, the class list will |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 581 | # be sorted only by class name, not including the namespace part. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 582 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 583 | # Note: This option applies only to the class list, not to the alphabetical |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 584 | # list. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 585 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 586 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 587 | SORT_BY_SCOPE_NAME = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 588 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 589 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 590 | # type resolution of all parameters of a function it will reject a match between |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 591 | # the prototype and the implementation of a member function even if there is |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 592 | # only one candidate or it is obvious which candidate to choose by doing a |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 593 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 594 | # accept a match between prototype and implementation in such cases. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 595 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 596 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 597 | STRICT_PROTO_MATCHING = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 598 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 599 | # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 600 | # todo list. This list is created by putting \todo commands in the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 601 | # documentation. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 602 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 603 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 604 | GENERATE_TODOLIST = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 605 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 606 | # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 607 | # test list. This list is created by putting \test commands in the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 608 | # documentation. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 609 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 610 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 611 | GENERATE_TESTLIST = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 612 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 613 | # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 614 | # list. This list is created by putting \bug commands in the documentation. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 615 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 616 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 617 | GENERATE_BUGLIST = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 618 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 619 | # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 620 | # the deprecated list. This list is created by putting \deprecated commands in |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 621 | # the documentation. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 622 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 623 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 624 | GENERATE_DEPRECATEDLIST= YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 625 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 626 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 627 | # sections, marked by \if <section_label> ... \endif and \cond <section_label> |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 628 | # ... \endcond blocks. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 629 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 630 | ENABLED_SECTIONS = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 631 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 632 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 633 | # initial value of a variable or macro / define can have for it to appear in the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 634 | # documentation. If the initializer consists of more lines than specified here |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 635 | # it will be hidden. Use a value of 0 to hide initializers completely. The |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 636 | # appearance of the value of individual variables and macros / defines can be |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 637 | # controlled using \showinitializer or \hideinitializer command in the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 638 | # documentation regardless of this setting. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 639 | # Minimum value: 0, maximum value: 10000, default value: 30. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 640 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 641 | MAX_INITIALIZER_LINES = 30 |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 642 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 643 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 644 | # the bottom of the documentation of classes and structs. If set to YES the list |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 645 | # will mention the files that were used to generate the documentation. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 646 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 647 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 648 | SHOW_USED_FILES = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 649 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 650 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 651 | # will remove the Files entry from the Quick Index and from the Folder Tree View |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 652 | # (if specified). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 653 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 654 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 655 | SHOW_FILES = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 656 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 657 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 658 | # page. This will remove the Namespaces entry from the Quick Index and from the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 659 | # Folder Tree View (if specified). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 660 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 661 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 662 | SHOW_NAMESPACES = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 663 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 664 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 665 | # doxygen should invoke to get the current version for each file (typically from |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 666 | # the version control system). Doxygen will invoke the program by executing (via |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 667 | # popen()) the command command input-file, where command is the value of the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 668 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 669 | # by doxygen. Whatever the program writes to standard output is used as the file |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 670 | # version. For an example see the documentation. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 671 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 672 | FILE_VERSION_FILTER = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 673 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 674 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 675 | # by doxygen. The layout file controls the global structure of the generated |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 676 | # output files in an output format independent way. To create the layout file |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 677 | # that represents doxygen's defaults, run doxygen with the -l option. You can |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 678 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 679 | # will be used as the name of the layout file. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 680 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 681 | # Note that if you run doxygen from a directory containing a file called |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 682 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 683 | # tag is left empty. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 684 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 685 | LAYOUT_FILE = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 686 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 687 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 688 | # the reference definitions. This must be a list of .bib files. The .bib |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 689 | # extension is automatically appended if omitted. This requires the bibtex tool |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 690 | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 691 | # For LaTeX the style of the bibliography can be controlled using |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 692 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 693 | # search path. Do not use file names with spaces, bibtex cannot handle them. See |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 694 | # also \cite for info how to create references. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 695 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 696 | CITE_BIB_FILES = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 697 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 698 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 699 | # Configuration options related to warning and progress messages |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 700 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 701 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 702 | # The QUIET tag can be used to turn on/off the messages that are generated to |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 703 | # standard output by doxygen. If QUIET is set to YES this implies that the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 704 | # messages are off. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 705 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 706 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 707 | QUIET = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 708 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 709 | # The WARNINGS tag can be used to turn on/off the warning messages that are |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 710 | # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 711 | # this implies that the warnings are on. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 712 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 713 | # Tip: Turn warnings on while writing the documentation. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 714 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 715 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 716 | WARNINGS = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 717 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 718 | # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 719 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 720 | # will automatically be disabled. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 721 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 722 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 723 | WARN_IF_UNDOCUMENTED = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 724 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 725 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 726 | # potential errors in the documentation, such as not documenting some parameters |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 727 | # in a documented function, or documenting parameters that don't exist or using |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 728 | # markup commands wrongly. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 729 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 730 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 731 | WARN_IF_DOC_ERROR = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 732 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 733 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 734 | # are documented, but have no documentation for their parameters or return |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 735 | # value. If set to NO doxygen will only warn about wrong or incomplete parameter |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 736 | # documentation, but not about the absence of documentation. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 737 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 738 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 739 | WARN_NO_PARAMDOC = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 740 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 741 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 742 | # can produce. The string should contain the $file, $line, and $text tags, which |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 743 | # will be replaced by the file and line number from which the warning originated |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 744 | # and the warning text. Optionally the format may contain $version, which will |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 745 | # be replaced by the version of the file (if it could be obtained via |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 746 | # FILE_VERSION_FILTER) |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 747 | # The default value is: $file:$line: $text. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 748 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 749 | WARN_FORMAT = "$file:$line: $text" |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 750 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 751 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 752 | # messages should be written. If left blank the output is written to standard |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 753 | # error (stderr). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 754 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 755 | WARN_LOGFILE = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 756 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 757 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 758 | # Configuration options related to the input files |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 759 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 760 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 761 | # The INPUT tag is used to specify the files and/or directories that contain |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 762 | # documented source files. You may enter file names like myfile.cpp or |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 763 | # directories like /usr/src/myproject. Separate the files or directories with |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 764 | # spaces. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 765 | # Note: If this tag is empty the current directory is searched. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 766 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 767 | INPUT = . \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 768 | README.md |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 769 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 770 | # This tag can be used to specify the character encoding of the source files |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 771 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 772 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 773 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 774 | # possible encodings. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 775 | # The default value is: UTF-8. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 776 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 777 | INPUT_ENCODING = UTF-8 |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 778 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 779 | # If the value of the INPUT tag contains directories, you can use the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 780 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 781 | # *.h) to filter out the source-files in the directories. If left blank the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 782 | # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 783 | # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 784 | # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 785 | # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 786 | # *.qsf, *.as and *.js. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 787 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 788 | FILE_PATTERNS = *.c \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 789 | *.cc \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 790 | *.cxx \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 791 | *.cpp \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 792 | *.c++ \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 793 | *.java \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 794 | *.ii \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 795 | *.ixx \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 796 | *.ipp \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 797 | *.i++ \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 798 | *.inl \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 799 | *.idl \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 800 | *.ddl \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 801 | *.odl \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 802 | *.h \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 803 | *.hh \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 804 | *.hxx \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 805 | *.hpp \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 806 | *.h++ \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 807 | *.cs \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 808 | *.d \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 809 | *.php \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 810 | *.php4 \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 811 | *.php5 \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 812 | *.phtml \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 813 | *.inc \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 814 | *.m \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 815 | *.markdown \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 816 | *.md \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 817 | *.mm \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 818 | *.dox \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 819 | *.py \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 820 | *.f90 \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 821 | *.f \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 822 | *.for \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 823 | *.tcl \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 824 | *.vhd \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 825 | *.vhdl \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 826 | *.ucf \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 827 | *.qsf \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 828 | *.as \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 829 | *.js \ |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 830 | *.md |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 831 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 832 | # The RECURSIVE tag can be used to specify whether or not subdirectories should |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 833 | # be searched for input files as well. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 834 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 835 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 836 | RECURSIVE = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 837 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 838 | # The EXCLUDE tag can be used to specify files and/or directories that should be |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 839 | # excluded from the INPUT source files. This way you can easily exclude a |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 840 | # subdirectory from a directory tree whose root is specified with the INPUT tag. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 841 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 842 | # Note that relative paths are relative to the directory from which doxygen is |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 843 | # run. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 844 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 845 | EXCLUDE = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 846 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 847 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 848 | # directories that are symbolic links (a Unix file system feature) are excluded |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 849 | # from the input. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 850 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 851 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 852 | EXCLUDE_SYMLINKS = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 853 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 854 | # If the value of the INPUT tag contains directories, you can use the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 855 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 856 | # certain files from those directories. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 857 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 858 | # Note that the wildcards are matched against the file with absolute path, so to |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 859 | # exclude all test directories for example use the pattern */test/* |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 860 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 861 | EXCLUDE_PATTERNS = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 862 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 863 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 864 | # (namespaces, classes, functions, etc.) that should be excluded from the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 865 | # output. The symbol name can be a fully qualified name, a word, or if the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 866 | # wildcard * is used, a substring. Examples: ANamespace, AClass, |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 867 | # AClass::ANamespace, ANamespace::*Test |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 868 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 869 | # Note that the wildcards are matched against the file with absolute path, so to |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 870 | # exclude all test directories use the pattern */test/* |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 871 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 872 | EXCLUDE_SYMBOLS = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 873 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 874 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 875 | # that contain example code fragments that are included (see the \include |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 876 | # command). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 877 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 878 | EXAMPLE_PATH = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 879 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 880 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 881 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 882 | # *.h) to filter out the source-files in the directories. If left blank all |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 883 | # files are included. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 884 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 885 | EXAMPLE_PATTERNS = * |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 886 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 887 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 888 | # searched for input files to be used with the \include or \dontinclude commands |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 889 | # irrespective of the value of the RECURSIVE tag. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 890 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 891 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 892 | EXAMPLE_RECURSIVE = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 893 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 894 | # The IMAGE_PATH tag can be used to specify one or more files or directories |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 895 | # that contain images that are to be included in the documentation (see the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 896 | # \image command). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 897 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 898 | IMAGE_PATH = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 899 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 900 | # The INPUT_FILTER tag can be used to specify a program that doxygen should |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 901 | # invoke to filter for each input file. Doxygen will invoke the filter program |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 902 | # by executing (via popen()) the command: |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 903 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 904 | # <filter> <input-file> |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 905 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 906 | # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 907 | # name of an input file. Doxygen will then use the output that the filter |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 908 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 909 | # will be ignored. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 910 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 911 | # Note that the filter must not add or remove lines; it is applied before the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 912 | # code is scanned, but not when the output code is generated. If lines are added |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 913 | # or removed, the anchors will not be placed correctly. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 914 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 915 | INPUT_FILTER = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 916 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 917 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 918 | # basis. Doxygen will compare the file name with each pattern and apply the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 919 | # filter if there is a match. The filters are a list of the form: pattern=filter |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 920 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 921 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 922 | # patterns match the file name, INPUT_FILTER is applied. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 923 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 924 | FILTER_PATTERNS = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 925 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 926 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 927 | # INPUT_FILTER ) will also be used to filter the input files that are used for |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 928 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 929 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 930 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 931 | FILTER_SOURCE_FILES = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 932 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 933 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 934 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 935 | # it is also possible to disable source filtering for a specific pattern using |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 936 | # *.ext= (so without naming a filter). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 937 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 938 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 939 | FILTER_SOURCE_PATTERNS = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 940 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 941 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 942 | # is part of the input, its contents will be placed on the main page |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 943 | # (index.html). This can be useful if you have a project on for instance GitHub |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 944 | # and want to reuse the introduction page also for the doxygen output. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 945 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 946 | USE_MDFILE_AS_MAINPAGE = README.md |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 947 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 948 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 949 | # Configuration options related to source browsing |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 950 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 951 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 952 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 953 | # generated. Documented entities will be cross-referenced with these sources. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 954 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 955 | # Note: To get rid of all source code in the generated output, make sure that |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 956 | # also VERBATIM_HEADERS is set to NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 957 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 958 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 959 | SOURCE_BROWSER = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 960 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 961 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 962 | # classes and enums directly into the documentation. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 963 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 964 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 965 | INLINE_SOURCES = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 966 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 967 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 968 | # special comment blocks from generated source code fragments. Normal C, C++ and |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 969 | # Fortran comments will always remain visible. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 970 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 971 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 972 | STRIP_CODE_COMMENTS = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 973 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 974 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 975 | # function all documented functions referencing it will be listed. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 976 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 977 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 978 | REFERENCED_BY_RELATION = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 979 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 980 | # If the REFERENCES_RELATION tag is set to YES then for each documented function |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 981 | # all documented entities called/used by that function will be listed. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 982 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 983 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 984 | REFERENCES_RELATION = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 985 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 986 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 987 | # to YES, then the hyperlinks from functions in REFERENCES_RELATION and |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 988 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 989 | # link to the documentation. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 990 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 991 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 992 | REFERENCES_LINK_SOURCE = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 993 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 994 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 995 | # source code will show a tooltip with additional information such as prototype, |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 996 | # brief description and links to the definition and documentation. Since this |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 997 | # will make the HTML file larger and loading of large files a bit slower, you |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 998 | # can opt to disable this feature. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 999 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1000 | # This tag requires that the tag SOURCE_BROWSER is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1001 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1002 | SOURCE_TOOLTIPS = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1003 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1004 | # If the USE_HTAGS tag is set to YES then the references to source code will |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1005 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1006 | # source browser. The htags tool is part of GNU's global source tagging system |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1007 | # (see http://www.gnu.org/software/global/global.html). You will need version |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1008 | # 4.8.6 or higher. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1009 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1010 | # To use it do the following: |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1011 | # - Install the latest version of global |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1012 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1013 | # - Make sure the INPUT points to the root of the source tree |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1014 | # - Run doxygen as normal |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1015 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1016 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1017 | # tools must be available from the command line (i.e. in the search path). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1018 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1019 | # The result: instead of the source browser generated by doxygen, the links to |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1020 | # source code will now point to the output of htags. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1021 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1022 | # This tag requires that the tag SOURCE_BROWSER is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1023 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1024 | USE_HTAGS = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1025 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1026 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1027 | # verbatim copy of the header file for each class for which an include is |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1028 | # specified. Set to NO to disable this. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1029 | # See also: Section \class. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1030 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1031 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1032 | VERBATIM_HEADERS = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1033 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1034 | # If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1035 | # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1036 | # cost of reduced performance. This can be particularly helpful with template |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1037 | # rich C++ code for which doxygen's built-in parser lacks the necessary type |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1038 | # information. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1039 | # Note: The availability of this option depends on whether or not doxygen was |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1040 | # compiled with the --with-libclang option. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1041 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1042 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1043 | CLANG_ASSISTED_PARSING = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1044 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1045 | # If clang assisted parsing is enabled you can provide the compiler with command |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1046 | # line options that you would normally use when invoking the compiler. Note that |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1047 | # the include paths will already be set by doxygen for the files and directories |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1048 | # specified with INPUT and INCLUDE_PATH. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1049 | # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1050 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1051 | CLANG_OPTIONS = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1052 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1053 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1054 | # Configuration options related to the alphabetical class index |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1055 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1056 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1057 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1058 | # compounds will be generated. Enable this if the project contains a lot of |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1059 | # classes, structs, unions or interfaces. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1060 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1061 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1062 | ALPHABETICAL_INDEX = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1063 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1064 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1065 | # which the alphabetical index list will be split. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1066 | # Minimum value: 1, maximum value: 20, default value: 5. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1067 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1068 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1069 | COLS_IN_ALPHA_INDEX = 5 |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1070 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1071 | # In case all classes in a project start with a common prefix, all classes will |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1072 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1073 | # can be used to specify a prefix (or a list of prefixes) that should be ignored |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1074 | # while generating the index headers. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1075 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1076 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1077 | IGNORE_PREFIX = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1078 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1079 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1080 | # Configuration options related to the HTML output |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1081 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1082 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1083 | # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1084 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1085 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1086 | GENERATE_HTML = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1087 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1088 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1089 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1090 | # it. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1091 | # The default directory is: html. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1092 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1093 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1094 | HTML_OUTPUT = html |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1095 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1096 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1097 | # generated HTML page (for example: .htm, .php, .asp). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1098 | # The default value is: .html. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1099 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1100 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1101 | HTML_FILE_EXTENSION = .html |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1102 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1103 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1104 | # each generated HTML page. If the tag is left blank doxygen will generate a |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1105 | # standard header. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1106 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1107 | # To get valid HTML the header file that includes any scripts and style sheets |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1108 | # that doxygen needs, which is dependent on the configuration options used (e.g. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1109 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1110 | # default header using |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1111 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1112 | # YourConfigFile |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1113 | # and then modify the file new_header.html. See also section "Doxygen usage" |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1114 | # for information on how to generate the default header that doxygen normally |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1115 | # uses. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1116 | # Note: The header is subject to change so you typically have to regenerate the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1117 | # default header when upgrading to a newer version of doxygen. For a description |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1118 | # of the possible markers and block names see the documentation. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1119 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1120 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1121 | HTML_HEADER = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1122 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1123 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1124 | # generated HTML page. If the tag is left blank doxygen will generate a standard |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1125 | # footer. See HTML_HEADER for more information on how to generate a default |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1126 | # footer and what special commands can be used inside the footer. See also |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1127 | # section "Doxygen usage" for information on how to generate the default footer |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1128 | # that doxygen normally uses. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1129 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1130 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1131 | HTML_FOOTER = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1132 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1133 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1134 | # sheet that is used by each HTML page. It can be used to fine-tune the look of |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1135 | # the HTML output. If left blank doxygen will generate a default style sheet. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1136 | # See also section "Doxygen usage" for information on how to generate the style |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1137 | # sheet that doxygen normally uses. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1138 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1139 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1140 | # obsolete. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1141 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1142 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1143 | HTML_STYLESHEET = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1144 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1145 | # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1146 | # defined cascading style sheet that is included after the standard style sheets |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1147 | # created by doxygen. Using this option one can overrule certain style aspects. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1148 | # This is preferred over using HTML_STYLESHEET since it does not replace the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1149 | # standard style sheet and is therefor more robust against future updates. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1150 | # Doxygen will copy the style sheet file to the output directory. For an example |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1151 | # see the documentation. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1152 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1153 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1154 | HTML_EXTRA_STYLESHEET = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1155 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1156 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1157 | # other source files which should be copied to the HTML output directory. Note |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1158 | # that these files will be copied to the base HTML output directory. Use the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1159 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1160 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1161 | # files will be copied as-is; there are no commands or markers available. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1162 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1163 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1164 | HTML_EXTRA_FILES = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1165 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1166 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1167 | # will adjust the colors in the stylesheet and background images according to |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1168 | # this color. Hue is specified as an angle on a colorwheel, see |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1169 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1170 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1171 | # purple, and 360 is red again. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1172 | # Minimum value: 0, maximum value: 359, default value: 220. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1173 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1174 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1175 | HTML_COLORSTYLE_HUE = 220 |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1176 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1177 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1178 | # in the HTML output. For a value of 0 the output will use grayscales only. A |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1179 | # value of 255 will produce the most vivid colors. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1180 | # Minimum value: 0, maximum value: 255, default value: 100. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1181 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1182 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1183 | HTML_COLORSTYLE_SAT = 100 |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1184 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1185 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1186 | # luminance component of the colors in the HTML output. Values below 100 |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1187 | # gradually make the output lighter, whereas values above 100 make the output |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1188 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1189 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1190 | # change the gamma. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1191 | # Minimum value: 40, maximum value: 240, default value: 80. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1192 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1193 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1194 | HTML_COLORSTYLE_GAMMA = 80 |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1195 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1196 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1197 | # page will contain the date and time when the page was generated. Setting this |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1198 | # to NO can help when comparing the output of multiple runs. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1199 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1200 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1201 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1202 | HTML_TIMESTAMP = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1203 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1204 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1205 | # documentation will contain sections that can be hidden and shown after the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1206 | # page has loaded. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1207 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1208 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1209 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1210 | HTML_DYNAMIC_SECTIONS = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1211 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1212 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1213 | # shown in the various tree structured indices initially; the user can expand |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1214 | # and collapse entries dynamically later on. Doxygen will expand the tree to |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1215 | # such a level that at most the specified number of entries are visible (unless |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1216 | # a fully collapsed tree already exceeds this amount). So setting the number of |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1217 | # entries 1 will produce a full collapsed tree by default. 0 is a special value |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1218 | # representing an infinite number of entries and will result in a full expanded |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1219 | # tree by default. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1220 | # Minimum value: 0, maximum value: 9999, default value: 100. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1221 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1222 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1223 | HTML_INDEX_NUM_ENTRIES = 100 |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1224 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1225 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1226 | # generated that can be used as input for Apple's Xcode 3 integrated development |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1227 | # environment (see: http://developer.apple.com/tools/xcode/), introduced with |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1228 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1229 | # Makefile in the HTML output directory. Running make will produce the docset in |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1230 | # that directory and running make install will install the docset in |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1231 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1232 | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1233 | # for more information. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1234 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1235 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1236 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1237 | GENERATE_DOCSET = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1238 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1239 | # This tag determines the name of the docset feed. A documentation feed provides |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1240 | # an umbrella under which multiple documentation sets from a single provider |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1241 | # (such as a company or product suite) can be grouped. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1242 | # The default value is: Doxygen generated docs. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1243 | # This tag requires that the tag GENERATE_DOCSET is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1244 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1245 | DOCSET_FEEDNAME = "Doxygen generated docs" |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1246 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1247 | # This tag specifies a string that should uniquely identify the documentation |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1248 | # set bundle. This should be a reverse domain-name style string, e.g. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1249 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1250 | # The default value is: org.doxygen.Project. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1251 | # This tag requires that the tag GENERATE_DOCSET is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1252 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1253 | DOCSET_BUNDLE_ID = org.doxygen.Project |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1254 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1255 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1256 | # the documentation publisher. This should be a reverse domain-name style |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1257 | # string, e.g. com.mycompany.MyDocSet.documentation. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1258 | # The default value is: org.doxygen.Publisher. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1259 | # This tag requires that the tag GENERATE_DOCSET is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1260 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1261 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1262 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1263 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1264 | # The default value is: Publisher. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1265 | # This tag requires that the tag GENERATE_DOCSET is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1266 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1267 | DOCSET_PUBLISHER_NAME = Publisher |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1268 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1269 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1270 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1271 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1272 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1273 | # Windows. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1274 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1275 | # The HTML Help Workshop contains a compiler that can convert all HTML output |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1276 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1277 | # files are now used as the Windows 98 help format, and will replace the old |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1278 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1279 | # HTML files also contain an index, a table of contents, and you can search for |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1280 | # words in the documentation. The HTML workshop also contains a viewer for |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1281 | # compressed HTML files. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1282 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1283 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1284 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1285 | GENERATE_HTMLHELP = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1286 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1287 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1288 | # file. You can add a path in front of the file if the result should not be |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1289 | # written to the html output directory. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1290 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1291 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1292 | CHM_FILE = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1293 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1294 | # The HHC_LOCATION tag can be used to specify the location (absolute path |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1295 | # including file name) of the HTML help compiler ( hhc.exe). If non-empty |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1296 | # doxygen will try to run the HTML help compiler on the generated index.hhp. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1297 | # The file has to be specified with full path. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1298 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1299 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1300 | HHC_LOCATION = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1301 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1302 | # The GENERATE_CHI flag controls if a separate .chi index file is generated ( |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1303 | # YES) or that it should be included in the master .chm file ( NO). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1304 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1305 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1306 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1307 | GENERATE_CHI = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1308 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1309 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1310 | # and project file content. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1311 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1312 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1313 | CHM_INDEX_ENCODING = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1314 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1315 | # The BINARY_TOC flag controls whether a binary table of contents is generated ( |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1316 | # YES) or a normal table of contents ( NO) in the .chm file. Furthermore it |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1317 | # enables the Previous and Next buttons. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1318 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1319 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1320 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1321 | BINARY_TOC = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1322 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1323 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1324 | # the table of contents of the HTML help documentation and to the tree view. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1325 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1326 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1327 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1328 | TOC_EXPAND = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1329 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1330 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1331 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1332 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1333 | # (.qch) of the generated HTML documentation. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1334 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1335 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1336 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1337 | GENERATE_QHP = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1338 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1339 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1340 | # the file name of the resulting .qch file. The path specified is relative to |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1341 | # the HTML output folder. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1342 | # This tag requires that the tag GENERATE_QHP is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1343 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1344 | QCH_FILE = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1345 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1346 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1347 | # Project output. For more information please see Qt Help Project / Namespace |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1348 | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1349 | # The default value is: org.doxygen.Project. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1350 | # This tag requires that the tag GENERATE_QHP is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1351 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1352 | QHP_NAMESPACE = org.doxygen.Project |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1353 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1354 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1355 | # Help Project output. For more information please see Qt Help Project / Virtual |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1356 | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1357 | # folders). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1358 | # The default value is: doc. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1359 | # This tag requires that the tag GENERATE_QHP is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1360 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1361 | QHP_VIRTUAL_FOLDER = doc |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1362 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1363 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1364 | # filter to add. For more information please see Qt Help Project / Custom |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1365 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1366 | # filters). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1367 | # This tag requires that the tag GENERATE_QHP is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1368 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1369 | QHP_CUST_FILTER_NAME = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1370 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1371 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1372 | # custom filter to add. For more information please see Qt Help Project / Custom |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1373 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1374 | # filters). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1375 | # This tag requires that the tag GENERATE_QHP is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1376 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1377 | QHP_CUST_FILTER_ATTRS = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1378 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1379 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1380 | # project's filter section matches. Qt Help Project / Filter Attributes (see: |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1381 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1382 | # This tag requires that the tag GENERATE_QHP is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1383 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1384 | QHP_SECT_FILTER_ATTRS = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1385 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1386 | # The QHG_LOCATION tag can be used to specify the location of Qt's |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1387 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1388 | # generated .qhp file. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1389 | # This tag requires that the tag GENERATE_QHP is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1390 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1391 | QHG_LOCATION = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1392 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1393 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1394 | # generated, together with the HTML files, they form an Eclipse help plugin. To |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1395 | # install this plugin and make it available under the help contents menu in |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1396 | # Eclipse, the contents of the directory containing the HTML and XML files needs |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1397 | # to be copied into the plugins directory of eclipse. The name of the directory |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1398 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1399 | # After copying Eclipse needs to be restarted before the help appears. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1400 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1401 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1402 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1403 | GENERATE_ECLIPSEHELP = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1404 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1405 | # A unique identifier for the Eclipse help plugin. When installing the plugin |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1406 | # the directory name containing the HTML and XML files should also have this |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1407 | # name. Each documentation set should have its own identifier. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1408 | # The default value is: org.doxygen.Project. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1409 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1410 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1411 | ECLIPSE_DOC_ID = org.doxygen.Project |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1412 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1413 | # If you want full control over the layout of the generated HTML pages it might |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1414 | # be necessary to disable the index and replace it with your own. The |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1415 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1416 | # of each HTML page. A value of NO enables the index and the value YES disables |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1417 | # it. Since the tabs in the index contain the same information as the navigation |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1418 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1419 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1420 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1421 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1422 | DISABLE_INDEX = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1423 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1424 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1425 | # structure should be generated to display hierarchical information. If the tag |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1426 | # value is set to YES, a side panel will be generated containing a tree-like |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1427 | # index structure (just like the one that is generated for HTML Help). For this |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1428 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1429 | # (i.e. any modern browser). Windows users are probably better off using the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1430 | # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1431 | # further fine-tune the look of the index. As an example, the default style |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1432 | # sheet generated by doxygen has an example that shows how to put an image at |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1433 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1434 | # the same information as the tab index, you could consider setting |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1435 | # DISABLE_INDEX to YES when enabling this option. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1436 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1437 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1438 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1439 | GENERATE_TREEVIEW = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1440 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1441 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1442 | # doxygen will group on one line in the generated HTML documentation. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1443 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1444 | # Note that a value of 0 will completely suppress the enum values from appearing |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1445 | # in the overview section. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1446 | # Minimum value: 0, maximum value: 20, default value: 4. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1447 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1448 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1449 | ENUM_VALUES_PER_LINE = 4 |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1450 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1451 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1452 | # to set the initial width (in pixels) of the frame in which the tree is shown. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1453 | # Minimum value: 0, maximum value: 1500, default value: 250. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1454 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1455 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1456 | TREEVIEW_WIDTH = 250 |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1457 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1458 | # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1459 | # external symbols imported via tag files in a separate window. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1460 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1461 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1462 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1463 | EXT_LINKS_IN_WINDOW = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1464 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1465 | # Use this tag to change the font size of LaTeX formulas included as images in |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1466 | # the HTML documentation. When you change the font size after a successful |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1467 | # doxygen run you need to manually remove any form_*.png images from the HTML |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1468 | # output directory to force them to be regenerated. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1469 | # Minimum value: 8, maximum value: 50, default value: 10. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1470 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1471 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1472 | FORMULA_FONTSIZE = 10 |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1473 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1474 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1475 | # generated for formulas are transparent PNGs. Transparent PNGs are not |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1476 | # supported properly for IE 6.0, but are supported on all modern browsers. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1477 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1478 | # Note that when changing this option you need to delete any form_*.png files in |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1479 | # the HTML output directory before the changes have effect. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1480 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1481 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1482 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1483 | FORMULA_TRANSPARENT = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1484 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1485 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1486 | # http://www.mathjax.org) which uses client side Javascript for the rendering |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1487 | # instead of using prerendered bitmaps. Use this if you do not have LaTeX |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1488 | # installed or if you want to formulas look prettier in the HTML output. When |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1489 | # enabled you may also need to install MathJax separately and configure the path |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1490 | # to it using the MATHJAX_RELPATH option. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1491 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1492 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1493 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1494 | USE_MATHJAX = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1495 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1496 | # When MathJax is enabled you can set the default output format to be used for |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1497 | # the MathJax output. See the MathJax site (see: |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1498 | # http://docs.mathjax.org/en/latest/output.html) for more details. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1499 | # Possible values are: HTML-CSS (which is slower, but has the best |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1500 | # compatibility), NativeMML (i.e. MathML) and SVG. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1501 | # The default value is: HTML-CSS. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1502 | # This tag requires that the tag USE_MATHJAX is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1503 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1504 | MATHJAX_FORMAT = HTML-CSS |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1505 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1506 | # When MathJax is enabled you need to specify the location relative to the HTML |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1507 | # output directory using the MATHJAX_RELPATH option. The destination directory |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1508 | # should contain the MathJax.js script. For instance, if the mathjax directory |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1509 | # is located at the same level as the HTML output directory, then |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1510 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1511 | # Content Delivery Network so you can quickly see the result without installing |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1512 | # MathJax. However, it is strongly recommended to install a local copy of |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1513 | # MathJax from http://www.mathjax.org before deployment. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1514 | # The default value is: http://cdn.mathjax.org/mathjax/latest. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1515 | # This tag requires that the tag USE_MATHJAX is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1516 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1517 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1518 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1519 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1520 | # extension names that should be enabled during MathJax rendering. For example |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1521 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1522 | # This tag requires that the tag USE_MATHJAX is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1523 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1524 | MATHJAX_EXTENSIONS = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1525 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1526 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1527 | # of code that will be used on startup of the MathJax code. See the MathJax site |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1528 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1529 | # example see the documentation. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1530 | # This tag requires that the tag USE_MATHJAX is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1531 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1532 | MATHJAX_CODEFILE = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1533 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1534 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1535 | # the HTML output. The underlying search engine uses javascript and DHTML and |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1536 | # should work on any modern browser. Note that when using HTML help |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1537 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1538 | # there is already a search function so this one should typically be disabled. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1539 | # For large projects the javascript based search engine can be slow, then |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1540 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1541 | # search using the keyboard; to jump to the search box use <access key> + S |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1542 | # (what the <access key> is depends on the OS and browser, but it is typically |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1543 | # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1544 | # key> to jump into the search results window, the results can be navigated |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1545 | # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1546 | # the search. The filter options can be selected when the cursor is inside the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1547 | # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1548 | # to select a filter and <Enter> or <escape> to activate or cancel the filter |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1549 | # option. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1550 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1551 | # This tag requires that the tag GENERATE_HTML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1552 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1553 | SEARCHENGINE = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1554 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1555 | # When the SERVER_BASED_SEARCH tag is enabled the search engine will be |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1556 | # implemented using a web server instead of a web client using Javascript. There |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1557 | # are two flavors of web server based searching depending on the EXTERNAL_SEARCH |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1558 | # setting. When disabled, doxygen will generate a PHP script for searching and |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1559 | # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1560 | # and searching needs to be provided by external tools. See the section |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1561 | # "External Indexing and Searching" for details. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1562 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1563 | # This tag requires that the tag SEARCHENGINE is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1564 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1565 | SERVER_BASED_SEARCH = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1566 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1567 | # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1568 | # script for searching. Instead the search results are written to an XML file |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1569 | # which needs to be processed by an external indexer. Doxygen will invoke an |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1570 | # external search engine pointed to by the SEARCHENGINE_URL option to obtain the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1571 | # search results. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1572 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1573 | # Doxygen ships with an example indexer ( doxyindexer) and search engine |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1574 | # (doxysearch.cgi) which are based on the open source search engine library |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1575 | # Xapian (see: http://xapian.org/). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1576 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1577 | # See the section "External Indexing and Searching" for details. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1578 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1579 | # This tag requires that the tag SEARCHENGINE is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1580 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1581 | EXTERNAL_SEARCH = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1582 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1583 | # The SEARCHENGINE_URL should point to a search engine hosted by a web server |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1584 | # which will return the search results when EXTERNAL_SEARCH is enabled. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1585 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1586 | # Doxygen ships with an example indexer ( doxyindexer) and search engine |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1587 | # (doxysearch.cgi) which are based on the open source search engine library |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1588 | # Xapian (see: http://xapian.org/). See the section "External Indexing and |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1589 | # Searching" for details. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1590 | # This tag requires that the tag SEARCHENGINE is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1591 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1592 | SEARCHENGINE_URL = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1593 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1594 | # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1595 | # search data is written to a file for indexing by an external tool. With the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1596 | # SEARCHDATA_FILE tag the name of this file can be specified. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1597 | # The default file is: searchdata.xml. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1598 | # This tag requires that the tag SEARCHENGINE is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1599 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1600 | SEARCHDATA_FILE = searchdata.xml |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1601 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1602 | # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1603 | # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1604 | # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1605 | # projects and redirect the results back to the right project. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1606 | # This tag requires that the tag SEARCHENGINE is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1607 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1608 | EXTERNAL_SEARCH_ID = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1609 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1610 | # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1611 | # projects other than the one defined by this configuration file, but that are |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1612 | # all added to the same external search index. Each project needs to have a |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1613 | # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1614 | # to a relative location where the documentation can be found. The format is: |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1615 | # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1616 | # This tag requires that the tag SEARCHENGINE is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1617 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1618 | EXTRA_SEARCH_MAPPINGS = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1619 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1620 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1621 | # Configuration options related to the LaTeX output |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1622 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1623 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1624 | # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1625 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1626 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1627 | GENERATE_LATEX = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1628 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1629 | # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1630 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1631 | # it. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1632 | # The default directory is: latex. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1633 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1634 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1635 | LATEX_OUTPUT = latex |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1636 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1637 | # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1638 | # invoked. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1639 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1640 | # Note that when enabling USE_PDFLATEX this option is only used for generating |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1641 | # bitmaps for formulas in the HTML output, but not in the Makefile that is |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1642 | # written to the output directory. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1643 | # The default file is: latex. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1644 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1645 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1646 | LATEX_CMD_NAME = latex |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1647 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1648 | # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1649 | # index for LaTeX. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1650 | # The default file is: makeindex. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1651 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1652 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1653 | MAKEINDEX_CMD_NAME = makeindex |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1654 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1655 | # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1656 | # documents. This may be useful for small projects and may help to save some |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1657 | # trees in general. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1658 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1659 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1660 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1661 | COMPACT_LATEX = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1662 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1663 | # The PAPER_TYPE tag can be used to set the paper type that is used by the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1664 | # printer. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1665 | # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1666 | # 14 inches) and executive (7.25 x 10.5 inches). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1667 | # The default value is: a4. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1668 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1669 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1670 | PAPER_TYPE = a4 |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1671 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1672 | # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1673 | # that should be included in the LaTeX output. To get the times font for |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1674 | # instance you can specify |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1675 | # EXTRA_PACKAGES=times |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1676 | # If left blank no extra packages will be included. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1677 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1678 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1679 | EXTRA_PACKAGES = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1680 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1681 | # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1682 | # generated LaTeX document. The header should contain everything until the first |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1683 | # chapter. If it is left blank doxygen will generate a standard header. See |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1684 | # section "Doxygen usage" for information on how to let doxygen write the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1685 | # default header to a separate file. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1686 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1687 | # Note: Only use a user-defined header if you know what you are doing! The |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1688 | # following commands have a special meaning inside the header: $title, |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1689 | # $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1690 | # replace them by respectively the title of the page, the current date and time, |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1691 | # only the current date, the version number of doxygen, the project name (see |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1692 | # PROJECT_NAME), or the project number (see PROJECT_NUMBER). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1693 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1694 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1695 | LATEX_HEADER = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1696 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1697 | # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1698 | # generated LaTeX document. The footer should contain everything after the last |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1699 | # chapter. If it is left blank doxygen will generate a standard footer. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1700 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1701 | # Note: Only use a user-defined footer if you know what you are doing! |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1702 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1703 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1704 | LATEX_FOOTER = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1705 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1706 | # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1707 | # other source files which should be copied to the LATEX_OUTPUT output |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1708 | # directory. Note that the files will be copied as-is; there are no commands or |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1709 | # markers available. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1710 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1711 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1712 | LATEX_EXTRA_FILES = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1713 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1714 | # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1715 | # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1716 | # contain links (just like the HTML output) instead of page references. This |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1717 | # makes the output suitable for online browsing using a PDF viewer. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1718 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1719 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1720 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1721 | PDF_HYPERLINKS = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1722 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1723 | # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1724 | # the PDF file directly from the LaTeX files. Set this option to YES to get a |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1725 | # higher quality PDF documentation. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1726 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1727 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1728 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1729 | USE_PDFLATEX = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1730 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1731 | # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1732 | # command to the generated LaTeX files. This will instruct LaTeX to keep running |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1733 | # if errors occur, instead of asking the user for help. This option is also used |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1734 | # when generating formulas in HTML. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1735 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1736 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1737 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1738 | LATEX_BATCHMODE = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1739 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1740 | # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1741 | # index chapters (such as File Index, Compound Index, etc.) in the output. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1742 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1743 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1744 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1745 | LATEX_HIDE_INDICES = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1746 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1747 | # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1748 | # code with syntax highlighting in the LaTeX output. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1749 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1750 | # Note that which sources are shown also depends on other settings such as |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1751 | # SOURCE_BROWSER. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1752 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1753 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1754 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1755 | LATEX_SOURCE_CODE = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1756 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1757 | # The LATEX_BIB_STYLE tag can be used to specify the style to use for the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1758 | # bibliography, e.g. plainnat, or ieeetr. See |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1759 | # http://en.wikipedia.org/wiki/BibTeX and \cite for more info. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1760 | # The default value is: plain. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1761 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1762 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1763 | LATEX_BIB_STYLE = plain |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1764 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1765 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1766 | # Configuration options related to the RTF output |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1767 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1768 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1769 | # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1770 | # RTF output is optimized for Word 97 and may not look too pretty with other RTF |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1771 | # readers/editors. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1772 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1773 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1774 | GENERATE_RTF = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1775 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1776 | # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1777 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1778 | # it. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1779 | # The default directory is: rtf. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1780 | # This tag requires that the tag GENERATE_RTF is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1781 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1782 | RTF_OUTPUT = rtf |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1783 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1784 | # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1785 | # documents. This may be useful for small projects and may help to save some |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1786 | # trees in general. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1787 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1788 | # This tag requires that the tag GENERATE_RTF is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1789 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1790 | COMPACT_RTF = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1791 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1792 | # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1793 | # contain hyperlink fields. The RTF file will contain links (just like the HTML |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1794 | # output) instead of page references. This makes the output suitable for online |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1795 | # browsing using Word or some other Word compatible readers that support those |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1796 | # fields. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1797 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1798 | # Note: WordPad (write) and others do not support links. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1799 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1800 | # This tag requires that the tag GENERATE_RTF is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1801 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1802 | RTF_HYPERLINKS = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1803 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1804 | # Load stylesheet definitions from file. Syntax is similar to doxygen's config |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1805 | # file, i.e. a series of assignments. You only have to provide replacements, |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1806 | # missing definitions are set to their default value. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1807 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1808 | # See also section "Doxygen usage" for information on how to generate the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1809 | # default style sheet that doxygen normally uses. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1810 | # This tag requires that the tag GENERATE_RTF is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1811 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1812 | RTF_STYLESHEET_FILE = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1813 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1814 | # Set optional variables used in the generation of an RTF document. Syntax is |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1815 | # similar to doxygen's config file. A template extensions file can be generated |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1816 | # using doxygen -e rtf extensionFile. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1817 | # This tag requires that the tag GENERATE_RTF is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1818 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1819 | RTF_EXTENSIONS_FILE = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1820 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1821 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1822 | # Configuration options related to the man page output |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1823 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1824 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1825 | # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1826 | # classes and files. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1827 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1828 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1829 | GENERATE_MAN = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1830 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1831 | # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1832 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1833 | # it. A directory man3 will be created inside the directory specified by |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1834 | # MAN_OUTPUT. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1835 | # The default directory is: man. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1836 | # This tag requires that the tag GENERATE_MAN is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1837 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1838 | MAN_OUTPUT = man |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1839 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1840 | # The MAN_EXTENSION tag determines the extension that is added to the generated |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1841 | # man pages. In case the manual section does not start with a number, the number |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1842 | # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1843 | # optional. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1844 | # The default value is: .3. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1845 | # This tag requires that the tag GENERATE_MAN is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1846 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1847 | MAN_EXTENSION = .3 |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1848 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1849 | # The MAN_SUBDIR tag determines the name of the directory created within |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1850 | # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1851 | # MAN_EXTENSION with the initial . removed. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1852 | # This tag requires that the tag GENERATE_MAN is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1853 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1854 | MAN_SUBDIR = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1855 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1856 | # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1857 | # will generate one additional man file for each entity documented in the real |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1858 | # man page(s). These additional files only source the real man page, but without |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1859 | # them the man command would be unable to find the correct page. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1860 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1861 | # This tag requires that the tag GENERATE_MAN is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1862 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1863 | MAN_LINKS = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1864 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1865 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1866 | # Configuration options related to the XML output |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1867 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1868 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1869 | # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1870 | # captures the structure of the code including all documentation. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1871 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1872 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1873 | GENERATE_XML = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1874 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1875 | # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1876 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1877 | # it. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1878 | # The default directory is: xml. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1879 | # This tag requires that the tag GENERATE_XML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1880 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1881 | XML_OUTPUT = xml |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1882 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1883 | # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1884 | # listings (including syntax highlighting and cross-referencing information) to |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1885 | # the XML output. Note that enabling this will significantly increase the size |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1886 | # of the XML output. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1887 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1888 | # This tag requires that the tag GENERATE_XML is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1889 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1890 | XML_PROGRAMLISTING = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1891 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1892 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1893 | # Configuration options related to the DOCBOOK output |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1894 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1895 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1896 | # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1897 | # that can be used to generate PDF. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1898 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1899 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1900 | GENERATE_DOCBOOK = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1901 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1902 | # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1903 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1904 | # front of it. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1905 | # The default directory is: docbook. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1906 | # This tag requires that the tag GENERATE_DOCBOOK is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1907 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1908 | DOCBOOK_OUTPUT = docbook |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1909 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1910 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1911 | # Configuration options for the AutoGen Definitions output |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1912 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1913 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1914 | # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1915 | # Definitions (see http://autogen.sf.net) file that captures the structure of |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1916 | # the code including all documentation. Note that this feature is still |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1917 | # experimental and incomplete at the moment. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1918 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1919 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1920 | GENERATE_AUTOGEN_DEF = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1921 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1922 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1923 | # Configuration options related to the Perl module output |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1924 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1925 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1926 | # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1927 | # file that captures the structure of the code including all documentation. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1928 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1929 | # Note that this feature is still experimental and incomplete at the moment. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1930 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1931 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1932 | GENERATE_PERLMOD = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1933 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1934 | # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1935 | # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1936 | # output from the Perl module output. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1937 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1938 | # This tag requires that the tag GENERATE_PERLMOD is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1939 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1940 | PERLMOD_LATEX = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1941 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1942 | # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1943 | # formatted so it can be parsed by a human reader. This is useful if you want to |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1944 | # understand what is going on. On the other hand, if this tag is set to NO the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1945 | # size of the Perl module output will be much smaller and Perl will parse it |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1946 | # just the same. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1947 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1948 | # This tag requires that the tag GENERATE_PERLMOD is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1949 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1950 | PERLMOD_PRETTY = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1951 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1952 | # The names of the make variables in the generated doxyrules.make file are |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1953 | # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1954 | # so different doxyrules.make files included by the same Makefile don't |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1955 | # overwrite each other's variables. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1956 | # This tag requires that the tag GENERATE_PERLMOD is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1957 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1958 | PERLMOD_MAKEVAR_PREFIX = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1959 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1960 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1961 | # Configuration options related to the preprocessor |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1962 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1963 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1964 | # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1965 | # C-preprocessor directives found in the sources and include files. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1966 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1967 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1968 | ENABLE_PREPROCESSING = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1969 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1970 | # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1971 | # in the source code. If set to NO only conditional compilation will be |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1972 | # performed. Macro expansion can be done in a controlled way by setting |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1973 | # EXPAND_ONLY_PREDEF to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1974 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1975 | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1976 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1977 | MACRO_EXPANSION = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1978 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1979 | # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1980 | # the macro expansion is limited to the macros specified with the PREDEFINED and |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1981 | # EXPAND_AS_DEFINED tags. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1982 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1983 | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1984 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1985 | EXPAND_ONLY_PREDEF = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1986 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1987 | # If the SEARCH_INCLUDES tag is set to YES the includes files in the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1988 | # INCLUDE_PATH will be searched if a #include is found. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1989 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1990 | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1991 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1992 | SEARCH_INCLUDES = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1993 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1994 | # The INCLUDE_PATH tag can be used to specify one or more directories that |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1995 | # contain include files that are not input files but should be processed by the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1996 | # preprocessor. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1997 | # This tag requires that the tag SEARCH_INCLUDES is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1998 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 1999 | INCLUDE_PATH = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2000 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2001 | # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2002 | # patterns (like *.h and *.hpp) to filter out the header-files in the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2003 | # directories. If left blank, the patterns specified with FILE_PATTERNS will be |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2004 | # used. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2005 | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2006 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2007 | INCLUDE_FILE_PATTERNS = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2008 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2009 | # The PREDEFINED tag can be used to specify one or more macro names that are |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2010 | # defined before the preprocessor is started (similar to the -D option of e.g. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2011 | # gcc). The argument of the tag is a list of macros of the form: name or |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2012 | # name=definition (no spaces). If the definition and the "=" are omitted, "=1" |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2013 | # is assumed. To prevent a macro definition from being undefined via #undef or |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2014 | # recursively expanded use the := operator instead of the = operator. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2015 | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2016 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2017 | PREDEFINED = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2018 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2019 | # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2020 | # tag can be used to specify a list of macro names that should be expanded. The |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2021 | # macro definition that is found in the sources will be used. Use the PREDEFINED |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2022 | # tag if you want to use a different macro definition that overrules the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2023 | # definition found in the source code. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2024 | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2025 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2026 | EXPAND_AS_DEFINED = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2027 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2028 | # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2029 | # remove all references to function-like macros that are alone on a line, have |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2030 | # an all uppercase name, and do not end with a semicolon. Such function macros |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2031 | # are typically used for boiler-plate code, and will confuse the parser if not |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2032 | # removed. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2033 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2034 | # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2035 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2036 | SKIP_FUNCTION_MACROS = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2037 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2038 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2039 | # Configuration options related to external references |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2040 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2041 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2042 | # The TAGFILES tag can be used to specify one or more tag files. For each tag |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2043 | # file the location of the external documentation should be added. The format of |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2044 | # a tag file without this location is as follows: |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2045 | # TAGFILES = file1 file2 ... |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2046 | # Adding location for the tag files is done as follows: |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2047 | # TAGFILES = file1=loc1 "file2 = loc2" ... |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2048 | # where loc1 and loc2 can be relative or absolute paths or URLs. See the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2049 | # section "Linking to external documentation" for more information about the use |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2050 | # of tag files. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2051 | # Note: Each tag file must have a unique name (where the name does NOT include |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2052 | # the path). If a tag file is not located in the directory in which doxygen is |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2053 | # run, you must also specify the path to the tagfile here. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2054 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2055 | TAGFILES = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2056 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2057 | # When a file name is specified after GENERATE_TAGFILE, doxygen will create a |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2058 | # tag file that is based on the input files it reads. See section "Linking to |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2059 | # external documentation" for more information about the usage of tag files. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2060 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2061 | GENERATE_TAGFILE = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2062 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2063 | # If the ALLEXTERNALS tag is set to YES all external class will be listed in the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2064 | # class index. If set to NO only the inherited external classes will be listed. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2065 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2066 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2067 | ALLEXTERNALS = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2068 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2069 | # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2070 | # the modules index. If set to NO, only the current project's groups will be |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2071 | # listed. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2072 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2073 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2074 | EXTERNAL_GROUPS = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2075 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2076 | # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2077 | # the related pages index. If set to NO, only the current project's pages will |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2078 | # be listed. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2079 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2080 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2081 | EXTERNAL_PAGES = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2082 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2083 | # The PERL_PATH should be the absolute path and name of the perl script |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2084 | # interpreter (i.e. the result of 'which perl'). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2085 | # The default file (with absolute path) is: /usr/bin/perl. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2086 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2087 | PERL_PATH = /usr/bin/perl |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2088 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2089 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2090 | # Configuration options related to the dot tool |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2091 | #--------------------------------------------------------------------------- |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2092 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2093 | # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2094 | # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2095 | # NO turns the diagrams off. Note that this option also works with HAVE_DOT |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2096 | # disabled, but it is recommended to install and use dot, since it yields more |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2097 | # powerful graphs. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2098 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2099 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2100 | CLASS_DIAGRAMS = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2101 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2102 | # You can define message sequence charts within doxygen comments using the \msc |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2103 | # command. Doxygen will then run the mscgen tool (see: |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2104 | # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2105 | # documentation. The MSCGEN_PATH tag allows you to specify the directory where |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2106 | # the mscgen tool resides. If left empty the tool is assumed to be found in the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2107 | # default search path. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2108 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2109 | MSCGEN_PATH = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2110 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2111 | # You can include diagrams made with dia in doxygen documentation. Doxygen will |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2112 | # then run dia to produce the diagram and insert it in the documentation. The |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2113 | # DIA_PATH tag allows you to specify the directory where the dia binary resides. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2114 | # If left empty dia is assumed to be found in the default search path. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2115 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2116 | DIA_PATH = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2117 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2118 | # If set to YES, the inheritance and collaboration graphs will hide inheritance |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2119 | # and usage relations if the target is undocumented or is not a class. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2120 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2121 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2122 | HIDE_UNDOC_RELATIONS = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2123 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2124 | # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2125 | # available from the path. This tool is part of Graphviz (see: |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2126 | # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2127 | # Bell Labs. The other options in this section have no effect if this option is |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2128 | # set to NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2129 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2130 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2131 | HAVE_DOT = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2132 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2133 | # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2134 | # to run in parallel. When set to 0 doxygen will base this on the number of |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2135 | # processors available in the system. You can set it explicitly to a value |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2136 | # larger than 0 to get control over the balance between CPU load and processing |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2137 | # speed. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2138 | # Minimum value: 0, maximum value: 32, default value: 0. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2139 | # This tag requires that the tag HAVE_DOT is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2140 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2141 | DOT_NUM_THREADS = 0 |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2142 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2143 | # When you want a differently looking font n the dot files that doxygen |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2144 | # generates you can specify the font name using DOT_FONTNAME. You need to make |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2145 | # sure dot is able to find the font, which can be done by putting it in a |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2146 | # standard location or by setting the DOTFONTPATH environment variable or by |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2147 | # setting DOT_FONTPATH to the directory containing the font. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2148 | # The default value is: Helvetica. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2149 | # This tag requires that the tag HAVE_DOT is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2150 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2151 | DOT_FONTNAME = Helvetica |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2152 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2153 | # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2154 | # dot graphs. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2155 | # Minimum value: 4, maximum value: 24, default value: 10. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2156 | # This tag requires that the tag HAVE_DOT is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2157 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2158 | DOT_FONTSIZE = 10 |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2159 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2160 | # By default doxygen will tell dot to use the default font as specified with |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2161 | # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2162 | # the path where dot can find it using this tag. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2163 | # This tag requires that the tag HAVE_DOT is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2164 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2165 | DOT_FONTPATH = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2166 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2167 | # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2168 | # each documented class showing the direct and indirect inheritance relations. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2169 | # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2170 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2171 | # This tag requires that the tag HAVE_DOT is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2172 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2173 | CLASS_GRAPH = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2174 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2175 | # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2176 | # graph for each documented class showing the direct and indirect implementation |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2177 | # dependencies (inheritance, containment, and class references variables) of the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2178 | # class with other documented classes. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2179 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2180 | # This tag requires that the tag HAVE_DOT is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2181 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2182 | COLLABORATION_GRAPH = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2183 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2184 | # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2185 | # groups, showing the direct groups dependencies. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2186 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2187 | # This tag requires that the tag HAVE_DOT is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2188 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2189 | GROUP_GRAPHS = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2190 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2191 | # If the UML_LOOK tag is set to YES doxygen will generate inheritance and |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2192 | # collaboration diagrams in a style similar to the OMG's Unified Modeling |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2193 | # Language. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2194 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2195 | # This tag requires that the tag HAVE_DOT is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2196 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2197 | UML_LOOK = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2198 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2199 | # If the UML_LOOK tag is enabled, the fields and methods are shown inside the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2200 | # class node. If there are many fields or methods and many nodes the graph may |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2201 | # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2202 | # number of items for each type to make the size more manageable. Set this to 0 |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2203 | # for no limit. Note that the threshold may be exceeded by 50% before the limit |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2204 | # is enforced. So when you set the threshold to 10, up to 15 fields may appear, |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2205 | # but if the number exceeds 15, the total amount of fields shown is limited to |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2206 | # 10. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2207 | # Minimum value: 0, maximum value: 100, default value: 10. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2208 | # This tag requires that the tag HAVE_DOT is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2209 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2210 | UML_LIMIT_NUM_FIELDS = 10 |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2211 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2212 | # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2213 | # collaboration graphs will show the relations between templates and their |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2214 | # instances. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2215 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2216 | # This tag requires that the tag HAVE_DOT is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2217 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2218 | TEMPLATE_RELATIONS = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2219 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2220 | # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2221 | # YES then doxygen will generate a graph for each documented file showing the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2222 | # direct and indirect include dependencies of the file with other documented |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2223 | # files. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2224 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2225 | # This tag requires that the tag HAVE_DOT is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2226 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2227 | INCLUDE_GRAPH = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2228 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2229 | # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2230 | # set to YES then doxygen will generate a graph for each documented file showing |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2231 | # the direct and indirect include dependencies of the file with other documented |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2232 | # files. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2233 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2234 | # This tag requires that the tag HAVE_DOT is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2235 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2236 | INCLUDED_BY_GRAPH = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2237 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2238 | # If the CALL_GRAPH tag is set to YES then doxygen will generate a call |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2239 | # dependency graph for every global function or class method. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2240 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2241 | # Note that enabling this option will significantly increase the time of a run. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2242 | # So in most cases it will be better to enable call graphs for selected |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2243 | # functions only using the \callgraph command. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2244 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2245 | # This tag requires that the tag HAVE_DOT is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2246 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2247 | CALL_GRAPH = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2248 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2249 | # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2250 | # dependency graph for every global function or class method. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2251 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2252 | # Note that enabling this option will significantly increase the time of a run. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2253 | # So in most cases it will be better to enable caller graphs for selected |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2254 | # functions only using the \callergraph command. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2255 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2256 | # This tag requires that the tag HAVE_DOT is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2257 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2258 | CALLER_GRAPH = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2259 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2260 | # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2261 | # hierarchy of all classes instead of a textual one. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2262 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2263 | # This tag requires that the tag HAVE_DOT is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2264 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2265 | GRAPHICAL_HIERARCHY = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2266 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2267 | # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2268 | # dependencies a directory has on other directories in a graphical way. The |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2269 | # dependency relations are determined by the #include relations between the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2270 | # files in the directories. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2271 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2272 | # This tag requires that the tag HAVE_DOT is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2273 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2274 | DIRECTORY_GRAPH = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2275 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2276 | # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2277 | # generated by dot. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2278 | # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2279 | # to make the SVG files visible in IE 9+ (other browsers do not have this |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2280 | # requirement). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2281 | # Possible values are: png, jpg, gif and svg. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2282 | # The default value is: png. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2283 | # This tag requires that the tag HAVE_DOT is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2284 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2285 | DOT_IMAGE_FORMAT = png |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2286 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2287 | # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2288 | # enable generation of interactive SVG images that allow zooming and panning. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2289 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2290 | # Note that this requires a modern browser other than Internet Explorer. Tested |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2291 | # and working are Firefox, Chrome, Safari, and Opera. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2292 | # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2293 | # the SVG files visible. Older versions of IE do not have SVG support. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2294 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2295 | # This tag requires that the tag HAVE_DOT is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2296 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2297 | INTERACTIVE_SVG = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2298 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2299 | # The DOT_PATH tag can be used to specify the path where the dot tool can be |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2300 | # found. If left blank, it is assumed the dot tool can be found in the path. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2301 | # This tag requires that the tag HAVE_DOT is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2302 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2303 | DOT_PATH = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2304 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2305 | # The DOTFILE_DIRS tag can be used to specify one or more directories that |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2306 | # contain dot files that are included in the documentation (see the \dotfile |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2307 | # command). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2308 | # This tag requires that the tag HAVE_DOT is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2309 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2310 | DOTFILE_DIRS = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2311 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2312 | # The MSCFILE_DIRS tag can be used to specify one or more directories that |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2313 | # contain msc files that are included in the documentation (see the \mscfile |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2314 | # command). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2315 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2316 | MSCFILE_DIRS = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2317 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2318 | # The DIAFILE_DIRS tag can be used to specify one or more directories that |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2319 | # contain dia files that are included in the documentation (see the \diafile |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2320 | # command). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2321 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2322 | DIAFILE_DIRS = |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2323 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2324 | # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2325 | # that will be shown in the graph. If the number of nodes in a graph becomes |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2326 | # larger than this value, doxygen will truncate the graph, which is visualized |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2327 | # by representing a node as a red box. Note that doxygen if the number of direct |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2328 | # children of the root node in a graph is already larger than |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2329 | # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2330 | # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2331 | # Minimum value: 0, maximum value: 10000, default value: 50. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2332 | # This tag requires that the tag HAVE_DOT is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2333 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2334 | DOT_GRAPH_MAX_NODES = 50 |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2335 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2336 | # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2337 | # generated by dot. A depth value of 3 means that only nodes reachable from the |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2338 | # root by following a path via at most 3 edges will be shown. Nodes that lay |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2339 | # further from the root node will be omitted. Note that setting this option to 1 |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2340 | # or 2 may greatly reduce the computation time needed for large code bases. Also |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2341 | # note that the size of a graph can be further restricted by |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2342 | # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2343 | # Minimum value: 0, maximum value: 1000, default value: 0. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2344 | # This tag requires that the tag HAVE_DOT is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2345 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2346 | MAX_DOT_GRAPH_DEPTH = 0 |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2347 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2348 | # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2349 | # background. This is disabled by default, because dot on Windows does not seem |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2350 | # to support this out of the box. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2351 | # |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2352 | # Warning: Depending on the platform used, enabling this option may lead to |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2353 | # badly anti-aliased labels on the edges of a graph (i.e. they become hard to |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2354 | # read). |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2355 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2356 | # This tag requires that the tag HAVE_DOT is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2357 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2358 | DOT_TRANSPARENT = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2359 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2360 | # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2361 | # files in one run (i.e. multiple -o and -T options on the command line). This |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2362 | # makes dot run faster, but since only newer versions of dot (>1.8.10) support |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2363 | # this, this feature is disabled by default. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2364 | # The default value is: NO. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2365 | # This tag requires that the tag HAVE_DOT is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2366 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2367 | DOT_MULTI_TARGETS = NO |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2368 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2369 | # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2370 | # explaining the meaning of the various boxes and arrows in the dot generated |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2371 | # graphs. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2372 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2373 | # This tag requires that the tag HAVE_DOT is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2374 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2375 | GENERATE_LEGEND = YES |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2376 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2377 | # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2378 | # files that are used to generate the various graphs. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2379 | # The default value is: YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2380 | # This tag requires that the tag HAVE_DOT is set to YES. |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2381 | |
| rob.meades@u-blox.com | 1:ed57b6ca43ab | 2382 | DOT_CLEANUP = YES |