doxygen_manual-1.8.1 (1035109), страница 29
Текст из файла (страница 29)
If there are many fields or methods and many nodes the graph may become too big to be useful.The UML_LIMIT_NUM_FIELDS threshold limits the number of items for each type to make the size moremanagable. Set this to 0 for no limit. Note that the threshold may be exceeded by 50% before the limit isenforced. So when you set the threshold to 10, up to 15 fields may appear, but if the number exceeds 15, thetotal amount of fields shown is limited to 10.TEMPLATE_RELATIONS If the TEMPLATE_RELATIONS and HAVE_DOT tags are set to YES then doxygenwill show the relations between templates and their instances.HIDE_UNDOC_RELATIONS If set to YES, the inheritance and collaboration graphs will hide inheritance andusage relations if the target is undocumented or is not a class.INCLUDE_GRAPH If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT tags are set to YES then doxygen will generate a graph for each documented file showing the directand indirect include dependencies of the file with other documented files.INCLUDED_BY_GRAPH If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH,and HAVE_DOT tags are set to YES then doxygen will generate a graph for each documented header fileshowing the documented files that directly or indirectly include this file.CALL_GRAPH If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will generate a call dependency graph for every global function or class method.
Note that enabling this option will significantlyincrease the time of a run. So in most cases it will be better to enable call graphs for selected functions onlyusing the \callgraph command.CALLER_GRAPH If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will generate a callerdependency graph for every global function or class method. Note that enabling this option will significantlyincrease the time of a run. So in most cases it will be better to enable caller graphs for selected functions onlyusing the \callergraph command.GRAPHICAL_HIERARCHY If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen will graphical hierarchy of all classes instead of a textual one.DIRECTORY_GRAPH If the DIRECTORY_GRAPH, and HAVE_DOT options are set to YES then doxygen willshow the dependencies a directory has on other directories in a graphical way.
The dependency relations aredetermined by the #include relations between the files in the directories.DOT_GRAPH_MAX_NODES The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number ofnodes that will be shown in the graph. If the number of nodes in a graph becomes larger than this value,doxygen will truncate the graph, which is visualized by representing a node as a red box. Note that doxygenGenerated by Doxygen112Configurationif the number of direct children of the root node in a graph is already larger than DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that the size of a graph can be further restricted byMAX_DOT_GRAPH_DEPTH.MAX_DOT_GRAPH_DEPTH The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of thegraphs generated by dot.
A depth value of 3 means that only nodes reachable from the root by following apath via at most 3 edges will be shown. Nodes that lay further from the root node will be omitted. Note thatsetting this option to 1 or 2 may greatly reduce the computation time needed for large code bases. Also notethat the size of a graph can be further restricted by DOT_GRAPH_MAX_NODES. Using a depth of 0 meansno depth restriction (the default).DOT_IMAGE_FORMAT The DOT_IMAGE_FORMAT tag can be used to set the image format of the images generated by dot.
Possible values are svg, png, jpg, or gif. If left blank png will be used.NoteIf you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG filesvisible in IE 9+ (other browsers do not have this requirement).INTERACTIVE_SVG If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to enable generation of interactive SVG images that allow zooming and panning. Note that this requires a modern browserother than Internet Explorer. Tested and working are Firefox, Chrome, Safari, and Opera.NoteFor IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files visible.Older versions of IE do not have SVG support.DOT_PATH This tag can be used to specify the path where the dot tool can be found. If left blank, it is assumedthe dot tool can be found on the path.DOTFILE_DIRS This tag can be used to specify one or more directories that contain dot files that are includedin the documentation (see the \dotfile command).MSCFILE_DIRS This tag can be used to specify one or more directories that contain msc files that are includedin the documentation (see the \mscfile command).DOT_TRANSPARENT Set the DOT_TRANSPARENT tag to YES to generate images with a transparent background.
This is disabled by default, because dot on Windows does not seem to support this out of the box.Warning: Depending on the platform used, enabling this option may lead to badly anti-aliased labels on theedges of a graph (i.e. they become hard to read).DOT_MULTI_TARGETS Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output filesin one run (i.e. multiple -o and -T options on the command line). This makes dot run faster, but since onlynewer versions of dot (>1.8.10) support this, this feature is disabled by default.GENERATE_LEGEND If the GENERATE_LEGEND tag is set to YES (the default) doxygen will generate a legendpage explaining the meaning of the various boxes and arrows in the dot generated graphs.DOT_CLEANUP If the DOT_CLEANUP tag is set to YES (the default) doxygen will remove the intermediate dotfiles that are used to generate the various graphs.ExamplesSuppose you have a simple project consisting of two files: a source file example.cc and a header fileexample.h.
Then a minimal configuration file is as simple as:INPUT= example.cc example.hAssuming the example makes use of Qt classes and perl is located in /usr/bin, a more realistic configurationfile would be:Generated by Doxygen20.17 Dot optionsPROJECT_NAMEINPUTWARNINGSTAGFILESPERL_PATHSEARCHENGINE113======Exampleexample.cc example.hYESqt.tag/usr/local/bin/perlNOTo generate the documentation for the QdbtTabular package I have used the following configuration file:PROJECT_NAMEOUTPUT_DIRECTORYWARNINGSINPUTFILE_PATTERNSINCLUDE_PATHTAGFILESPERL_PATHSEARCHENGINE=========QdbtTabularhtmlYESexamples/examples.doc src*.cc *.hexamplesqt.tag/usr/bin/perlYESTo regenerate the Qt-1.44 documentation from the sources, you could use the following config file:PROJECT_NAMEOUTPUT_DIRECTORYHIDE_UNDOC_MEMBERSHIDE_UNDOC_CLASSESENABLE_PREPROCESSINGMACRO_EXPANSIONEXPAND_ONLY_PREDEFSEARCH_INCLUDESFULL_PATH_NAMESSTRIP_FROM_PATHPREDEFINED===========INPUT=FILE_PATTERNSINCLUDE_PATHRECURSIVE===Qtqt_docsYESYESYESYESYESYESYES$(QTDIR)/USE_TEMPLATECLASS Q_EXPORT= \QArrayT:=QArray \QListT:=QList \QDictT:=QDict \QQueueT:=QQueue \QVectorT:=QVector \QPtrDictT:=QPtrDict \QIntDictT:=QIntDict \QStackT:=QStack \QDictIteratorT:=QDictIterator \QListIteratorT:=QListIterator \QCacheT:=QCache \QCacheIteratorT:=QCacheIterator \QIntCacheT:=QIntCache \QIntCacheIteratorT:=QIntCacheIterator \QIntDictIteratorT:=QIntDictIterator \QPtrDictIteratorT:=QPtrDictIterator$(QTDIR)/doc \$(QTDIR)/src/widgets \$(QTDIR)/src/kernel \$(QTDIR)/src/dialogs \$(QTDIR)/src/tools*.cpp *.h q*.doc$(QTDIR)/includeYESFor the Qt-2.1 sources I recommend to use the following settings:PROJECT_NAMEPROJECT_NUMBERHIDE_UNDOC_MEMBERSHIDE_UNDOC_CLASSESSOURCE_BROWSERINPUTFILE_PATTERNSRECURSIVEEXCLUDE_PATTERNSALPHABETICAL_INDEXCOLS_IN_ALPHA_INDEXIGNORE_PREFIXGenerated by Doxygen============Qt2.1YESYESYES$(QTDIR)/src*.cpp *.h q*.docYES*codec.cpp moc_* */compat/* */3rdparty/*YES3Q114ENABLE_PREPROCESSINGMACRO_EXPANSIONINCLUDE_PATHPREDEFINEDEXPAND_ONLY_PREDEFEXPAND_AS_DEFINEDConfiguration====YESYES$(QTDIR)/includeQ_PROPERTY(x)= \Q_OVERRIDE(x)= \Q_EXPORT= \Q_ENUMS(x)= \"QT_STATIC_CONST=static const " \_WS_X11_ \INCLUDE_MENUITEM_DEF= YES= Q_OBJECT_FAKE Q_OBJECT ACTIVATE_SIGNAL_WITH_PARAM \Q_VARIANT_ASHere doxygen’s preprocessor is used to substitute some macro names that are normally substituted by the Cpreprocessor, but without doing full macro expansion.Generated by DoxygenChapter 21Special Commands21.1IntroductionAll commands in the documentation start with a backslash (\) or an at-sign (@).
If you prefer you can replace allcommands starting with a backslash below by their counterparts that start with an at-sign.Some commands have one or more arguments. Each argument has a certain range:• If <sharp> braces are used the argument is a single word.• If (round) braces are used the argument extends until the end of the line on which the command was found.• If {curly} braces are used the argument extends until the next paragraph.
Paragraphs are delimited by a blankline or by a section indicator.If in addition to the above argument specifiers [square] brackets are used the argument is optional.Here is an alphabetically sorted list of all commands with references to their documentation:\a . . . . .\addindex .\addtogroup\anchor . .\arg . . . .\attention . .\author . . .\authors . .\b . . . . .\brief . .
![](https://s.studizba.com/z.php?f=/templates/si/i/noavatar.png&w=100&h=100&t=1"){kind=avatar}
