Doxyfile revision 9264:1607119c36bb
16019SN/A# Doxyfile 1.3.6 26019SN/A 310346Smitch.hayenga@arm.com# This file describes the settings to be used by the documentation system 47134Sgblack@eecs.umich.edu# doxygen (www.doxygen.org) for a project 57134Sgblack@eecs.umich.edu# 67134Sgblack@eecs.umich.edu# All text after a hash (#) is considered a comment and will be ignored 77134Sgblack@eecs.umich.edu# The format is: 87134Sgblack@eecs.umich.edu# TAG = value [value, ...] 97134Sgblack@eecs.umich.edu# For lists items can also be appended using: 107134Sgblack@eecs.umich.edu# TAG += value [value, ...] 117134Sgblack@eecs.umich.edu# Values that contain spaces should be placed between quotes (" ") 127134Sgblack@eecs.umich.edu 137134Sgblack@eecs.umich.edu#--------------------------------------------------------------------------- 147134Sgblack@eecs.umich.edu# Project related configuration options 156019SN/A#--------------------------------------------------------------------------- 166019SN/A 176019SN/A# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 186019SN/A# by quotes) that should identify the project. 196019SN/A 206019SN/APROJECT_NAME = M5 216019SN/A 226019SN/A# The PROJECT_NUMBER tag can be used to enter a project or revision number. 236019SN/A# This could be handy for archiving the generated documentation or 246019SN/A# if some version control system is used. 256019SN/A 266019SN/APROJECT_NUMBER = 276019SN/A 286019SN/A# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 296019SN/A# base path where the generated documentation will be put. 306019SN/A# If a relative path is entered, it will be relative to the location 316019SN/A# where doxygen was started. If left blank the current directory will be used. 326019SN/A 336019SN/AOUTPUT_DIRECTORY = doxygen 346019SN/A 356019SN/A# The OUTPUT_LANGUAGE tag is used to specify the language in which all 366019SN/A# documentation generated by doxygen is written. Doxygen will use this 376019SN/A# information to generate all constant output in the proper language. 386019SN/A# The default language is English, other supported languages are: 396019SN/A# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, 406019SN/A# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en 416019SN/A# (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese, 426308SN/A# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. 436308SN/A 446309SN/AOUTPUT_LANGUAGE = English 456309SN/A 466309SN/A# This tag can be used to specify the encoding used in the generated output. 476309SN/A# The encoding is not always determined by the language that is chosen, 486309SN/A# but also whether or not the output is meant for Windows or non-Windows users. 497134Sgblack@eecs.umich.edu# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 508588Sgblack@eecs.umich.edu# forces the Windows encoding (this is the default for the Windows binary), 516309SN/A# whereas setting the tag to NO uses a Unix-style encoding (the default for 526309SN/A# all platforms other than Windows). 537296Sgblack@eecs.umich.edu 548139SMatt.Horsnell@arm.comUSE_WINDOWS_ENCODING = NO 556309SN/A 566309SN/A# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 576309SN/A# include brief member descriptions after the members that are listed in 5810346Smitch.hayenga@arm.com# the file and class documentation (similar to JavaDoc). 5910346Smitch.hayenga@arm.com# Set to NO to disable this. 6010346Smitch.hayenga@arm.com 6110346Smitch.hayenga@arm.comBRIEF_MEMBER_DESC = YES 6210346Smitch.hayenga@arm.com 6310346Smitch.hayenga@arm.com# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 6410346Smitch.hayenga@arm.com# the brief description of a member or function before the detailed description. 6510346Smitch.hayenga@arm.com# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 6610346Smitch.hayenga@arm.com# brief descriptions will be completely suppressed. 6710346Smitch.hayenga@arm.com 6810346Smitch.hayenga@arm.comREPEAT_BRIEF = YES 6910346Smitch.hayenga@arm.com 708588Sgblack@eecs.umich.edu# This tag implements a quasi-intelligent brief description abbreviator 717174Sgblack@eecs.umich.edu# that is used to form the text in various listings. Each string 727639Sgblack@eecs.umich.edu# in this list, if found as the leading text of the brief description, will be 737639Sgblack@eecs.umich.edu# stripped from the text and the result after processing the whole list, is used 747644Sali.saidi@arm.com# as the annotated text. Otherwise, the brief description is used as-is. If left 758139SMatt.Horsnell@arm.com# blank, the following values are used ("$name" is automatically replaced with the 767639Sgblack@eecs.umich.edu# name of the entity): "The $name class" "The $name widget" "The $name file" 777639Sgblack@eecs.umich.edu# "is" "provides" "specifies" "contains" "represents" "a" "an" "the" 787639Sgblack@eecs.umich.edu 798588Sgblack@eecs.umich.eduABBREVIATE_BRIEF = 807639Sgblack@eecs.umich.edu 817639Sgblack@eecs.umich.edu# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 827639Sgblack@eecs.umich.edu# Doxygen will generate a detailed section even if there is only a brief 837644Sali.saidi@arm.com# description. 848139SMatt.Horsnell@arm.com 857639Sgblack@eecs.umich.eduALWAYS_DETAILED_SEC = YES 867639Sgblack@eecs.umich.edu 877639Sgblack@eecs.umich.edu# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited 887639Sgblack@eecs.umich.edu# members of a class in the documentation of that class as if those members were 897639Sgblack@eecs.umich.edu# ordinary class members. Constructors, destructors and assignment operators of 908588Sgblack@eecs.umich.edu# the base classes will not be shown. 917639Sgblack@eecs.umich.edu 927639Sgblack@eecs.umich.eduINLINE_INHERITED_MEMB = NO 937639Sgblack@eecs.umich.edu 947644Sali.saidi@arm.com# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 958139SMatt.Horsnell@arm.com# path before files name in the file list and in the header files. If set 967639Sgblack@eecs.umich.edu# to NO the shortest path that makes the file name unique will be used. 977639Sgblack@eecs.umich.edu 987639Sgblack@eecs.umich.eduFULL_PATH_NAMES = YES 997639Sgblack@eecs.umich.edu 1007174Sgblack@eecs.umich.edu# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 1018148SAli.Saidi@ARM.com# can be used to strip a user-defined part of the path. Stripping is 1028303SAli.Saidi@ARM.com# only done if one of the specified strings matches the left-hand part of 1037400SAli.Saidi@ARM.com# the path. It is allowed to use relative paths in the argument list. 1048303SAli.Saidi@ARM.com# If left blank the directory from which doxygen is run is used as the 1058303SAli.Saidi@ARM.com# path to strip. 10610037SARM gem5 Developers 10710037SARM gem5 DevelopersSTRIP_FROM_PATH = . 1088303SAli.Saidi@ARM.com 1098303SAli.Saidi@ARM.com# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 1108303SAli.Saidi@ARM.com# (but less readable) file names. This can be useful is your file systems 1118303SAli.Saidi@ARM.com# doesn't support long names like on DOS, Mac, or CD-ROM. 1128303SAli.Saidi@ARM.com 1138303SAli.Saidi@ARM.comSHORT_NAMES = NO 1148205SAli.Saidi@ARM.com 1157858SMatt.Horsnell@arm.com# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 1168285SPrakash.Ramrakhyani@arm.com# will interpret the first line (until the first dot) of a JavaDoc-style 1176754SN/A# comment as the brief description. If set to NO, the JavaDoc 1188148SAli.Saidi@ARM.com# comments will behave just like the Qt-style comments (thus requiring an 1196754SN/A# explicit @brief command for a brief description. 1206754SN/A 1218148SAli.Saidi@ARM.comJAVADOC_AUTOBRIEF = YES 1228588Sgblack@eecs.umich.edu 1236754SN/A# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 1248139SMatt.Horsnell@arm.com# treat a multi-line C++ special comment block (i.e. a block of //! or /// 1257422Sgblack@eecs.umich.edu# comments) as a brief description. This used to be the default behaviour. 1268148SAli.Saidi@ARM.com# The new default is to treat a multi-line C++ comment block as a detailed 1278148SAli.Saidi@ARM.com# description. Set this tag to YES if you prefer the old behaviour instead. 1286754SN/A 1298588Sgblack@eecs.umich.eduMULTILINE_CPP_IS_BRIEF = NO 1306309SN/A 1316309SN/A# If the DETAILS_AT_TOP tag is set to YES then Doxygen 1327296Sgblack@eecs.umich.edu# will output the detailed description near the top, like JavaDoc. 1337303Sgblack@eecs.umich.edu# If set to NO, the detailed description appears after the member 1348139SMatt.Horsnell@arm.com# documentation. 1356309SN/A 1366309SN/ADETAILS_AT_TOP = NO 1376309SN/A 1388588Sgblack@eecs.umich.edu# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 1397174Sgblack@eecs.umich.edu# member inherits the documentation from any documented member that it 1407174Sgblack@eecs.umich.edu# re-implements. 1417296Sgblack@eecs.umich.edu 1427303Sgblack@eecs.umich.eduINHERIT_DOCS = YES 1437644Sali.saidi@arm.com 1448139SMatt.Horsnell@arm.com# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 1457174Sgblack@eecs.umich.edu# tag is set to YES, then doxygen will reuse the documentation of the first 1467174Sgblack@eecs.umich.edu# member in the group (if any) for the other members of the group. By default 1477174Sgblack@eecs.umich.edu# all members of a group must be documented explicitly. 1488588Sgblack@eecs.umich.edu 1497639Sgblack@eecs.umich.eduDISTRIBUTE_GROUP_DOC = NO 1507639Sgblack@eecs.umich.edu 1517639Sgblack@eecs.umich.edu# The TAB_SIZE tag can be used to set the number of spaces in a tab. 1527639Sgblack@eecs.umich.edu# Doxygen uses this value to replace tabs by spaces in code fragments. 1537644Sali.saidi@arm.com 1548139SMatt.Horsnell@arm.comTAB_SIZE = 8 1557639Sgblack@eecs.umich.edu 1567639Sgblack@eecs.umich.edu# This tag can be used to specify a number of aliases that acts 1577639Sgblack@eecs.umich.edu# as commands in the documentation. An alias has the form "name=value". 1587639Sgblack@eecs.umich.edu# For example adding "sideeffect=\par Side Effects:\n" will allow you to 1597639Sgblack@eecs.umich.edu# put the command \sideeffect (or @sideeffect) in the documentation, which 1608588Sgblack@eecs.umich.edu# will result in a user-defined paragraph with heading "Side Effects:". 1617639Sgblack@eecs.umich.edu# You can put \n's in the value part of an alias to insert newlines. 1627639Sgblack@eecs.umich.edu 1637639Sgblack@eecs.umich.eduALIASES = 1647639Sgblack@eecs.umich.edu 1657644Sali.saidi@arm.com# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 1668139SMatt.Horsnell@arm.com# only. Doxygen will then generate output that is more tailored for C. 1677639Sgblack@eecs.umich.edu# For instance, some of the names that are used will be different. The list 1687639Sgblack@eecs.umich.edu# of all members will be omitted, etc. 1697639Sgblack@eecs.umich.edu 1707639Sgblack@eecs.umich.eduOPTIMIZE_OUTPUT_FOR_C = NO 1717639Sgblack@eecs.umich.edu 1727174Sgblack@eecs.umich.edu# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources 1737174Sgblack@eecs.umich.edu# only. Doxygen will then generate output that is more tailored for Java. 17410346Smitch.hayenga@arm.com# For instance, namespaces will be presented as packages, qualified scopes 17510346Smitch.hayenga@arm.com# will look different, etc. 1767639Sgblack@eecs.umich.edu 1777639Sgblack@eecs.umich.eduOPTIMIZE_OUTPUT_JAVA = NO 1787174Sgblack@eecs.umich.edu 1797174Sgblack@eecs.umich.edu# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 1807174Sgblack@eecs.umich.edu# the same type (for instance a group of public functions) to be put as a 1817174Sgblack@eecs.umich.edu# subgroup of that type (e.g. under the Public Functions section). Set it to 1827174Sgblack@eecs.umich.edu# NO to prevent subgrouping. Alternatively, this can be done per class using 1837174Sgblack@eecs.umich.edu# the \nosubgrouping command. 1847174Sgblack@eecs.umich.edu 1857174Sgblack@eecs.umich.eduSUBGROUPING = YES 1867174Sgblack@eecs.umich.edu 1877174Sgblack@eecs.umich.edu#--------------------------------------------------------------------------- 1887174Sgblack@eecs.umich.edu# Build related configuration options 18910346Smitch.hayenga@arm.com#--------------------------------------------------------------------------- 19010346Smitch.hayenga@arm.com 19110346Smitch.hayenga@arm.com# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 19210346Smitch.hayenga@arm.com# documentation are documented, even if no documentation was available. 19310346Smitch.hayenga@arm.com# Private class members and static file members will be hidden unless 19410346Smitch.hayenga@arm.com# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 1956309SN/A 1966308SN/AEXTRACT_ALL = YES 1977639Sgblack@eecs.umich.edu 1987639Sgblack@eecs.umich.edu# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 1997639Sgblack@eecs.umich.edu# will be included in the documentation. 20010037SARM gem5 Developers 2017639Sgblack@eecs.umich.eduEXTRACT_PRIVATE = YES 2027639Sgblack@eecs.umich.edu 2037639Sgblack@eecs.umich.edu# If the EXTRACT_STATIC tag is set to YES all static members of a file 2047639Sgblack@eecs.umich.edu# will be included in the documentation. 2057639Sgblack@eecs.umich.edu 2067639Sgblack@eecs.umich.eduEXTRACT_STATIC = YES 2077639Sgblack@eecs.umich.edu 2087639Sgblack@eecs.umich.edu# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 2097639Sgblack@eecs.umich.edu# defined locally in source files will be included in the documentation. 2107639Sgblack@eecs.umich.edu# If set to NO only classes defined in header files are included. 2117639Sgblack@eecs.umich.edu 2127639Sgblack@eecs.umich.eduEXTRACT_LOCAL_CLASSES = YES 2137639Sgblack@eecs.umich.edu 2147639Sgblack@eecs.umich.edu# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 2157639Sgblack@eecs.umich.edu# undocumented members of documented classes, files or namespaces. 2167639Sgblack@eecs.umich.edu# If set to NO (the default) these members will be included in the 2177639Sgblack@eecs.umich.edu# various overviews, but no documentation section is generated. 2187639Sgblack@eecs.umich.edu# This option has no effect if EXTRACT_ALL is enabled. 2197639Sgblack@eecs.umich.edu 2207639Sgblack@eecs.umich.eduHIDE_UNDOC_MEMBERS = NO 2217639Sgblack@eecs.umich.edu 2227639Sgblack@eecs.umich.edu# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 2237639Sgblack@eecs.umich.edu# undocumented classes that are normally visible in the class hierarchy. 2247639Sgblack@eecs.umich.edu# If set to NO (the default) these classes will be included in the various 2257639Sgblack@eecs.umich.edu# overviews. This option has no effect if EXTRACT_ALL is enabled. 2267639Sgblack@eecs.umich.edu 2277639Sgblack@eecs.umich.eduHIDE_UNDOC_CLASSES = YES 2287639Sgblack@eecs.umich.edu 2297639Sgblack@eecs.umich.edu# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 2307639Sgblack@eecs.umich.edu# friend (class|struct|union) declarations. 2317639Sgblack@eecs.umich.edu# If set to NO (the default) these declarations will be included in the 2327639Sgblack@eecs.umich.edu# documentation. 2337639Sgblack@eecs.umich.edu 2347639Sgblack@eecs.umich.eduHIDE_FRIEND_COMPOUNDS = NO 2357639Sgblack@eecs.umich.edu 2368588Sgblack@eecs.umich.edu# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 2377639Sgblack@eecs.umich.edu# documentation blocks found inside the body of a function. 2387639Sgblack@eecs.umich.edu# If set to NO (the default) these blocks will be appended to the 2397639Sgblack@eecs.umich.edu# function's detailed documentation block. 2407639Sgblack@eecs.umich.edu 2417639Sgblack@eecs.umich.eduHIDE_IN_BODY_DOCS = NO 2427639Sgblack@eecs.umich.edu 2438588Sgblack@eecs.umich.edu# The INTERNAL_DOCS tag determines if documentation 2447639Sgblack@eecs.umich.edu# that is typed after a \internal command is included. If the tag is set 2457639Sgblack@eecs.umich.edu# to NO (the default) then the documentation will be excluded. 2467639Sgblack@eecs.umich.edu# Set it to YES to include the internal documentation. 2477639Sgblack@eecs.umich.edu 2487639Sgblack@eecs.umich.eduINTERNAL_DOCS = NO 2497639Sgblack@eecs.umich.edu 2507639Sgblack@eecs.umich.edu# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 2517639Sgblack@eecs.umich.edu# file names in lower-case letters. If set to YES upper-case letters are also 2527639Sgblack@eecs.umich.edu# allowed. This is useful if you have classes or files whose names only differ 2537639Sgblack@eecs.umich.edu# in case and if your file system supports case sensitive file names. Windows 2547639Sgblack@eecs.umich.edu# users are advised to set this option to NO. 2557644Sali.saidi@arm.com 2567639Sgblack@eecs.umich.eduCASE_SENSE_NAMES = YES 2577639Sgblack@eecs.umich.edu 2587639Sgblack@eecs.umich.edu# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 2597639Sgblack@eecs.umich.edu# will show members with their full class and namespace scopes in the 2607639Sgblack@eecs.umich.edu# documentation. If set to YES the scope will be hidden. 2617639Sgblack@eecs.umich.edu 2627639Sgblack@eecs.umich.eduHIDE_SCOPE_NAMES = NO 2637639Sgblack@eecs.umich.edu 2647644Sali.saidi@arm.com# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 2657639Sgblack@eecs.umich.edu# will put a list of the files that are included by a file in the documentation 2667639Sgblack@eecs.umich.edu# of that file. 2677639Sgblack@eecs.umich.edu 2687639Sgblack@eecs.umich.eduSHOW_INCLUDE_FILES = YES 2697639Sgblack@eecs.umich.edu 2707639Sgblack@eecs.umich.edu# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 2717639Sgblack@eecs.umich.edu# is inserted in the documentation for inline members. 2727639Sgblack@eecs.umich.edu 2737639Sgblack@eecs.umich.eduINLINE_INFO = YES 2747639Sgblack@eecs.umich.edu 2757639Sgblack@eecs.umich.edu# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 2767639Sgblack@eecs.umich.edu# will sort the (detailed) documentation of file and class members 2777639Sgblack@eecs.umich.edu# alphabetically by member name. If set to NO the members will appear in 2787639Sgblack@eecs.umich.edu# declaration order. 2797639Sgblack@eecs.umich.edu 2807639Sgblack@eecs.umich.eduSORT_MEMBER_DOCS = YES 2817639Sgblack@eecs.umich.edu 2827639Sgblack@eecs.umich.edu# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 2837639Sgblack@eecs.umich.edu# brief documentation of file, namespace and class members alphabetically 2847639Sgblack@eecs.umich.edu# by member name. If set to NO (the default) the members will appear in 2857639Sgblack@eecs.umich.edu# declaration order. 2867639Sgblack@eecs.umich.edu 2877639Sgblack@eecs.umich.eduSORT_BRIEF_DOCS = NO 2887639Sgblack@eecs.umich.edu 2897639Sgblack@eecs.umich.edu# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 2907639Sgblack@eecs.umich.edu# sorted by fully-qualified names, including namespaces. If set to 2917639Sgblack@eecs.umich.edu# NO (the default), the class list will be sorted only by class name, 2927639Sgblack@eecs.umich.edu# not including the namespace part. 2937639Sgblack@eecs.umich.edu# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 2947639Sgblack@eecs.umich.edu# Note: This option applies only to the class list, not to the 2957639Sgblack@eecs.umich.edu# alphabetical list. 2967639Sgblack@eecs.umich.edu 2977639Sgblack@eecs.umich.eduSORT_BY_SCOPE_NAME = NO 2987639Sgblack@eecs.umich.edu 2997639Sgblack@eecs.umich.edu# The GENERATE_TODOLIST tag can be used to enable (YES) or 3007639Sgblack@eecs.umich.edu# disable (NO) the todo list. This list is created by putting \todo 3017639Sgblack@eecs.umich.edu# commands in the documentation. 3027639Sgblack@eecs.umich.edu 3037639Sgblack@eecs.umich.eduGENERATE_TODOLIST = YES 3047639Sgblack@eecs.umich.edu 3057639Sgblack@eecs.umich.edu# The GENERATE_TESTLIST tag can be used to enable (YES) or 3067639Sgblack@eecs.umich.edu# disable (NO) the test list. This list is created by putting \test 3077639Sgblack@eecs.umich.edu# commands in the documentation. 3087639Sgblack@eecs.umich.edu 3097639Sgblack@eecs.umich.eduGENERATE_TESTLIST = YES 3107639Sgblack@eecs.umich.edu 3117639Sgblack@eecs.umich.edu# The GENERATE_BUGLIST tag can be used to enable (YES) or 3127639Sgblack@eecs.umich.edu# disable (NO) the bug list. This list is created by putting \bug 3137639Sgblack@eecs.umich.edu# commands in the documentation. 3147639Sgblack@eecs.umich.edu 3158588Sgblack@eecs.umich.eduGENERATE_BUGLIST = YES 3168588Sgblack@eecs.umich.edu 3177639Sgblack@eecs.umich.edu# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 3187639Sgblack@eecs.umich.edu# disable (NO) the deprecated list. This list is created by putting 3198588Sgblack@eecs.umich.edu# \deprecated commands in the documentation. 3208588Sgblack@eecs.umich.edu 3217639Sgblack@eecs.umich.eduGENERATE_DEPRECATEDLIST= YES 3227639Sgblack@eecs.umich.edu 3237639Sgblack@eecs.umich.edu# The ENABLED_SECTIONS tag can be used to enable conditional 3247639Sgblack@eecs.umich.edu# documentation sections, marked by \if sectionname ... \endif. 3257639Sgblack@eecs.umich.edu 3267639Sgblack@eecs.umich.eduENABLED_SECTIONS = 3277639Sgblack@eecs.umich.edu 3287639Sgblack@eecs.umich.edu# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 3297639Sgblack@eecs.umich.edu# the initial value of a variable or define consists of for it to appear in 3307639Sgblack@eecs.umich.edu# the documentation. If the initializer consists of more lines than specified 3317639Sgblack@eecs.umich.edu# here it will be hidden. Use a value of 0 to hide initializers completely. 3327639Sgblack@eecs.umich.edu# The appearance of the initializer of individual variables and defines in the 3337639Sgblack@eecs.umich.edu# documentation can be controlled using \showinitializer or \hideinitializer 3347639Sgblack@eecs.umich.edu# command in the documentation regardless of this setting. 3357639Sgblack@eecs.umich.edu 3367639Sgblack@eecs.umich.eduMAX_INITIALIZER_LINES = 30 3377639Sgblack@eecs.umich.edu 3387639Sgblack@eecs.umich.edu# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 3397639Sgblack@eecs.umich.edu# at the bottom of the documentation of classes and structs. If set to YES the 3407639Sgblack@eecs.umich.edu# list will mention the files that were used to generate the documentation. 3417639Sgblack@eecs.umich.edu 3427639Sgblack@eecs.umich.eduSHOW_USED_FILES = YES 3437639Sgblack@eecs.umich.edu 3447639Sgblack@eecs.umich.edu#--------------------------------------------------------------------------- 3457639Sgblack@eecs.umich.edu# configuration options related to warning and progress messages 3467639Sgblack@eecs.umich.edu#--------------------------------------------------------------------------- 3477639Sgblack@eecs.umich.edu 3487639Sgblack@eecs.umich.edu# The QUIET tag can be used to turn on/off the messages that are generated 3497639Sgblack@eecs.umich.edu# by doxygen. Possible values are YES and NO. If left blank NO is used. 3507639Sgblack@eecs.umich.edu 3517639Sgblack@eecs.umich.eduQUIET = YES 3527639Sgblack@eecs.umich.edu 3537639Sgblack@eecs.umich.edu# The WARNINGS tag can be used to turn on/off the warning messages that are 3547639Sgblack@eecs.umich.edu# generated by doxygen. Possible values are YES and NO. If left blank 3557639Sgblack@eecs.umich.edu# NO is used. 3567639Sgblack@eecs.umich.edu 3577639Sgblack@eecs.umich.eduWARNINGS = YES 3587639Sgblack@eecs.umich.edu 3597639Sgblack@eecs.umich.edu# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 3607639Sgblack@eecs.umich.edu# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 3618588Sgblack@eecs.umich.edu# automatically be disabled. 3628588Sgblack@eecs.umich.edu 3637639Sgblack@eecs.umich.eduWARN_IF_UNDOCUMENTED = YES 3647639Sgblack@eecs.umich.edu 3658588Sgblack@eecs.umich.edu# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 3668588Sgblack@eecs.umich.edu# potential errors in the documentation, such as not documenting some 3677639Sgblack@eecs.umich.edu# parameters in a documented function, or documenting parameters that 3687639Sgblack@eecs.umich.edu# don't exist or using markup commands wrongly. 3697639Sgblack@eecs.umich.edu 3707639Sgblack@eecs.umich.eduWARN_IF_DOC_ERROR = YES 3717639Sgblack@eecs.umich.edu 3727639Sgblack@eecs.umich.edu# The WARN_FORMAT tag determines the format of the warning messages that 3737639Sgblack@eecs.umich.edu# doxygen can produce. The string should contain the $file, $line, and $text 3747639Sgblack@eecs.umich.edu# tags, which will be replaced by the file and line number from which the 3757639Sgblack@eecs.umich.edu# warning originated and the warning text. 3767639Sgblack@eecs.umich.edu 3777639Sgblack@eecs.umich.eduWARN_FORMAT = "$file:$line: $text" 3787639Sgblack@eecs.umich.edu 3797639Sgblack@eecs.umich.edu# The WARN_LOGFILE tag can be used to specify a file to which warning 3807639Sgblack@eecs.umich.edu# and error messages should be written. If left blank the output is written 3817639Sgblack@eecs.umich.edu# to stderr. 3827639Sgblack@eecs.umich.edu 3837639Sgblack@eecs.umich.eduWARN_LOGFILE = 3847639Sgblack@eecs.umich.edu 3857639Sgblack@eecs.umich.edu#--------------------------------------------------------------------------- 3867639Sgblack@eecs.umich.edu# configuration options related to the input files 3877639Sgblack@eecs.umich.edu#--------------------------------------------------------------------------- 3887639Sgblack@eecs.umich.edu 3897639Sgblack@eecs.umich.edu# The INPUT tag can be used to specify the files and/or directories that contain 3907639Sgblack@eecs.umich.edu# documented source files. You may enter file names like "myfile.cpp" or 3917639Sgblack@eecs.umich.edu# directories like "/usr/src/myproject". Separate the files or directories 3927639Sgblack@eecs.umich.edu# with spaces. 3937639Sgblack@eecs.umich.edu 3947639Sgblack@eecs.umich.eduINPUT = . 3957639Sgblack@eecs.umich.edu 3967639Sgblack@eecs.umich.edu# If the value of the INPUT tag contains directories, you can use the 3977639Sgblack@eecs.umich.edu# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 3987639Sgblack@eecs.umich.edu# and *.h) to filter out the source-files in the directories. If left 3997639Sgblack@eecs.umich.edu# blank the following patterns are tested: 4007639Sgblack@eecs.umich.edu# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp 4017639Sgblack@eecs.umich.edu# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc 4027639Sgblack@eecs.umich.edu 4037639Sgblack@eecs.umich.eduFILE_PATTERNS = *.c \ 4047639Sgblack@eecs.umich.edu *.cc \ 4057639Sgblack@eecs.umich.edu *.h \ 4067639Sgblack@eecs.umich.edu *.hh \ 4077639Sgblack@eecs.umich.edu *.doxygen 4087639Sgblack@eecs.umich.edu 4097639Sgblack@eecs.umich.edu# The RECURSIVE tag can be used to turn specify whether or not subdirectories 4107639Sgblack@eecs.umich.edu# should be searched for input files as well. Possible values are YES and NO. 4117639Sgblack@eecs.umich.edu# If left blank NO is used. 4127639Sgblack@eecs.umich.edu 4137639Sgblack@eecs.umich.eduRECURSIVE = YES 4147639Sgblack@eecs.umich.edu 4157639Sgblack@eecs.umich.edu# The EXCLUDE tag can be used to specify files and/or directories that should 4167639Sgblack@eecs.umich.edu# excluded from the INPUT source files. This way you can easily exclude a 4177639Sgblack@eecs.umich.edu# subdirectory from a directory tree whose root is specified with the INPUT tag. 4187639Sgblack@eecs.umich.edu 4197639Sgblack@eecs.umich.eduEXCLUDE = build \ 4207639Sgblack@eecs.umich.edu configs \ 4217639Sgblack@eecs.umich.edu setup \ 4227639Sgblack@eecs.umich.edu PENDING \ 4237639Sgblack@eecs.umich.edu RESYNC 4247639Sgblack@eecs.umich.edu 4257639Sgblack@eecs.umich.edu# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories 4267639Sgblack@eecs.umich.edu# that are symbolic links (a Unix filesystem feature) are excluded from the input. 4278588Sgblack@eecs.umich.edu 4288588Sgblack@eecs.umich.eduEXCLUDE_SYMLINKS = YES 4297639Sgblack@eecs.umich.edu 4307639Sgblack@eecs.umich.edu# If the value of the INPUT tag contains directories, you can use the 4317639Sgblack@eecs.umich.edu# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 4327639Sgblack@eecs.umich.edu# certain files from those directories. 4337639Sgblack@eecs.umich.edu 4347639Sgblack@eecs.umich.eduEXCLUDE_PATTERNS = */BitKeeper/* \ 4357639Sgblack@eecs.umich.edu */Attic/* \ 4368588Sgblack@eecs.umich.edu */SCCS/* 4378588Sgblack@eecs.umich.edu 4387639Sgblack@eecs.umich.edu# The EXAMPLE_PATH tag can be used to specify one or more files or 4397639Sgblack@eecs.umich.edu# directories that contain example code fragments that are included (see 4408588Sgblack@eecs.umich.edu# the \include command). 4418588Sgblack@eecs.umich.edu 4427639Sgblack@eecs.umich.eduEXAMPLE_PATH = 4437639Sgblack@eecs.umich.edu 4447639Sgblack@eecs.umich.edu# If the value of the EXAMPLE_PATH tag contains directories, you can use the 4457639Sgblack@eecs.umich.edu# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 4467639Sgblack@eecs.umich.edu# and *.h) to filter out the source-files in the directories. If left 4477639Sgblack@eecs.umich.edu# blank all files are included. 4487639Sgblack@eecs.umich.edu 4497639Sgblack@eecs.umich.eduEXAMPLE_PATTERNS = 4507639Sgblack@eecs.umich.edu 4517639Sgblack@eecs.umich.edu# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 4527639Sgblack@eecs.umich.edu# searched for input files to be used with the \include or \dontinclude 4537639Sgblack@eecs.umich.edu# commands irrespective of the value of the RECURSIVE tag. 4547639Sgblack@eecs.umich.edu# Possible values are YES and NO. If left blank NO is used. 4557639Sgblack@eecs.umich.edu 4567639Sgblack@eecs.umich.eduEXAMPLE_RECURSIVE = NO 4577639Sgblack@eecs.umich.edu 4587639Sgblack@eecs.umich.edu# The IMAGE_PATH tag can be used to specify one or more files or 4597639Sgblack@eecs.umich.edu# directories that contain image that are included in the documentation (see 4607639Sgblack@eecs.umich.edu# the \image command). 4617639Sgblack@eecs.umich.edu 4627639Sgblack@eecs.umich.eduIMAGE_PATH = doxygen/images 4637639Sgblack@eecs.umich.edu 4647639Sgblack@eecs.umich.edu# The INPUT_FILTER tag can be used to specify a program that doxygen should 4657639Sgblack@eecs.umich.edu# invoke to filter for each input file. Doxygen will invoke the filter program 4667639Sgblack@eecs.umich.edu# by executing (via popen()) the command <filter> <input-file>, where <filter> 4677639Sgblack@eecs.umich.edu# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 4687639Sgblack@eecs.umich.edu# input file. Doxygen will then use the output that the filter program writes 4697639Sgblack@eecs.umich.edu# to standard output. 4707639Sgblack@eecs.umich.edu 4717639Sgblack@eecs.umich.eduINPUT_FILTER = 4727639Sgblack@eecs.umich.edu 4737639Sgblack@eecs.umich.edu# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 4747639Sgblack@eecs.umich.edu# INPUT_FILTER) will be used to filter the input files when producing source 4757639Sgblack@eecs.umich.edu# files to browse (i.e. when SOURCE_BROWSER is set to YES). 4767639Sgblack@eecs.umich.edu 4777639Sgblack@eecs.umich.eduFILTER_SOURCE_FILES = NO 4787639Sgblack@eecs.umich.edu 4797639Sgblack@eecs.umich.edu#--------------------------------------------------------------------------- 4807639Sgblack@eecs.umich.edu# configuration options related to source browsing 4817639Sgblack@eecs.umich.edu#--------------------------------------------------------------------------- 4828588Sgblack@eecs.umich.edu 4838588Sgblack@eecs.umich.edu# If the SOURCE_BROWSER tag is set to YES then a list of source files will 4847639Sgblack@eecs.umich.edu# be generated. Documented entities will be cross-referenced with these sources. 4857639Sgblack@eecs.umich.edu# Note: To get rid of all source code in the generated output, make sure also 4867639Sgblack@eecs.umich.edu# VERBATIM_HEADERS is set to NO. 4877639Sgblack@eecs.umich.edu 4887639Sgblack@eecs.umich.eduSOURCE_BROWSER = YES 4897639Sgblack@eecs.umich.edu 4908588Sgblack@eecs.umich.edu# Setting the INLINE_SOURCES tag to YES will include the body 4918588Sgblack@eecs.umich.edu# of functions and classes directly in the documentation. 4927639Sgblack@eecs.umich.edu 4937639Sgblack@eecs.umich.eduINLINE_SOURCES = NO 4947639Sgblack@eecs.umich.edu 4957639Sgblack@eecs.umich.edu# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 4967639Sgblack@eecs.umich.edu# doxygen to hide any special comment blocks from generated source code 4977639Sgblack@eecs.umich.edu# fragments. Normal C and C++ comments will always remain visible. 4987639Sgblack@eecs.umich.edu 4997639Sgblack@eecs.umich.eduSTRIP_CODE_COMMENTS = YES 5007639Sgblack@eecs.umich.edu 5017639Sgblack@eecs.umich.edu# If the REFERENCED_BY_RELATION tag is set to YES (the default) 5027639Sgblack@eecs.umich.edu# then for each documented function all documented 5037639Sgblack@eecs.umich.edu# functions referencing it will be listed. 5047639Sgblack@eecs.umich.edu 5057639Sgblack@eecs.umich.eduREFERENCED_BY_RELATION = YES 5067639Sgblack@eecs.umich.edu 5077639Sgblack@eecs.umich.edu# If the REFERENCES_RELATION tag is set to YES (the default) 5087639Sgblack@eecs.umich.edu# then for each documented function all documented entities 5097639Sgblack@eecs.umich.edu# called/used by that function will be listed. 5107639Sgblack@eecs.umich.edu 5117639Sgblack@eecs.umich.eduREFERENCES_RELATION = YES 5127639Sgblack@eecs.umich.edu 5137639Sgblack@eecs.umich.edu# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 5147639Sgblack@eecs.umich.edu# will generate a verbatim copy of the header file for each class for 5157639Sgblack@eecs.umich.edu# which an include is specified. Set to NO to disable this. 5167639Sgblack@eecs.umich.edu 5177639Sgblack@eecs.umich.eduVERBATIM_HEADERS = YES 5187639Sgblack@eecs.umich.edu 5197639Sgblack@eecs.umich.edu#--------------------------------------------------------------------------- 5207639Sgblack@eecs.umich.edu# configuration options related to the alphabetical class index 5217639Sgblack@eecs.umich.edu#--------------------------------------------------------------------------- 5227639Sgblack@eecs.umich.edu 5237639Sgblack@eecs.umich.edu# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 5247639Sgblack@eecs.umich.edu# of all compounds will be generated. Enable this if the project 5257639Sgblack@eecs.umich.edu# contains a lot of classes, structs, unions or interfaces. 5267639Sgblack@eecs.umich.edu 5277639Sgblack@eecs.umich.eduALPHABETICAL_INDEX = YES 5287639Sgblack@eecs.umich.edu 5297639Sgblack@eecs.umich.edu# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 5307639Sgblack@eecs.umich.edu# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 5317639Sgblack@eecs.umich.edu# in which this list will be split (can be a number in the range [1..20]) 5327639Sgblack@eecs.umich.edu 5338588Sgblack@eecs.umich.eduCOLS_IN_ALPHA_INDEX = 3 5348588Sgblack@eecs.umich.edu 5357639Sgblack@eecs.umich.edu# In case all classes in a project start with a common prefix, all 5367639Sgblack@eecs.umich.edu# classes will be put under the same header in the alphabetical index. 5377639Sgblack@eecs.umich.edu# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 5387639Sgblack@eecs.umich.edu# should be ignored while generating the index headers. 5397639Sgblack@eecs.umich.edu 5407639Sgblack@eecs.umich.eduIGNORE_PREFIX = 5418588Sgblack@eecs.umich.edu 5428588Sgblack@eecs.umich.edu#--------------------------------------------------------------------------- 5437639Sgblack@eecs.umich.edu# configuration options related to the HTML output 5447639Sgblack@eecs.umich.edu#--------------------------------------------------------------------------- 5457639Sgblack@eecs.umich.edu 5467639Sgblack@eecs.umich.edu# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 5477639Sgblack@eecs.umich.edu# generate HTML output. 5487639Sgblack@eecs.umich.edu 5497639Sgblack@eecs.umich.eduGENERATE_HTML = YES 5507639Sgblack@eecs.umich.edu 5517639Sgblack@eecs.umich.edu# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 5527639Sgblack@eecs.umich.edu# If a relative path is entered the value of OUTPUT_DIRECTORY will be 5537639Sgblack@eecs.umich.edu# put in front of it. If left blank `html' will be used as the default path. 5547639Sgblack@eecs.umich.edu 5557639Sgblack@eecs.umich.eduHTML_OUTPUT = html 5567639Sgblack@eecs.umich.edu 5577639Sgblack@eecs.umich.edu# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 5587639Sgblack@eecs.umich.edu# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 5597639Sgblack@eecs.umich.edu# doxygen will generate files with .html extension. 5607639Sgblack@eecs.umich.edu 5617639Sgblack@eecs.umich.eduHTML_FILE_EXTENSION = .html 5627639Sgblack@eecs.umich.edu 5638309Snate@binkert.org# The HTML_HEADER tag can be used to specify a personal HTML header for 5648309Snate@binkert.org# each generated HTML page. If it is left blank doxygen will generate a 5658309Snate@binkert.org# standard header. 5667639Sgblack@eecs.umich.edu 5677639Sgblack@eecs.umich.eduHTML_HEADER = 5687639Sgblack@eecs.umich.edu 5697639Sgblack@eecs.umich.edu# The HTML_FOOTER tag can be used to specify a personal HTML footer for 5707639Sgblack@eecs.umich.edu# each generated HTML page. If it is left blank doxygen will generate a 5717639Sgblack@eecs.umich.edu# standard footer. 5727639Sgblack@eecs.umich.edu 5737639Sgblack@eecs.umich.eduHTML_FOOTER = doxygen/footer.html 5747639Sgblack@eecs.umich.edu 5757639Sgblack@eecs.umich.edu# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 5767639Sgblack@eecs.umich.edu# style sheet that is used by each HTML page. It can be used to 5777639Sgblack@eecs.umich.edu# fine-tune the look of the HTML output. If the tag is left blank doxygen 5787639Sgblack@eecs.umich.edu# will generate a default style sheet. Note that doxygen will try to copy 5797639Sgblack@eecs.umich.edu# the style sheet file to the HTML output directory, so don't put your own 5807639Sgblack@eecs.umich.edu# stylesheet in the HTML output directory as well, or it will be erased! 5817639Sgblack@eecs.umich.edu 5827639Sgblack@eecs.umich.eduHTML_STYLESHEET = 5837639Sgblack@eecs.umich.edu 5847639Sgblack@eecs.umich.edu# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 5858607Sgblack@eecs.umich.edu# files or namespaces will be aligned in HTML using tables. If set to 5867639Sgblack@eecs.umich.edu# NO a bullet list will be used. 5878607Sgblack@eecs.umich.edu 5887639Sgblack@eecs.umich.eduHTML_ALIGN_MEMBERS = YES 5897639Sgblack@eecs.umich.edu 5907639Sgblack@eecs.umich.edu# If the GENERATE_HTMLHELP tag is set to YES, additional index files 5917639Sgblack@eecs.umich.edu# will be generated that can be used as input for tools like the 5927639Sgblack@eecs.umich.edu# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 5938607Sgblack@eecs.umich.edu# of the generated HTML documentation. 5948607Sgblack@eecs.umich.edu 5957639Sgblack@eecs.umich.eduGENERATE_HTMLHELP = NO 5967639Sgblack@eecs.umich.edu 5977639Sgblack@eecs.umich.edu# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 5986308SN/A# be used to specify the file name of the resulting .chm file. You 5996308SN/A# can add a path in front of the file if the result should not be 6006308SN/A# written to the html output directory. 6016308SN/A 6026308SN/ACHM_FILE = 6036308SN/A 6046308SN/A# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 6057639Sgblack@eecs.umich.edu# be used to specify the location (absolute path including file name) of 6068139SMatt.Horsnell@arm.com# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 6076308SN/A# the HTML help compiler on the generated index.hhp. 6086308SN/A 6096308SN/AHHC_LOCATION = 6108304SAli.Saidi@ARM.com 6118304SAli.Saidi@ARM.com# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 6128304SAli.Saidi@ARM.com# controls if a separate .chi index file is generated (YES) or that 6138304SAli.Saidi@ARM.com# it should be included in the master .chm file (NO). 61410037SARM gem5 Developers 61510037SARM gem5 DevelopersGENERATE_CHI = NO 61610037SARM gem5 Developers 61710037SARM gem5 Developers# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 61810037SARM gem5 Developers# controls whether a binary table of contents is generated (YES) or a 61910037SARM gem5 Developers# normal table of contents (NO) in the .chm file. 62010037SARM gem5 Developers 62110037SARM gem5 DevelopersBINARY_TOC = NO 62210037SARM gem5 Developers 62310474Sandreas.hansson@arm.com# The TOC_EXPAND flag can be set to YES to add extra items for group members 62410037SARM gem5 Developers# to the contents of the HTML help documentation and to the tree view. 62510037SARM gem5 Developers 62610037SARM gem5 DevelopersTOC_EXPAND = NO 62710037SARM gem5 Developers 62810037SARM gem5 Developers# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 62910037SARM gem5 Developers# top of each HTML page. The value NO (the default) enables the index and 63010037SARM gem5 Developers# the value YES disables it. 63110037SARM gem5 Developers 63210037SARM gem5 DevelopersDISABLE_INDEX = NO 63310037SARM gem5 Developers 6347639Sgblack@eecs.umich.edu# This tag can be used to set the number of enum values (range [1..20]) 6357646Sgene.wu@arm.com# that doxygen will group on one line in the generated HTML documentation. 6368304SAli.Saidi@ARM.com 6378304SAli.Saidi@ARM.comENUM_VALUES_PER_LINE = 4 6387639Sgblack@eecs.umich.edu 6397639Sgblack@eecs.umich.edu# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be 6406308SN/A# generated containing a tree-like index structure (just like the one that 6417639Sgblack@eecs.umich.edu# is generated for HTML Help). For this to work a browser that supports 6428139SMatt.Horsnell@arm.com# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 6436308SN/A# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 6446308SN/A# probably better off using the HTML help feature. 6456308SN/A 64610037SARM gem5 DevelopersGENERATE_TREEVIEW = NO 64710037SARM gem5 Developers 64810037SARM gem5 Developers# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 64910037SARM gem5 Developers# used to set the initial width (in pixels) of the frame in which the tree 65010037SARM gem5 Developers# is shown. 6518304SAli.Saidi@ARM.com 6528304SAli.Saidi@ARM.comTREEVIEW_WIDTH = 250 6538304SAli.Saidi@ARM.com 6547646Sgene.wu@arm.com#--------------------------------------------------------------------------- 6557646Sgene.wu@arm.com# configuration options related to the LaTeX output 6568304SAli.Saidi@ARM.com#--------------------------------------------------------------------------- 6578304SAli.Saidi@ARM.com 6587646Sgene.wu@arm.com# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 6597646Sgene.wu@arm.com# generate Latex output. 6607646Sgene.wu@arm.com 6617646Sgene.wu@arm.comGENERATE_LATEX = NO 6628139SMatt.Horsnell@arm.com 6637646Sgene.wu@arm.com# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 6647646Sgene.wu@arm.com# If a relative path is entered the value of OUTPUT_DIRECTORY will be 6657646Sgene.wu@arm.com# put in front of it. If left blank `latex' will be used as the default path. 6668148SAli.Saidi@ARM.com 6678148SAli.Saidi@ARM.comLATEX_OUTPUT = latex 6688148SAli.Saidi@ARM.com 6698148SAli.Saidi@ARM.com# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 6708148SAli.Saidi@ARM.com# invoked. If left blank `latex' will be used as the default command name. 6718148SAli.Saidi@ARM.com 6728148SAli.Saidi@ARM.comLATEX_CMD_NAME = latex 6738140SMatt.Horsnell@arm.com 6748140SMatt.Horsnell@arm.com# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 6758140SMatt.Horsnell@arm.com# generate index for LaTeX. If left blank `makeindex' will be used as the 6768140SMatt.Horsnell@arm.com# default command name. 6778303SAli.Saidi@ARM.com 67810037SARM gem5 DevelopersMAKEINDEX_CMD_NAME = makeindex 67910037SARM gem5 Developers 6808303SAli.Saidi@ARM.com# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 6818303SAli.Saidi@ARM.com# LaTeX documents. This may be useful for small projects and may help to 6828303SAli.Saidi@ARM.com# save some trees in general. 6838205SAli.Saidi@ARM.com 6848140SMatt.Horsnell@arm.comCOMPACT_LATEX = NO 6858303SAli.Saidi@ARM.com 6868303SAli.Saidi@ARM.com# The PAPER_TYPE tag can be used to set the paper type that is used 6878303SAli.Saidi@ARM.com# by the printer. Possible values are: a4, a4wide, letter, legal and 6888303SAli.Saidi@ARM.com# executive. If left blank a4wide will be used. 6898140SMatt.Horsnell@arm.com 6908140SMatt.Horsnell@arm.comPAPER_TYPE = a4wide 6918140SMatt.Horsnell@arm.com 6928140SMatt.Horsnell@arm.com# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 6938140SMatt.Horsnell@arm.com# packages that should be included in the LaTeX output. 6948140SMatt.Horsnell@arm.com 6958140SMatt.Horsnell@arm.comEXTRA_PACKAGES = 6968140SMatt.Horsnell@arm.com 6977639Sgblack@eecs.umich.edu# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 69810037SARM gem5 Developers# the generated latex document. The header should contain everything until 69910037SARM gem5 Developers# the first chapter. If it is left blank doxygen will generate a 7007639Sgblack@eecs.umich.edu# standard header. Notice: only use this tag if you know what you are doing! 70110037SARM gem5 Developers 7027646Sgene.wu@arm.comLATEX_HEADER = 7037646Sgene.wu@arm.com 70410037SARM gem5 Developers# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 7058140SMatt.Horsnell@arm.com# is prepared for conversion to pdf (using ps2pdf). The pdf file will 7068148SAli.Saidi@ARM.com# contain links (just like the HTML output) instead of page references 7078140SMatt.Horsnell@arm.com# This makes the output suitable for online browsing using a pdf viewer. 7087646Sgene.wu@arm.com 7097639Sgblack@eecs.umich.eduPDF_HYPERLINKS = NO 71010037SARM gem5 Developers 71110037SARM gem5 Developers# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 7127639Sgblack@eecs.umich.edu# plain latex in the generated Makefile. Set this option to YES to get a 71310037SARM gem5 Developers# higher quality PDF documentation. 7147646Sgene.wu@arm.com 7157646Sgene.wu@arm.comUSE_PDFLATEX = NO 71610037SARM gem5 Developers 7178140SMatt.Horsnell@arm.com# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 7188148SAli.Saidi@ARM.com# command to the generated LaTeX files. This will instruct LaTeX to keep 7198140SMatt.Horsnell@arm.com# running if errors occur, instead of asking the user for help. 7207646Sgene.wu@arm.com# This option is also used when generating formulas in HTML. 7216308SN/A 72210037SARM gem5 DevelopersLATEX_BATCHMODE = NO 72310037SARM gem5 Developers 7247639Sgblack@eecs.umich.edu# If LATEX_HIDE_INDICES is set to YES then doxygen will not 72510037SARM gem5 Developers# include the index chapters (such as File Index, Compound Index, etc.) 7267646Sgene.wu@arm.com# in the output. 7277646Sgene.wu@arm.com 72810037SARM gem5 DevelopersLATEX_HIDE_INDICES = NO 7298140SMatt.Horsnell@arm.com 7308148SAli.Saidi@ARM.com#--------------------------------------------------------------------------- 7318140SMatt.Horsnell@arm.com# configuration options related to the RTF output 7328140SMatt.Horsnell@arm.com#--------------------------------------------------------------------------- 7336308SN/A 7346019SN/A# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 7357134Sgblack@eecs.umich.edu# The RTF output is optimized for Word 97 and may not look very pretty with 7367170Sgblack@eecs.umich.edu# other RTF readers or editors. 7377134Sgblack@eecs.umich.edu 7387134Sgblack@eecs.umich.eduGENERATE_RTF = NO 7397179Sgblack@eecs.umich.edu 74010037SARM gem5 Developers# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 74110037SARM gem5 Developers# If a relative path is entered the value of OUTPUT_DIRECTORY will be 74210037SARM gem5 Developers# put in front of it. If left blank `rtf' will be used as the default path. 74310037SARM gem5 Developers 74410037SARM gem5 DevelopersRTF_OUTPUT = rtf 74510037SARM gem5 Developers 74610037SARM gem5 Developers# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 74710037SARM gem5 Developers# RTF documents. This may be useful for small projects and may help to 74810037SARM gem5 Developers# save some trees in general. 74910037SARM gem5 Developers 75010037SARM gem5 DevelopersCOMPACT_RTF = NO 75110037SARM gem5 Developers 75210037SARM gem5 Developers# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 75310037SARM gem5 Developers# will contain hyperlink fields. The RTF file will 75410037SARM gem5 Developers# contain links (just like the HTML output) instead of page references. 75510037SARM gem5 Developers# This makes the output suitable for online browsing using WORD or other 75610037SARM gem5 Developers# programs which support those fields. 75710037SARM gem5 Developers# Note: wordpad (write) and others do not support links. 75810037SARM gem5 Developers 7597639Sgblack@eecs.umich.eduRTF_HYPERLINKS = NO 7607639Sgblack@eecs.umich.edu 7617639Sgblack@eecs.umich.edu# Load stylesheet definitions from file. Syntax is similar to doxygen's 7627639Sgblack@eecs.umich.edu# config file, i.e. a series of assignments. You only have to provide 7637639Sgblack@eecs.umich.edu# replacements, missing definitions are set to their default value. 7647639Sgblack@eecs.umich.edu 7657639Sgblack@eecs.umich.eduRTF_STYLESHEET_FILE = 7667639Sgblack@eecs.umich.edu 7677639Sgblack@eecs.umich.edu# Set optional variables used in the generation of an rtf document. 7687639Sgblack@eecs.umich.edu# Syntax is similar to doxygen's config file. 7697639Sgblack@eecs.umich.edu 7707639Sgblack@eecs.umich.eduRTF_EXTENSIONS_FILE = 7717639Sgblack@eecs.umich.edu 7727639Sgblack@eecs.umich.edu#--------------------------------------------------------------------------- 7737639Sgblack@eecs.umich.edu# configuration options related to the man page output 7747639Sgblack@eecs.umich.edu#--------------------------------------------------------------------------- 7757179Sgblack@eecs.umich.edu 7767179Sgblack@eecs.umich.edu# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 7777179Sgblack@eecs.umich.edu# generate man pages 7786019SN/A 779GENERATE_MAN = NO 780 781# The MAN_OUTPUT tag is used to specify where the man pages will be put. 782# If a relative path is entered the value of OUTPUT_DIRECTORY will be 783# put in front of it. If left blank `man' will be used as the default path. 784 785MAN_OUTPUT = man 786 787# The MAN_EXTENSION tag determines the extension that is added to 788# the generated man pages (default is the subroutine's section .3) 789 790MAN_EXTENSION = .3 791 792# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 793# then it will generate one additional man file for each entity 794# documented in the real man page(s). These additional files 795# only source the real man page, but without them the man command 796# would be unable to find the correct page. The default is NO. 797 798MAN_LINKS = NO 799 800#--------------------------------------------------------------------------- 801# configuration options related to the XML output 802#--------------------------------------------------------------------------- 803 804# If the GENERATE_XML tag is set to YES Doxygen will 805# generate an XML file that captures the structure of 806# the code including all documentation. 807 808GENERATE_XML = NO 809 810# The XML_OUTPUT tag is used to specify where the XML pages will be put. 811# If a relative path is entered the value of OUTPUT_DIRECTORY will be 812# put in front of it. If left blank `xml' will be used as the default path. 813 814XML_OUTPUT = xml 815 816# The XML_SCHEMA tag can be used to specify an XML schema, 817# which can be used by a validating XML parser to check the 818# syntax of the XML files. 819 820XML_SCHEMA = 821 822# The XML_DTD tag can be used to specify an XML DTD, 823# which can be used by a validating XML parser to check the 824# syntax of the XML files. 825 826XML_DTD = 827 828# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 829# dump the program listings (including syntax highlighting 830# and cross-referencing information) to the XML output. Note that 831# enabling this will significantly increase the size of the XML output. 832 833XML_PROGRAMLISTING = YES 834 835#--------------------------------------------------------------------------- 836# configuration options for the AutoGen Definitions output 837#--------------------------------------------------------------------------- 838 839# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 840# generate an AutoGen Definitions (see autogen.sf.net) file 841# that captures the structure of the code including all 842# documentation. Note that this feature is still experimental 843# and incomplete at the moment. 844 845GENERATE_AUTOGEN_DEF = NO 846 847#--------------------------------------------------------------------------- 848# configuration options related to the Perl module output 849#--------------------------------------------------------------------------- 850 851# If the GENERATE_PERLMOD tag is set to YES Doxygen will 852# generate a Perl module file that captures the structure of 853# the code including all documentation. Note that this 854# feature is still experimental and incomplete at the 855# moment. 856 857GENERATE_PERLMOD = NO 858 859# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 860# the necessary Makefile rules, Perl scripts and LaTeX code to be able 861# to generate PDF and DVI output from the Perl module output. 862 863PERLMOD_LATEX = NO 864 865# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 866# nicely formatted so it can be parsed by a human reader. This is useful 867# if you want to understand what is going on. On the other hand, if this 868# tag is set to NO the size of the Perl module output will be much smaller 869# and Perl will parse it just the same. 870 871PERLMOD_PRETTY = YES 872 873# The names of the make variables in the generated doxyrules.make file 874# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 875# This is useful so different doxyrules.make files included by the same 876# Makefile don't overwrite each other's variables. 877 878PERLMOD_MAKEVAR_PREFIX = 879 880#--------------------------------------------------------------------------- 881# Configuration options related to the preprocessor 882#--------------------------------------------------------------------------- 883 884# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 885# evaluate all C-preprocessor directives found in the sources and include 886# files. 887 888ENABLE_PREPROCESSING = YES 889 890# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 891# names in the source code. If set to NO (the default) only conditional 892# compilation will be performed. Macro expansion can be done in a controlled 893# way by setting EXPAND_ONLY_PREDEF to YES. 894 895MACRO_EXPANSION = NO 896 897# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 898# then the macro expansion is limited to the macros specified with the 899# PREDEFINED and EXPAND_AS_PREDEFINED tags. 900 901EXPAND_ONLY_PREDEF = NO 902 903# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 904# in the INCLUDE_PATH (see below) will be search if a #include is found. 905 906SEARCH_INCLUDES = YES 907 908# The INCLUDE_PATH tag can be used to specify one or more directories that 909# contain include files that are not input files but should be processed by 910# the preprocessor. 911 912INCLUDE_PATH = 913 914# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 915# patterns (like *.h and *.hpp) to filter out the header-files in the 916# directories. If left blank, the patterns specified with FILE_PATTERNS will 917# be used. 918 919INCLUDE_FILE_PATTERNS = 920 921# The PREDEFINED tag can be used to specify one or more macro names that 922# are defined before the preprocessor is started (similar to the -D option of 923# gcc). The argument of the tag is a list of macros of the form: name 924# or name=definition (no spaces). If the definition and the = are 925# omitted =1 is assumed. 926 927PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS 928 929# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 930# this tag can be used to specify a list of macro names that should be expanded. 931# The macro definition that is found in the sources will be used. 932# Use the PREDEFINED tag if you want to use a different macro definition. 933 934EXPAND_AS_DEFINED = 935 936# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 937# doxygen's preprocessor will remove all function-like macros that are alone 938# on a line, have an all uppercase name, and do not end with a semicolon. Such 939# function macros are typically used for boiler-plate code, and will confuse the 940# parser if not removed. 941 942SKIP_FUNCTION_MACROS = YES 943 944#--------------------------------------------------------------------------- 945# Configuration::additions related to external references 946#--------------------------------------------------------------------------- 947 948# The TAGFILES option can be used to specify one or more tagfiles. 949# Optionally an initial location of the external documentation 950# can be added for each tagfile. The format of a tag file without 951# this location is as follows: 952# TAGFILES = file1 file2 ... 953# Adding location for the tag files is done as follows: 954# TAGFILES = file1=loc1 "file2 = loc2" ... 955# where "loc1" and "loc2" can be relative or absolute paths or 956# URLs. If a location is present for each tag, the installdox tool 957# does not have to be run to correct the links. 958# Note that each tag file must have a unique name 959# (where the name does NOT include the path) 960# If a tag file is not located in the directory in which doxygen 961# is run, you must also specify the path to the tagfile here. 962 963TAGFILES = 964 965# When a file name is specified after GENERATE_TAGFILE, doxygen will create 966# a tag file that is based on the input files it reads. 967 968GENERATE_TAGFILE = 969 970# If the ALLEXTERNALS tag is set to YES all external classes will be listed 971# in the class index. If set to NO only the inherited external classes 972# will be listed. 973 974ALLEXTERNALS = NO 975 976# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 977# in the modules index. If set to NO, only the current project's groups will 978# be listed. 979 980EXTERNAL_GROUPS = YES 981 982# The PERL_PATH should be the absolute path and name of the perl script 983# interpreter (i.e. the result of `which perl'). 984 985PERL_PATH = /usr/bin/perl 986 987#--------------------------------------------------------------------------- 988# Configuration options related to the dot tool 989#--------------------------------------------------------------------------- 990 991# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 992# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or 993# super classes. Setting the tag to NO turns the diagrams off. Note that this 994# option is superseded by the HAVE_DOT option below. This is only a fallback. It is 995# recommended to install and use dot, since it yields more powerful graphs. 996 997CLASS_DIAGRAMS = YES 998 999# If set to YES, the inheritance and collaboration graphs will hide 1000# inheritance and usage relations if the target is undocumented 1001# or is not a class. 1002 1003HIDE_UNDOC_RELATIONS = YES 1004 1005# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1006# available from the path. This tool is part of Graphviz, a graph visualization 1007# toolkit from AT&T and Lucent Bell Labs. The other options in this section 1008# have no effect if this option is set to NO (the default) 1009 1010HAVE_DOT = NO 1011 1012# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1013# will generate a graph for each documented class showing the direct and 1014# indirect inheritance relations. Setting this tag to YES will force the 1015# the CLASS_DIAGRAMS tag to NO. 1016 1017CLASS_GRAPH = YES 1018 1019# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1020# will generate a graph for each documented class showing the direct and 1021# indirect implementation dependencies (inheritance, containment, and 1022# class references variables) of the class with other documented classes. 1023 1024COLLABORATION_GRAPH = YES 1025 1026# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1027# collaboration diagrams in a style similar to the OMG's Unified Modeling 1028# Language. 1029 1030UML_LOOK = NO 1031 1032# If set to YES, the inheritance and collaboration graphs will show the 1033# relations between templates and their instances. 1034 1035TEMPLATE_RELATIONS = NO 1036 1037# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1038# tags are set to YES then doxygen will generate a graph for each documented 1039# file showing the direct and indirect include dependencies of the file with 1040# other documented files. 1041 1042INCLUDE_GRAPH = YES 1043 1044# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1045# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1046# documented header file showing the documented files that directly or 1047# indirectly include this file. 1048 1049INCLUDED_BY_GRAPH = YES 1050 1051# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 1052# generate a call dependency graph for every global function or class method. 1053# Note that enabling this option will significantly increase the time of a run. 1054# So in most cases it will be better to enable call graphs for selected 1055# functions only using the \callgraph command. 1056 1057CALL_GRAPH = YES 1058 1059# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1060# will graphical hierarchy of all classes instead of a textual one. 1061 1062GRAPHICAL_HIERARCHY = YES 1063 1064# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1065# generated by dot. Possible values are png, jpg, or gif 1066# If left blank png will be used. 1067 1068DOT_IMAGE_FORMAT = png 1069 1070# The tag DOT_PATH can be used to specify the path where the dot tool can be 1071# found. If left blank, it is assumed the dot tool can be found on the path. 1072 1073DOT_PATH = 1074 1075# The DOTFILE_DIRS tag can be used to specify one or more directories that 1076# contain dot files that are included in the documentation (see the 1077# \dotfile command). 1078 1079DOTFILE_DIRS = 1080 1081# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 1082# (in pixels) of the graphs generated by dot. If a graph becomes larger than 1083# this value, doxygen will try to truncate the graph, so that it fits within 1084# the specified constraint. Beware that most browsers cannot cope with very 1085# large images. 1086 1087MAX_DOT_GRAPH_WIDTH = 1024 1088 1089# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 1090# (in pixels) of the graphs generated by dot. If a graph becomes larger than 1091# this value, doxygen will try to truncate the graph, so that it fits within 1092# the specified constraint. Beware that most browsers cannot cope with very 1093# large images. 1094 1095MAX_DOT_GRAPH_HEIGHT = 1024 1096 1097# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1098# graphs generated by dot. A depth value of 3 means that only nodes reachable 1099# from the root by following a path via at most 3 edges will be shown. Nodes that 1100# lay further from the root node will be omitted. Note that setting this option to 1101# 1 or 2 may greatly reduce the computation time needed for large code bases. Also 1102# note that a graph may be further truncated if the graph's image dimensions are 1103# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). 1104# If 0 is used for the depth value (the default), the graph is not depth-constrained. 1105 1106MAX_DOT_GRAPH_DEPTH = 0 1107 1108# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1109# generate a legend page explaining the meaning of the various boxes and 1110# arrows in the dot generated graphs. 1111 1112GENERATE_LEGEND = YES 1113 1114# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1115# remove the intermediate dot files that are used to generate 1116# the various graphs. 1117 1118DOT_CLEANUP = YES 1119 1120#--------------------------------------------------------------------------- 1121# Configuration::additions related to the search engine 1122#--------------------------------------------------------------------------- 1123 1124# The SEARCHENGINE tag specifies whether or not a search engine should be 1125# used. If set to NO the values of all tags below this one will be ignored. 1126 1127SEARCHENGINE = NO 1128