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

C++/CLI indexed property not documented (Origin: bugzilla #707266) #5279

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 documentation for ---
Reported in version 1.8.5 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2013-09-02 07:18:38 +0000, Marcel wrote:

When I have an indexed property in a C++/CLI class, Doxygen 1.8.5 gives a warning.

Example:
public ref class Foo
{
public:
///


/// Constructor.
///

Foo() {}

/// <summary>
/// The nth element of this object.
/// </summary>
property Byte default[UInt16]
{
    Byte get(UInt16 n);
    void set(UInt16 n, Byte value);
}

private:
System::Generic::List m_list;
};

When I run Doxygen over this code, the following warning is issued:
warning: documented symbol `Byte Foo::default' was not declared or defined.

A similar warning is issued when I rename the "default" property to for example "Bar":
warning: documented symbol `Byte Foo::Bar' was not declared or defined.

Even when I add the implementation to the class definition, the same warnings are issued.

On 2013-09-22 08:31:52 +0000, Dimitri van Heesch wrote:

I don't see this warning with the above example.
Can you please attach a self-contained example (source+config file in a tar or zip) that allows me to reproduce the problem?

On 2013-09-23 07:05:25 +0000, Marcel wrote:

I have attached a source file with the configuration file that reproduces the issue.
I have also done some additional investigation myself and indeed the issue cannot be reproduced with the original example. However, the issue is triggered when a datatype is used with a full namespace specification.
Changing the original example to

public ref class Foo
{
public:
///


/// Constructor.
///

Foo() {}

/// <summary>
/// The nth element of this object.
/// </summary>
property Byte default[System::UInt16]
{
    Byte get(System::UInt16 n);
    void set(System::UInt16 n, Byte value);
}

private:
System::Generic::List m_list;
};

already triggers the warning and leaves the indexed property out of the documentation.

In my project I use a datatype of my own (defined in another namespace) as the index of the class. This causes the issue.

On 2013-09-23 07:06:19 +0000, Marcel wrote:

Created attachment 255547
Source and configuration file to reproduce bug

On 2016-12-03 19:08:25 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next GIT update.

On 2016-12-29 18:45:56 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.13. 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 (preferably in the form of a self-contained example).

@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