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 692320 - Text after @copydoc is lost
Text after @copydoc is lost
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.8.3.1
Other Linux
: Normal major
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2013-01-22 19:40 UTC by damon.carter
Modified: 2013-05-21 16:44 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Group example modified to show the problem (804 bytes, application/x-gzip)
2013-01-22 19:40 UTC, damon.carter
  Details
Fix for copydoc problem (271 bytes, patch)
2013-01-22 20:11 UTC, Dimitri van Heesch
none Details | Review

Description damon.carter 2013-01-22 19:40:43 UTC
Created attachment 234131 [details]
Group example modified to show the problem

With version 1.8.3.1, any text that follows a @copydoc entry is lost, it is not added to the description of the thing being documented. Version 1.8.3 does not have this problem.
I have attached a modified version of the example group.cpp to show the issue. I have added a @copydoc to line 84. The documentation being copied by the @copydoc appears correctly. The documentation that follows (line 85 "yet another function in group 1") is missing.
Comment 1 Dimitri van Heesch 2013-01-22 20:11:27 UTC
Created attachment 234136 [details] [review]
Fix for copydoc problem

Can you check if the following patch fixes the problem?
Comment 2 Antoine Pierlot-Garcin 2013-02-11 09:59:54 UTC
I have the same bug using 1.8.3.1. The patch fixes the problem.
Comment 3 damon.carter 2013-02-21 17:12:30 UTC
Yes, the patch fixes the problem.
Comment 4 Dimitri van Heesch 2013-02-23 12:44:59 UTC
Patch will be included in the next release (it is already in SVN).
Comment 5 Sylwester Arabas 2013-03-22 18:05:52 UTC
Hello,

After upgrading Doxygen I had analogous problem with @copydetails - Doxygen aborted generation of the docs within a file after the first occurance of @copydetails. Using the svn version helped but the behaviour is different than previously. Now @copydetails surrounds the copied text with <p></p> in HTML (what splits sentences across paragraphs in my case). Is there any way to bring back the original behaviour (that is to make @copydetails just copy the details "as is" and not embed it in a new paragraph)?

Thanks for help,
Sylwester
Comment 6 Sylwester Arabas 2013-04-05 21:18:23 UTC
ping :)

Here's a short command sequence that reveals the issue:

$ cat a.hpp 
/// @file a.hpp
/// @details
/// some text @copydetails a some other text 

/// @brief brief
/// @details details of a
struct a {};

$ doxygen -g
$ doxygen
$ fgrep "details of a" html/*
html/a_8hpp.html:<p>details of a </p>
html/structa.html:<p>details of a </p>

In previous versions of Doxygen there was no <p> & </p> in a_8hpp.html - the "details of a" string was copied as-is. Can the old behaviour be brought back in anyway?

HTH,
Sylwester
Comment 7 Dimitri van Heesch 2013-05-19 12:35:51 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.
Comment 8 Sylwester Arabas 2013-05-19 19:21:49 UTC
Hi,

Thanks for reply.

The point is that while the buggy behaviour was indeed fixed, the new version behaves differently than the older non-byggy ones. With the example above:


doxygen-svn gives:
$ fgrep "details of a" html/*
html/a_8hpp.html:<p>details of a </p>
html/structa.html:<p>details of a </p>


doxygen 1.8.3 gives:
$ fgrep "details of a" html/*
html/a_8hpp.html:<div class="textblock"><p>some textdetails of a  some other text </p>
html/structa.html:<p>details of a </p>


Even if it is somehow an intended behaviour, it would be great to have the possibility to switch to the old one, i.e. inclusion of the "details" without the surrounding <p></p>.

Thanks,
Sylwester
Comment 9 Sylwester Arabas 2013-05-21 13:44:29 UTC
P.S. IIUC, not being the reporter of this bug I cannot reopen it.
Sylwester
Comment 10 damon.carter 2013-05-21 15:06:43 UTC
Hello Sylwester
Although the resolution of this bug report is not ideal for you, it is fine for me. I am not bothered by the additional paragraph <p> tags, and the issue of losing text is gone.
I would suggest you submit a separate bug report specific to your issue, and that way you can re-open it if it is not fixed to your satisfaction.
- Damon
Comment 11 Sylwester Arabas 2013-05-21 16:44:38 UTC
I've just submitted it as https://bugzilla.gnome.org/show_bug.cgi?id=700788
Sylwester