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

Overloaded this properties in C# are not tagged properly in XML output (Origin: bugzilla #640822) #4118

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

Original attachment names and IDs:

On 2011-01-28 14:07:18 +0000, Ray Lefuel wrote:

Created attachment 179517
Doxygen config settings

When a this statement is overloaded, the XML docs are not tagged properly, making it very difficult to distinguish one from the other.

My sample code:

namespace Sample.API {
/** New class docs.
/
public class NewClass {
/
*


* This docs.
*

*
*
* The ID parameter docs.
*
*/
override public object this[ int ID ]
{
get { return Value( ID ); }
}

    /** More docs.
     *
     * <param name="str">
     * The str parameter docs.
     * </param>
     */
    override public object this[ string str ]
    {
        get { return Value( str ); }
    }
}

}

The results:

The XML output only outputs the first This statement with the [int ID] argsstring and the "This docs" briefdescription. There is no argstring for string str, but the briefdescritpion for the 2nd This statement is documented as the detaileddescription of the first statement. There are also two parameterlists in the detaileddescription, one for ID and one for str.

The following is the XML result of the above code:

Sample::API::NewClass override object override object Sample::API.NewClass::this [int ID] this This docs. More docs. ID The ID parameter docs. str The str parameter docs. New class docs. Sample::API::NewClassthis

I've attached my configuration settings.

On 2011-01-29 22:11:57 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next subversion update.

On 2011-02-12 22:03:23 +0000, Dimitri van Heesch wrote:

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

On 2011-03-28 14:19:34 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.7.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.

@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