doxygen_manual-1.8.1 (1035109), страница 17
Текст из файла (страница 17)
Only a fixed set of types aresupported, each representing a link to a specific index.You can also add custom tabs using a type with name "user". Here is an example that shows how to add a tab withtitle "Google" pointing to www.google.com:<navindex>...<tab type="user" url="http://www.google.com" title="Google"/>...</navindex>The url field can also be a relative URL. If the URL starts with @ref the link will point to a documented entities,such as a class, a function, a group, or a related page.
Suppose we have defined a page using @page with labelmypage, then a tab with label "My Page" to this page would look as follows:<navindex>...<tab type="user" url="@ref mypage" title="My Page"/>...</navindex>You can also group tabs together in a custom group using a tab with type "usergroup". The following example putsthe above tabs in a user defined group with title "My Group":<navindex>...<tab type="usergroup" title="My Group"><tab type="user" url="http://www.google.com" title="Google"/><tab type="user" url="@ref mypage" title="My Page"/></tab>...</navindex>Groups can be nested to form a hierarchy.The elements after navindex represent the layout of the different pages generated by doxygen:• The class element represents the layout of all pages generated for documented classes, structs, unions,and interfaces.• The namespace element represents the layout of all pages generated for documented namespaces (andalso Java packages).• The file element represents the layout of all pages generated for documented files.• The group element represents the layout of all pages generated for documented groups (or modules).• The directory element represents the layout of all pages generated for documented directories.Each XML element within one of the above page elements represents a certain piece of information.
Some piecescan appear in each type of page, others are specific for a certain type of page. Doxygen will list the pieces in theorder in which they appear in the XML file.The following generic elements are possible for each page:briefdescription Represents the brief description on a page.detaileddescription Represents the detailed description on a page.authorsection Represents the author section of a page (only used for man pages).memberdecl Represents the quick overview of members on a page (member declarations).
This elements haschild elements per type of member list. The possible child elements are not listed in detail in the document,but the name of the element should be a good indication of the type of members that the element represents.Generated by Doxygen12.3 Using the XML output71memberdef Represents the detailed member list on a page (member definition).
Like the memberdecl element, also this element has a number of possible child elements.The class page has the following specific elements:includes Represents the include file needed to obtain the definition for this class.inheritancegraph Represents the inheritance relations for a class. Note that the CLASS_DIAGRAM optiondetermines if the inheritance relation is a list of base and derived classes or a graph.collaborationgraph Represents the collaboration graph for a class.allmemberslink Represents the link to the list of all members for a class.usedfiles Represents the list of files from which documentation for the class was extracted.The file page has the following specific elements:includes Represents the list of #include statements contained in this file.includegraph Represents the include dependency graph for the file.includedbygraph Represents the included by dependency graph for the file.sourcelink Represents the link to the source code of this file.The group page has a specific groupgraph element which represents the graph showing the dependenciesbetween groups.Similarly, the directory page has a specific directorygraph element which represents the graph showing thedependencies between the directories based on the #include relations of the files inside the directories.Some elements have a visible attribute which can be used to hide the fragment from the generated output, bysetting the attribute’s value to "no".
You can also use the value of a configuration option to determine the visibility,by using its name prefixed with a dollar sign, e.g....<includes visible="$SHOW_INCLUDE_FILES"/>...This was mainly added for backward compatibility. Note that the visible attribute is just a hint for doxygen.
If norelevant information is available for a certain piece it is omitted even if it is set to yes (i.e. no empty sections aregenerated).Some elements have a title attribute. This attribute can be used to customize the title doxygen will use as aheader for the piece.Warningat the moment you should not remove elements from the layout file as a way to hide information. Doing so cancause broken links in the generated output!12.3Using the XML outputIf the above two methods still do not provide enough flexibility, you can also use the XML output produced bydoxygen as a basis to generate the output you like.
To do this set GENERATE_XML to YES.The XML output consists of an index file named index.xml which lists all items extracted by doxygen withreferences to the other XML files for details. The structure of the index is described by a schema file index.xsd.All other XML files are described by the schema file named compound.xsd. If you prefer one big XML file youcan combine the index and the other files using the XSLT file combine.xslt.Generated by Doxygen72Customizing the OutputYou can use any XML parser to parse the file or use the one that can be found in the addon/doxmlparserdirectory of doxygen source distribution. Look at addon/doxmlparser/include/doxmlintf.h for theinterface of the parser and in addon/doxmlparser/example for examples.The advantage of using the doxmlparser is that it will only read the index file into memory and then only those XMLfiles that you implicitly load via navigating through the index. As a result this works even for very large projectswhere reading all XML files as one big DOM tree would not fit into memory.See the Breathe project for a example that uses doxygen XML output from Python to bridge it with theSphinx document generator.Generated by DoxygenChapter 13Custom CommandsDoxygen provides a large number of special commands, XML commands, and HTML commands.
that can be usedto enhance or structure the documentation inside a comment block. If you for some reason have a need to definenew commands you can do so by means of an alias definition.The definition of an alias should be specified in the configuration file using the ALIASES configuration tag.13.1Simple aliasesThe simplest form of an alias is a simple substitution of the formname=valueFor example defining the following alias:ALIASES += sideeffect="\par Side Effects:\n"will allow you to put the command \sideeffect (or @sideeffect) in the documentation, which will result in a userdefined paragraph with heading Side Effects:.Note that you can put \n’s in the value part of an alias to insert newlines.Also note that you can redefine existing special commands if you wish.Some commands, such as \xrefitem are designed to be used in combination with aliases.13.2Aliases with argumentsAliases can also have one or more arguments.
In the alias definition you then need to specify the number ofarguments between curly braces. In the value part of the definition you can place \x markers, where ’x’ representsthe argument number starting with 1.Here is an example of an alias definition with a single argument:ALIASES += l{1}="\ref \1"Inside a comment block you can use it as follows/** See \l{SomeClass} for more information. */which would be the same as writing/** See \ref SomeClass for more information. */74Custom CommandsNote that you can overload an alias by a version with multiple arguments, for instance:ALIASES += l{1}="\ref \1"ALIASES += l{2}="\ref \1 \"\2\""Note that the quotes inside the alias definition have to be escaped with a backslash.With these alias definitions, we can write/** See \l{SomeClass,Some Text} for more information.
*/inside the comment block and it will expand to/** See \ref SomeClass "Some Text" for more information. */where the command with a single argument would still work as shown before.Aliases can also be expressed in terms of other aliases, e.g. a new command \reminder can be expressed as a\xrefitem via an intermediate \xreflist command as follows:ALIASES += xreflist{3}="\xrefitem \1 \"\2\" \"\3\" " \ALIASES += reminder="\xreflist{reminders,Reminder,Reminders}" \Note that if for aliases with more than one argument a comma is used as a separator, if you want to put a commainside the command, you will need to escape it with a backslash, i.e.\l{SomeClass,Some text\, with an escaped comma}given the alias definition of \l in the example above.13.3Nesting custom commandYou can use commands as arguments of aliases, including commands defined using aliases.As an example consider the following alias definitionsALIASES += Bold{1}="<b>\1</b>"ALIASES += Emph{1}="<em>\1</em>"Inside a comment block you can now use:/** This is a \Bold{bold \Emph{and} Emphasized} text fragment.
*/which will expand to/** This is a <b>bold <em>and</em> Emphasized</b> text fragment. */Generated by DoxygenChapter 14Link to external documentationIf your project depends on external libraries or tools, there are several reasons to not include all sources for thesewith every run of doxygen:Disk space: Some documentation may be available outside of the output directory of doxygen already, for instancesomewhere on the web. You may want to link to these pages instead of generating the documentation in yourlocal output directory.Compilation speed: External projects typically have a different update frequency from your own project. It doesnot make much sense to let doxygen parse the sources for these external project over and over again, evenif nothing has changed.Memory: For very large source trees, letting doxygen parse all sources may simply take too much of your system’smemory.
![](https://s.studizba.com/z.php?f=/templates/si/i/noavatar.png&w=100&h=100&t=1"){kind=avatar}
