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 700345 - Closing long comment line "/////////...." being included in @brief.
Closing long comment line "/////////...." being included in @brief.
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.8.3.1-SVN
Other Linux
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2013-05-14 21:49 UTC by Timmie Smith
Modified: 2013-05-19 12:36 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Demonstrates issue with long comment line following single line @brief. (793 bytes, text/x-c++src)
2013-05-14 21:49 UTC, Timmie Smith
  Details
Proposed fix to ignore //// (626 bytes, patch)
2013-05-17 18:33 UTC, Dimitri van Heesch
none Details | Review

Description Timmie Smith 2013-05-14 21:49:29 UTC
Created attachment 244248 [details]
Demonstrates issue with long comment line following single line @brief.

The format I'm using to document my code is 

//////////////////////////////////////////////////////////////////////
/// @brief What does this method do?
/// @param What is the type, name, and meaning of this parameter?
/// @return What is the type, name, and meaning of the return value?
///
/// [optional details about how to use the method]
//////////////////////////////////////////////////////////////////////

In cases where there's only a single line brief the closing line of the block is being included in the @brief comment.  This is occurring with a build from SVN, but does not occur when using 1.8.1 in Fedora 17.

Source file that demonstrates the error is attached.  The only change to the default Doxyfile is setting INPUT = test.cc
Comment 1 Dimitri van Heesch 2013-05-17 18:32:20 UTC
Confirmed. Should be fixed in the next subversion update.
Comment 2 Dimitri van Heesch 2013-05-17 18:33:44 UTC
Created attachment 244568 [details] [review]
Proposed fix to ignore ////

Please check if this patch fixes the problem
Comment 3 Timmie Smith 2013-05-17 18:57:21 UTC
The patch fixes the issue for me.  Thank you.
Comment 4 Dimitri van Heesch 2013-05-19 12:36:06 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.4. 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.