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

Text after @copydoc is lost (Origin: bugzilla #692320) #5044

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

Original attachment names and IDs:

On 2013-01-22 19:40:43 +0000, damon.carter@xcerra.com wrote:

Created attachment 234131
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.

On 2013-01-22 20:11:27 +0000, Dimitri van Heesch wrote:

Created attachment 234136
Fix for copydoc problem

Can you check if the following patch fixes the problem?

On 2013-02-11 09:59:54 +0000, Antoine Pierlot-Garcin wrote:

I have the same bug using 1.8.3.1. The patch fixes the problem.

On 2013-02-21 17:12:30 +0000, damon.carter@xcerra.com wrote:

Yes, the patch fixes the problem.

On 2013-02-23 12:44:59 +0000, Dimitri van Heesch wrote:

Patch will be included in the next release (it is already in SVN).

On 2013-03-22 18:05:52 +0000, Sylwester Arabas wrote:

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

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

On 2013-04-05 21:18:23 +0000, Sylwester Arabas wrote:

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:

details of a


html/structa.html:

details of a

In previous versions of Doxygen there was no

&

in a_8hpp.html - the "details of a" string was copied as-is. Can the old behaviour be brought back in anyway?

HTH,
Sylwester

On 2013-05-19 12:35:51 +0000, Dimitri van Heesch wrote:

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.

On 2013-05-19 19:21:49 +0000, Sylwester Arabas wrote:

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:

details of a


html/structa.html:

details of a

doxygen 1.8.3 gives:
$ fgrep "details of a" html/*
html/a_8hpp.html:

some textdetails of a some other text


html/structa.html:

details of a

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

.

Thanks,
Sylwester

On 2013-05-21 13:44:29 +0000, Sylwester Arabas wrote:

P.S. IIUC, not being the reporter of this bug I cannot reopen it.
Sylwester

On 2013-05-21 15:06:43 +0000, damon.carter@xcerra.com wrote:

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

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

On 2013-05-21 16:44:38 +0000, Sylwester Arabas wrote:

I've just submitted it as https://bugzilla.gnome.org/show_bug.cgi?id=700788
Sylwester

@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