After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 624575 - Request \endinternal or \ipar
Request \endinternal or \ipar
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.6.3
Other Windows
: Normal enhancement
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2010-07-16 21:23 UTC by Michael Stockman
Modified: 2010-10-09 08:20 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Michael Stockman 2010-07-16 21:23:48 UTC
Hello,

Continuing to write on our document (formatted using doxygen and generated in a number of editions with slightly different options), we're feeling slightly limited by \internal. Thus we'd like to suggest adding e.g.:
- \endinternal to optionally start including content again before the page structure would do it.
- \ipar A single internal paragraph.

I.e. some way to make a limited portion of the text internal. Typically we'd use it to:

Some text about a feature.

\internal
\test Details about testing that part of the feature.
\test ...
\endinternal

Some more text about a different aspect of the feature.

\internal
\test Details about testing that aspect of the feature.
\test ...
\endinternal

Obviously we could create subsubsections, but there are instances when that would feel strange (especially if the internal documentation is excluded).

Best regards,
  Micke
Comment 1 Dimitri van Heesch 2010-07-17 21:53:49 UTC
I'll add an \endinternal command for completeness.

Note that you can already define
your own \internal and \endinternal commands using aliases as follows:

ALIASES                = internal="\if INTERNAL\n" \
                         endinternal="\n\endif"

and then enable them using

ENABLED_SECTIONS       = INTERNAL

and disable them using

ENABLED_SECTIONS       =
Comment 2 Dimitri van Heesch 2010-10-09 08:20:07 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.7.2. Please verify if this is indeed the case. Reopen the
bug if you think it is not fixed and please include any additional information
that you think can be relevant.