detaileddescription Represents the detailed description on a page. Doing so can cause broken links in the generated output!Īt the moment the following generic tags are possible for each page: briefdescription Represents the brief description on a page. Warning: at the moment you should not remove tags from the layout file as a way to hide information. This attribute can be used to customize the title doxygen will use as a header for the piece. If no relevant information is available for a certain piece it is omitted even if it is set to yes (i.e.
Note that the visible attribute is just a hint for doxygen.
This was mainly added for backward compatibility. 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. Some tags have a visible attribute which can be used to hide the fragment from the generated output, by setting the attribute's value to "no".
Doxygen will list the pieces in the order in which they appear in the XML file. Some pieces can appear in each type of page, others are specific for a certain type of page. The directory section represents the layout of all pages generated for documented directories.Įach XML tag within one of the above page sections represents a certain piece of information.The group section represents the layout of all pages generated for documented groups (or modules).The file section represents the layout of all pages generated for documented files.The namespace section represents the layout of all pages generated for documented namespaces (and also Java packages).The class section represents the layout of all pages generated for documented classes, structs, unions, and interfaces.The sections after navindex represent the layout of the different pages generated by doxygen: Only a fixed set of types are supported, each representing a link to a specific index. Do not change the value of the type attribute however. You can reorder the tabs by moving the tab tags in the XML file within the navindex section and even change the tree structure. If the title field is the empty string (the default) then doxygen will fill in an appropriate title. You can also override the default title of a tab by specifying it as the value of the title attribute. You can hide tabs by setting the visible attribute to no. Each tab is represented by a tab tag in the XML file. The first section, enclosed by navindex tags represents the layout of the navigation tabs displayed at the top of each HTML page. The root tag of the XML is doxygenlayout, it has an attribute named version, which will be used in the future to cope with changes that are not backward compatible. The default layout can be generated by doxygen using the following command: The solution doxygen provides is a layout file, which you can modify and doxygen will use to control what information is presented, in which order, and to some extent also how information is presented. A different style sheet or custom headers and footers do not help in such case. In some cases you may want to change the way the output is structured. If you use images or other external content in a custom header you need to make sure these end up in the HTML output directory yourself, for instance by writing a script that runs doxygen can then copies the images to the output. Note: You should not put the style sheet in the HTML output directory. See the documentation of the HTML_HEADER tag for more information about the possible meta commands.
0 kommentar(er)
