doxygen_manual-1.8.1 (1035109), страница 21
Текст из файла (страница 21)
Once doxygen has finished the Destination directory is where tolook for the results. Doxygen will put each output format in a separate sub-directory.The mode tab allows you to select how doxygen will look at your sources. The default is to only look for things thathave been documented.You can also select how doxygen should present the results. The latter does not affect the way doxygen parsesyour source code.You can select one or more of the output formats that doxygen should produce. For HTML and LaTeX there areadditional options.Doxygen can produce a number of diagrams. Using the diagrams tab you can select which ones to generate.
Formost diagrams the dot tool of the GraphViz package is needed (if you use the binary packages for MacOSX thistool is already included).90Doxywizard usageExpert dialogThe Expert dialog has a number of tab fields, one for each section in the configuration file. Each tab-field containsa number of lines, one for each configuration option in that section.The kind of input widget depends on the type of the configuration option.• For each boolean option (those options that are answered with YES or NO in the configuration file) there is acheck-box.• For items taking one of a fixed set of values (like OUTPUT_LANGUAGE) a combo box is used.• For items taking an integer value from a range, a spinbox is used.• For free form string-type options there is a one line edit field• For options taking a lists of strings, a one line edit field is available, with a ‘+’ button to add this string to thelist and a ‘-’ button to remove the selected string from the list.
There is also a ‘∗’ button that, when pressed,replaces the selected item in the list with the string entered in the edit field.• For file and folder entries, there are special buttons that start a file selection dialog.The get additional information about the meaning of an option, click on the "Help" button at the bottom right of thedialog and then on the item. A tooltip with additional information will appear.Menu optionsThe GUI front-end has a menu with a couple of useful itemsOpen... This is the same as the "Load" button in the main window and allows to open a configuration file from disk.Save as..
This is the same as the "Save" button in the main window and can be used to save the current configuration settings to disk.Recent configurations Allow to quickly load a recently saved configuration.Set as default... Stores the current configuration settings as the default to use next time the GUI is started. Youwill be asked to confirm the action.Reset...
Restores the factory defaults as the default settings to use. You will be asked to confirm the action.Generated by DoxygenChapter 20Configuration20.1FormatA configuration file is a free-form ASCII text file with a structure that is similar to that of a Makefile, with the defaultname Doxyfile. It is parsed by doxygen. The file may contain tabs and newlines for formatting purposes. Thestatements in the file are case-sensitive.
Comments may be placed anywhere within the file (except within quotes).Comments begin with the # character and end at the end of the line.The file essentially consists of a list of assignment statements. Each statement consists of a TAG_NAME writtenin capitals, followed by the = character and one or more values. If the same tag is assigned more than once, thelast assignment overwrites any earlier assignment. For options that take a list as their argument, the += operatorcan be used instead of = to append new values to the list.
Values are sequences of non-blanks. If the valueshould contain one or more blanks it must be surrounded by quotes ("..."). Multiple lines can be concatenated byinserting a backslash (\) as the last character of a line. Environment variables can be expanded using the pattern$(ENV_VARIABLE_NAME).You can also include part of a configuration file from another configuration file using a @INCLUDE tag as follows:@INCLUDE = config_file_nameThe include file is searched in the current working directory. You can also specify a list of directories that shouldbe searched before looking in the current working directory.
Do this by putting a @INCLUDE_PATH tag with thesepaths before the @INCLUDE tag, e.g.:@INCLUDE_PATH = my_config_dirThe configuration options can be divided into several categories. Below is an alphabetical index of the tags that arerecognized followed by the descriptions of the tags grouped by category.ABBREVIATE_BRIEF . .
. .ALIASES . . . . . . . . . .ALLEXTERNALS . . . . . .ALPHABETICAL_INDEX . .ALWAYS_DETAILED_SEC .BINARY_TOC . . . . . . . .BRIEF_MEMBER_DESC . .BUILTIN_STL_SUPPORT . .CALL_GRAPH . . . . . . . .CALLER_GRAPH . . . . . .CASE_SENSE_NAMES . .CHM_FILE . . .
. . . . . . .CHM_INDEX_ENCODING .CITE_BIB_FILES . . . . . .CLASS_DIAGRAMS . . . .CLASS_GRAPH . . . . . . .COLLABORATION_GRAPHCOLS_IN_ALPHA_INDEX .COMPACT_LATEX . . . . .................................................................................................................................................................................................................................................................................................................20.220.220.1620.720.220.820.220.220.1720.1720.320.820.820.320.1720.1720.1720.720.9COMPACT_RTF .
. . . . . . .CPP_CLI_SUPPORT . . . . .CREATE_SUBDIRS . . . . . .DIRECTORY_GRAPH . . . . .DISABLE_INDEX . . . . . . .DISTRIBUTE_GROUP_DOC .DOCSET_BUNDLE_ID . . . .DOCSET_FEEDNAME . . . .DOCSET_PUBLISHER_ID . .DOCSET_PUBLISHER_NAMEDOT_CLEANUP . .
. . . . . .DOT_FONTNAME . . . . . . .DOT_FONTPATH . . . . . . .DOT_FONTSIZE . . . . . . .DOT_GRAPH_MAX_NODES .DOT_IMAGE_FORMAT . . . .DOT_MULTI_TARGETS . . .DOT_NUM_THREADS . . . .DOT_PATH . . . . . . . . . ..............................................................................................................................................................................................................................................................................................20.1020.220.220.1720.820.220.820.820.820.820.1720.1720.1720.1720.1720.1720.1720.1720.1792ConfigurationDOT_TRANSPARENT .
. . . . .DOTFILE_DIRS . . . . . . . . . .DOXYFILE_ENCODING . . . . .ECLIPSE_DOC_ID . . . . . . . .ENABLE_PREPROCESSING . . .ENABLED_SECTIONS . . . . . .ENUM_VALUES_PER_LINE . . .EXAMPLE_PATH . . . . . . . . .EXAMPLE_PATTERNS . . . . . .EXAMPLE_RECURSIVE . . . . .EXCLUDE . . . . . . .
. . . . . .EXCLUDE_PATTERNS . . . . . .EXCLUDE_SYMBOLS . . . . . .EXCLUDE_SYMLINKS . . . . . .EXPAND_AS_DEFINED . . . . .EXPAND_ONLY_PREDEF . . . .EXT_LINKS_IN_WINDOW . . . .EXTENSION_MAPPING . . . . .EXTERNAL_GROUPS . . . . . .EXTRA_PACKAGES . . . . . . .EXTRACT_ALL . . . . . . . . . .EXTRACT_ANON_NSPACES . .EXTRACT_LOCAL_CLASSES . .EXTRACT_LOCAL_METHODS . .EXTRACT_PRIVATE . . .
. . . .EXTRACT_STATIC . . . . . . . .FILE_PATTERNS . . . . . . . . .FILE_VERSION_FILTER . . . . .FILTER_PATTERNS . . . . . . .FILTER_SOURCE_FILES . . . . .FILTER_SOURCE_PATTERNS . .FORCE_LOCAL_INCLUDES . . .FORMULA_FONTSIZE . . . . . .FORMULA_TRANSPARENT . .
.FULL_PATH_NAMES . . . . . . .GENERATE_AUTOGEN_DEF . .GENERATE_BUGLIST . . . . . .GENERATE_CHI . . . . . . . . .GENERATE_DEPRECIATEDLISTGENERATE_DOCSET . . . . . .GENERATE_ECLIPSEHELP . . .GENERATE_HTML . . . . . . . .GENERATE_HTMLHELP . . . . .GENERATE_LATEX . . . . . . .GENERATE_LEGEND . . . . . .GENERATE_MAN .
. . . . . . . .GENERATE_PERLMOD . . . . .GENERATE_QHP . . . . . . . . .GENERATE_RTF . . . . . . . . .GENERATE_TAGFILE . . . . . .GENERATE_TESTLIST . . . . . .GENERATE_TODOLIST . . . . .GENERATE_TREEVIEW . . . . .GENERATE_XML . . . . . . .
. .GRAPHICAL_HIERARCHY . . . .GROUP_GRAPHS . . . . . . . .HAVE_DOT . . . . . . . . . . . .HHC_LOCATION . . . . . . . . .HIDE_FRIEND_COMPOUNDS . .HIDE_IN_BODY_DOCS . . . . . .HIDE_SCOPE_NAMES . . . . . .HIDE_UNDOC_CLASSES . . . .HIDE_UNDOC_MEMBERS . . . .HIDE_UNDOC_RELATIONS . . .HTML_ALIGN_MEMBERS . .
. .HTML_COLORSTYLE_GAMMA .HTML_COLORSTYLE_HUE . . .HTML_COLORSTYLE_SAT . . . .HTML_DYNAMIC_SECTIONS . .HTML_EXTRA_FILES . . . . . . .HTML_FILE_EXTENSION . . . .HTML_FOOTER . . . . . . . . . .HTML_HEADER . . . . . . . . . ......................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................20.1720.1720.220.820.1520.320.820.520.520.520.520.520.520.520.1520.1520.820.220.1620.920.320.320.320.320.320.320.520.320.520.520.520.320.820.820.220.1320.320.820.320.820.820.820.820.920.1720.1120.1420.820.1020.1620.320.320.820.1220.1720.1720.1720.820.320.320.320.320.320.1720.820.820.820.820.820.820.820.820.8HTML_INDEX_NUM_ENTRIES .HTML_OUTPUT .