By using this site, you agree to our updated Privacy Policy and our Terms of Use. Manage your Cookies Settings.
455,693 Members | 1,301 Online
Bytes IT Community
+ Ask a Question
Need help? Post your question and get tips & solutions from a community of 455,693 IT Pros & Developers. It's quick & easy.

Problem with NDoc and overloaded properties

P: n/a
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(Sys tem.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/
Nov 21 '05 #1
Share this Question
Share on Google+
6 Replies


P: n/a
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
The summary documentation for the second method (Missing <summary>
documentation for
P:Enterprocity.Base.Collections.KeyedList.Item(Sys tem.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?

Nov 21 '05 #2

P: n/a
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.

"KD" <kd@home> wrote in message news:eB*************@TK2MSFTNGP15.phx.gbl...
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
The summary documentation for the second method (Missing <summary>
documentation for
P:Enterprocity.Base.Collections.KeyedList.Item(Sys tem.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?


Nov 21 '05 #3

P: n/a
Ray,

"Ray Cassick (Home)" <rc************@enterprocity.com> schrieb:
''' <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(Sys tem.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.

--
M S Herfried K. Wagner
M V P <URL:http://dotnet.mvps.org/>
V B <URL:http://classicvb.org/petition/>

Nov 21 '05 #4

P: n/a
KD
NDoc copes with overloaded properties ok.

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

---
Kevin

"Herfried K. Wagner [MVP]" <hi***************@gmx.at> wrote in message
news:e3****************@TK2MSFTNGP14.phx.gbl...

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

--
M S Herfried K. Wagner
M V P <URL:http://dotnet.mvps.org/>
V B <URL:http://classicvb.org/petition/>

Nov 21 '05 #5

P: n/a
KD
Let us know what you find :)

---
Kevin

"Ray Cassick (Home)" <rc************@enterprocity.com> wrote in message
news:%2****************@TK2MSFTNGP14.phx.gbl...
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.

Nov 21 '05 #6

P: n/a
"KD" <kd@home> schrieb:
NDoc copes with overloaded properties ok.


Thank you for clarification.

--
M S Herfried K. Wagner
M V P <URL:http://dotnet.mvps.org/>
V B <URL:http://classicvb.org/petition/>
Nov 21 '05 #7

This discussion thread is closed

Replies have been disabled for this discussion.