XML comments: doesn't reference the right member when a property has the same name as a type

oxygene
(Patrick Lanz) #1

Hello,
Test case: (.NET class library, XML comments on)

namespace ClassLibrary1;

interface

  type
    /// <summary>
    /// </summary>
    OrganizerType = public class
    end;

    /// <summary>
    ///   <see cref="OrganizerType" />
    /// </summary>
    Tournament = public class
    public
      /// <summary>
      ///   <see cref="OrganizerType" />
      /// </summary>
      /// <value></value>
      property OrganizerType : OrganizerType;
    end;

implementation

end.

XML comments:

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>ClassLibrary1</name>
    </assembly>
    <members>
        <member name="T:ClassLibrary1.OrganizerType">
             <summary>
             </summary>
        </member>
        <member name="T:ClassLibrary1.Tournament">
             <summary>
               <see cref="T:ClassLibrary1.OrganizerType" />
             </summary>
        </member>
        <member name="P:ClassLibrary1.Tournament.OrganizerType">
             <summary>
               <see cref="T:ClassLibrary1.OrganizerType" />
             </summary>
             <value></value>
        </member>
    </members>
</doc>

The XML comments reference the type, not the property. But the property is the more inside definition and should be referenced.

0 Likes

(Carlo Kok) #2

as a workaround, you can use OrganizerType.OrganizerType

0 Likes

(RemObjects) #3

Thanks, logged as bugs://82338

0 Likes

(Patrick Lanz) #4

Not Tournament.OrganizerType?

0 Likes

(Carlo Kok) #5

sorry; yes you are rigth.

0 Likes

(RemObjects) #6

bugs://82338 got closed with status fixed.

0 Likes