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# Generics classes implementing an interface are not corretly documented (Origin: bugzilla #533821) #2959

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.7.0 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2008-05-19 08:37:27 +0000, Jiri Findejs wrote:

Consider the following example:

/** \brief A namespace. /
namespace NS
{
/
* \brief An interface. */
interface IfaceA
{
}

/** \brief Generic implementation of IfaceA. */
public class ClassA : IfaceA
{
}

/** \brief Specialization of ClassA. */
public class ClassB : ClassA
{
}

/** \brief Concrete implementation of IfaceA. */
public class ClassC : IfaceA
{
}
}

ClassA is not documented and interface IfaceA is incorrectly documented:

NS::IfaceA< T > An interface

ClassB has not documented relation to ClassA.

ClassC is OK.

On 2008-05-19 08:38:02 +0000, Jiri Findejs wrote:

Created attachment 111135
Test file

On 2008-05-19 08:38:33 +0000, Jiri Findejs wrote:

Created attachment 111136
Doxygen configuration file

On 2008-10-17 11:04:31 +0000, Jiri Findejs wrote:

Everything works fine in Doxygen version 1.5.7.1

* NS::IfaceA
      o NS::ClassA< long >
            + NS::ClassB 
      o NS::ClassA< T >
      o NS::ClassC 

On 2009-02-01 15:00:34 +0000, Jiri Findejs wrote:

This bug reappears in doxygen 1.5.8. The output from doxygen is now:

This inheritance list is sorted roughly, but not completely, alphabetically:

* NS::ClassB
* NS::IfaceA
      o NS::ClassA< T >
      o NS::ClassC 

The correct output is the one produced by doxygen 1.5.7.1, see coment # 3.

On 2009-08-20 18:46:06 +0000, Jiri Findejs wrote:

Doxygen versions 1.5.9 and 1.6.0 didn't fix the bug. The behavior is the same as in doxygen 1.5.8.
Bug importance increased.

On 2010-06-15 22:10:49 +0000, Jiri Findejs wrote:

Doxygen version 1.7.0 still contains the bug. It produces the same output as version 1.5.8

�NS::ClassB
�NS::IfaceA
�NS::ClassA< T >
�NS::ClassC

The class NS::ClassB inherits from NS::ClassA. It is not recognized by doxygen. Also ClassA specialization ClassA is not recognized. Doxygen version 1.5.7.1 was able to recognize both.

  • NS::IfaceA
    o NS::ClassA< long >
    + NS::ClassB
    o NS::ClassA< T >
    o NS::ClassC

On 2010-06-18 21:21:54 +0000, Dimitri van Heesch wrote:

Confirmed. Sorry it took so long, but in the next release this problem should be corrected.

On 2010-06-25 11:48:57 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.7.1. 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 2010-06-27 15:09:16 +0000, Edwin F. López A. wrote:

Good day.

This issue is similar/related to 583958 (Class diagrams and class hierarchy don't work for java generic classes: https://bugzilla.gnome.org/show_bug.cgi?id=583958), which is not currently assigned.

I had attached a java source file (https://bugzilla.gnome.org/attachment.cgi?id=160795) for that bug that triggers the problem. I have confirmed it happened from versions 1.5.8 and up.

How can I be of any assistance to help fixing it since it is of my interest this is resolved?

Thank you very much.

On 2010-10-09 08:19:15 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.7.2. 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 2010-10-13 07:36:24 +0000, Jiri Findejs wrote:

It works correctly for attached example as well as for my, much more complex, real case.
Thanks a lot.

@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