Hello, Doxygen Users,
(Using Doxygen 1.8.10, on Windows 7, 64-bit)
When I started this message, it was about my old wish to suppress the automatic
prepending of the \brief to the \details in the output of a \page block.
But as I looked more closely so I could explain it all in detail, I realized
that I’ve got a bigger issue to solve: the display of the Modules tab, even
when showing the most detail available (for my output, detail level 3), is
incomplete, even though it’s complete in the left pane’s treeview. (I have
GENERATE_TREEVIEW = YES.)
That is, the left treeview shows everything as expected:
* Modules > <product-that-I-treat-as-module> > Functions > <function-groups> >
<individual-functions>
* Modules > <product-that-I-treat-as-module> > Pages > <page-groups> >
<individual-pages>
But in the right pane, accessed by clicking the Modules tab, the Functions and
Pages groups expand *only if* there are more *groups* underneath them, but not
down to the level of the <individual-functions> or <individual-pages>. And if
there are no <page-groups>, the right pane goes only to the level of “Pages”
(not the <individual-pages>). Likewise for <function-groups>: if there are no
function groups, the right pane goes only to the level of “Functions”.
I guess it isn’t really necessary for the right Modules pane to show the
<individual-functions> or <individual-pages>, but I’d like to know if this is
by-design or if there’s a configuration setting that controls this?
If I can’t display the <individual-functions> or <individual-pages>, then it
seems that the \brief description for \page blocks doesn’t actually appear
anywhere?
If that’s the case, then I can simply not use the \brief for the \page
comments, and the issue I was facing (having the \brief prepended to the
\details in the output of a \page) disappears :-).
But if I can get the Modules pane to show the <individual-functions> or
<individual-pages>, I’d need to try to suppress the \brief prepending.
The reason that I think I should be able to get this to work is that it works
properly for the \dir comment block. For \dir comments, the \brief appears in
the Modules pane as expected, and as expected (and preferred) it does not
appear in the Detailed Description output for the \dir display.
Thoughts?
----
Following are things that were mentioned/tried when I first posted the problem
of trying to suppress the prepended \brief for a \page so that it behaved the
same as a \dir comment:
(Using Doxygen 1.8.10)
* Standard behavior of the \brief and \details commands for class and file
members is to prepend the \brief to the \details, described here:
https://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdbrief.
* Set REPEAT_BRIEF=NO. This works for the .c/.h files’ Doxygen-comment blocks,
as well as \dir comment blocks. But it’s not working for \page blocks (which
are in separate .page files, parsed as .c files via the EXTENSION_MAPPING
setting, “page=C”).
* Someone suggested that I have a look at the possibilities of the doxygen
layout file? (doxygen -l and the LAYOUT_FILE setting in the Doxyfile). I did,
but none of the existing layouts seem applicable. There are layout definitions
for the following types of pages: class, namespace, file, group, and directory.
But nothing for a “page” page. Nonetheless, I tried creating a new element,
<pages> (because this is the value of “type” for one of the <tab> elements in
the <navindex>), at the same level as <directory>, with all the same values
except for setting the <briefdescription> element’s “visible” attribute value
to “no”. But then when I run doxygen with this layout file (via the
doxywizard), I get error like this:
“Unexpected start tag ‘page’ found in scope=’(null)’!
So the layout of a \page page file seems to be controlled by some other
mechanism?
* I tried setting the <briefdescription> element’s “visible” attribute to “no”
for the <file> layout, on the supposition that perhaps the file page layout
might also apply to any page that’s created by the \page command, but it had no
apparent effect.
* I’m guessing that to do what I’m wishing, I’d have to go the XML route, as
the manual describes:
http://www.stack.nl/~dimitri/doxygen/manual/customize.html#xmlgenerator. My
wish is pretty small, though, and certainly too small to justify a big effort
to customize XML parsing.
----
Thanks very much,
-Monique
------------------------------------------------------------------------------
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
