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

\details tag doesn't work unless after a new paragraph (Origin: bugzilla #584844) #3415

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 normal in component general for ---
Reported in version 1.5.7.1 on platform Other
Assigned to: Dimitri van Heesch

On 2009-06-04 16:58:45 +0000, Joseph Hainline wrote:

The \details tag doesn't work unless preceded by a "new paragraph".

This example does not work:
/// @brief description here
/// @param myParam1 the first param
/// @return False if an error was encountered, true otherwise
/// @details This is the detailed description.

This example does work:
/// @brief description here
/// @param myParam1 the first param
/// @return False if an error was encountered, true otherwise
///
/// @details This is the detailed description.

On 2009-06-05 18:55:12 +0000, Dimitri van Heesch wrote:

The problem is that the @param command already implicitly ends the brief description and that a @details command outside of a brief description has no effect.

I agree it is more logical to treat the @details command as a new paragraph command in such cases, so I'll change that.

On 2009-08-20 10:12:47 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.6.0. Please verify if this is indeed the case and reopen the
bug if you think it is not fixed (include any additional information that you
think can be relevant).

On 2009-08-20 17:44:55 +0000, Joseph Hainline wrote:

The change works for me. Thanks!

@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