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 584844 - \details tag doesn't work unless after a new paragraph
\details tag doesn't work unless after a new paragraph
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.5.7.1
Other Windows
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2009-06-04 16:58 UTC by Joseph Hainline
Modified: 2009-08-20 17:44 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Joseph Hainline 2009-06-04 16:58:45 UTC
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.
Comment 1 Dimitri van Heesch 2009-06-05 18:55:12 UTC
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.
Comment 2 Dimitri van Heesch 2009-08-20 10:12:47 UTC
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).
Comment 3 Joseph Hainline 2009-08-20 17:44:55 UTC
The change works for me.  Thanks!