Menu
I am using the \xrefitem command to create a bunch of user-defined sections that are all automatically cross-referenced. For example, one of the aliases I use looks like this:
hack=\xrefitem hack \"Hack\" \"Wall of Shame\""
This all works well. The documentation is generated exactly as I want, and a link to the "Wall of Shame" appears on the "Related Pages" page:
But I can't figure out how to add a description to the right of this link. That empty description cell there is just begging to be filled. How can I make it happy?
Although the documentation doesn't indicate that this is valid syntax, I tried appending a description to the end of the alias, like this:
hack=\xrefitem hack \"Hack\" \"Wall of Shame\" \"Some sample descriptive text\""
but it didn't work; it just broke everything else.
375
You can put example source code in a special path defined in the doxygen config under EXAMPLE_PATH , and then insert examples with the @example tag. Doxygen will then generate an extra page containing the source of the example. It will also set a link to it from the class documentation containing the example tag.
Doxytag is a small command line based utility. It can generate tag files. These tag files can be used with doxygen to generate references to external documentation (i.e. documentation not contained in the input files that are used by doxygen).
It is parsed by doxygen . The file may contain tabs and newlines for formatting purposes. The statements 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.
You can do
/*! @page hack
* @brief Some sample descriptive text.
* @par
*/
Note that the dummy @par shouldn't have been needed, but it is currently needed due to a logic bug in doxygen, which I'll fix in the next release.
199
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
