Problem with NDoc and overloaded properties

[Ray Cassick \(Home\)]

I have a set of properties in my assembly that look like this:

''' <overloads>
''' Allows the caller to have get or set access to an item in the
collection.
''' </overloads>
''' <summary>
''' Allows the caller to set or get an item from the collection using the
object.
''' </summary>
''' <param name="key">The item to reference.</param>
''' <returns>An object item from the collection.</returns>
Public Property Item(ByVal key As Object) As Object Implements
IDictionary.Item
Get
. . .
End Get
Set(ByVal value As Object)
. . .
End Set

End Property

''' <summary>
''' Allows the caller to set or get an item from the collection using the
items index.
''' </summary>
''' <param name="index">The index of the item to reference.</param>
''' <returns>An object item from the collection.</returns>
Public Property Item(ByVal index As Integer) As Object
Get
. . .
End Get
Set(ByVal value As Object)
. . .
End Set

End Property


They work just fone, but when I run the xml doc file through NDoc 1.3 it
tells me that I am missing:

The summary documentation for the second method (Missing <summary>
documentation for
P:Enterprocity.Base.Collections.KeyedList.Item(System.Int32) )

And I am missing the parameters documentation for the index param (Missing
<param> documentation for index)

The best I can see, these are the only two methods I am having issues with.
The rest of the assembly seems to be documented just fine.

Can anyone point out why I might be having this problem besides maybe a bug
in NDoc?

--
Raymond R Cassick
CEO / CSA
Enterprocity Inc.
www.enterprocity.com
3380 Sheridan Drive, #143
Amherst, NY 14227
V: 716-316-7537
Blog: http://spaces.msn.com/members/rcassick/

 

[KD]

More likely, it's a bug in VBCommenter.

There was a bug in VBCommenter that caused it to sometimes 'lose' the
namespace part of parameters. Check the xml file and look at the signature
for the problem property, it should match the signature in the NDoc
'missing' message...

I believe that latest version of VBCommenter (1.2.5) may have finally fixed
this issue.

hope this helps,
Kevin

 

[Ray Cassick \(Home\)]

I am building the xml comments using VBXC (http://vbxmldoc.tor-erik.net/)
not VBCommentor. I started using it a while ago (before the VBCommentor was
available) and like it. I have not seen this issue before which makes me
wonder if the problem is not more with NDoc V1.3...

I will check out the XML file though...

Thanks.

 

[Herfried K. Wagner [MVP]]

Ray,

''' <overloads>
''' Allows the caller to have get or set access to an item in the
collection.
''' </overloads>
''' <summary>
''' Allows the caller to set or get an item from the collection using the
object.
''' </summary>
''' <param name="key">The item to reference.</param>
''' <returns>An object item from the collection.</returns>
Public Property Item(ByVal key As Object) As Object Implements
IDictionary.Item
Get
. . .
End Get
Set(ByVal value As Object)
. . .
End Set

End Property

''' <summary>
''' Allows the caller to set or get an item from the collection using the
items index.
''' </summary>
''' <param name="index">The index of the item to reference.</param>
''' <returns>An object item from the collection.</returns>
Public Property Item(ByVal index As Integer) As Object
Get
. . .
End Get
Set(ByVal value As Object)
. . .
End Set

End Property


They work just fone, but when I run the xml doc file through NDoc 1.3 it
tells me that I am missing:

The summary documentation for the second method (Missing <summary>
documentation for
P:Enterprocity.Base.Collections.KeyedList.Item(System.Int32) )

And I am missing the parameters documentation for the index param (Missing
<param> documentation for index)

The best I can see, these are the only two methods I am having issues
with. The rest of the assembly seems to be documented just fine.

Can anyone point out why I might be having this problem besides maybe a
bug in NDoc?

I didn't check it, but as C# doesn't support overloading of properties maybe
NDoc doesn't support comments for overloaded properties.

 

[KD]

NDoc copes with overloaded properties ok.

It is pretty-much language agnostic; it just documents whatever it finds
using reflection over an assembly...

 

[KD]

Let us know what you find

 

[Herfried K. Wagner [MVP]]

NDoc copes with overloaded properties ok.

Thank you for clarification.