GNOME Bugzilla – Bug 511906
@copydoc & JAVADOC_AUTOBRIEF
Last modified: 2012-02-25 15:37:39 UTC
Please describe the problem: The best way to describe the issue is to first give you a code example: /// This is my brief explanation. /// More detailed explanation follows... void foo() { } /// @copydoc foo() void bar() { } In the code example above, the bar() function's brief description area in the HTML output also contains the detailed text in it. I have JAVADOC_AUTOBRIEF enabled, and I'm using C++. Let me know if you need more information about this issue. Steps to reproduce: Actual results: Expected results: Does this happen every time? Yes Other information:
This appears to be a duplicate of bug 348729. I actually see exactly the opposite problem. I'm using Doxygen 1.5.6 on Windows, and when I use \copydoc, the member in the member summary area with the links in the HTML output shows no documentation at all. The linked-to documentation for the member further down correctly shows both the brief and detailed descriptions.
This bug report had the version set to "latest". Since this is a moving target I changed it to 1.5.7.1. If you happen to see that the problem is fixed in 1.5.8, then please close it.
(In reply to comment #1) > I'm using Doxygen 1.5.6 on > Windows, and when I use \copydoc, the member in the member summary area with > the links in the HTML output shows no documentation at all. I see exactly the same behavior using 1.5.9.
Please note that: @copydoc copies both brief and detailed descriptions. @copybrief copies only the brief description. @copydetails copies only the detailed description. If you observe a case where the copying does not work as expected then please attach a self-contained example (source + config) that allows me to reproduce the problem.
/** * This is Foo. */ class Foo { /** * Does nothing. Really. */ void zip() {}; /** * @copydoc zip() */ void zoo() {}; }; I have enabled JAVADOC_AUTOBRIEF, BRIEF_MEMBER_DESC, and REPEAT_BRIEF. I can also post the rest of my settings, but I think they're fairly obvious given the syntax above. I can't speak as to what the correct behavior should be here, but I will say that the HTML output generated by Doxygen for the code above isn't what I expected. -- What I expected: Two member functions, both with brief and detailed sections in the documentation page for class Foo. For both member functions, the brief member description at the top of the page should read: Does nothing. And the detailed member descriptions should both read: Does nothing. Really. -- What I actually got: Two member functions, but only one (zip) has a brief member description: Does nothing. The detailed member descriptions both read: Does nothing. Really. -- The differences between what I actually got and what I expected are the brief member descriptions. It appears that the brief member description from zip() is copied into the detailed member description of zoo(), but not into the brief member description of zoo(). I hope this helps.
Created attachment 164346 [details] Weird behavior with copydoc in doxygen 1.7.0 This is to confirm what Hasan said. There is an image inside the archive to illustrate the problem.
Confirmed. Should be fixed in the next subversion update.
*** Bug 581303 has been marked as a duplicate of this bug. ***
*** Bug 622749 has been marked as a duplicate of this bug. ***
This bug was previously marked ASSIGNED, which means it should be fixed in doxygen version 1.8.0. 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.