New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Request \endinternal or \ipar (Origin: bugzilla #624575) #3855

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity enhancement in component general for ---
Reported in version 1.6.3 on platform Other
Assigned to: Dimitri van Heesch

On 2010-07-16 21:23:48 +0000, Michael Stockman wrote:

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

On 2010-07-17 21:53:49 +0000, Dimitri van Heesch wrote:

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 =

On 2010-10-09 08:20:07 +0000, Dimitri van Heesch wrote:

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.

@doxygen doxygen closed this Jul 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment