Skip to content
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

@copydoc & JAVADOC_AUTOBRIEF (Origin: bugzilla #511906) #2799

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Copy link
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity normal in component build for ---
Reported in version 1.5.7.1 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2008-01-24 21:46:21 +0000, Robert wrote:

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:

On 2008-07-17 10:19:32 +0000, Jonathan Watt wrote:

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.

On 2008-12-27 14:22:56 +0000, Dimitri van Heesch wrote:

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.

On 2009-08-17 19:43:12 +0000, Hasan Khalil wrote:

(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.

On 2009-08-19 13:04:36 +0000, Dimitri van Heesch wrote:

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.

On 2009-08-19 18:22:32 +0000, Hasan Khalil wrote:

/**

  • 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.

On 2010-06-22 20:49:28 +0000, Stéphane wrote:

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

On 2011-12-28 10:15:52 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next subversion update.

On 2011-12-28 10:17:28 +0000, Dimitri van Heesch wrote:

*** Bug 581303 has been marked as a duplicate of this bug. ***

On 2011-12-28 10:21:04 +0000, Dimitri van Heesch wrote:

*** Bug 622749 has been marked as a duplicate of this bug. ***

On 2012-02-25 15:37:39 +0000, Dimitri van Heesch wrote:

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.

@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
You can’t perform that action at this time.