473,215 Members | 1,229 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,215 software developers and data experts.

Problem with NDoc and overloaded properties

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
6 1275
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
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
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
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
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
"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 thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

1
by: Marty McDonald | last post by:
I use the following, and then use Visual Studio's "Tools", "Build Comment Web Pages". But on the generated pages, the list elements don't show up as lists, just text that wrap around. Am I doing...
3
by: cybertof | last post by:
Hello, Is it possible in C# to have 2 overloaded functions with - same names - same parameters - different return type values If no, is it possible in another language ?
3
by: Jorel | last post by:
Hi. I am just running through the hello world tutorial and when I attempt to generate the comment web pages (like javadoc) it just creates a page with no content. Um....this is the tutorial and...
7
by: Ash Moollan [InfoMaster] | last post by:
Hi there, I am using NDOC to generate docs for one C# project which I wrote. My assembly has some public classes that are not meant to be used by others and I have not documented them. I would...
11
by: julien | last post by:
Hello, I posted this question on the NDoc-user mailing list, but it looks like a dead list (no messages for 10 days!). I'd like to use NDoc tags or custom tags inside methods like: void...
2
by: ajikoe | last post by:
Hi, I tried to follow the example in swig homepage. I found error which I don't understand. I use bcc32, I already include directory where my python.h exist in bcc32.cfg. /* File : example.c...
7
by: Dino Buljubasic | last post by:
Hi, I am using C# 2.0 (VS2005) to build my user control that contains a number of dynamically loaded ListViews. ListViewItems have their ForeColor properties set to either black or blue to...
8
by: Kuldeep | last post by:
Framework: Visual Studio 2005 Technology: ASP.NET 2.0 Language: C#.NET 2.0 Hi All, Could any one of you please let me know how to use NDoc in Visual Studio 2005. If there is a source where...
4
by: Peter Lykkegaard | last post by:
Hi gotdotnet is being phased out Anyone knows where I get a copy of the NDOC add-on for VB.NET? Yeah I know about time to move on and start using VS 2005 :) tia/Peter (repost from...
0
by: veera ravala | last post by:
ServiceNow is a powerful cloud-based platform that offers a wide range of services to help organizations manage their workflows, operations, and IT services more efficiently. At its core, ServiceNow...
0
by: jianzs | last post by:
Introduction Cloud-native applications are conventionally identified as those designed and nurtured on cloud infrastructure. Such applications, rooted in cloud technologies, skillfully benefit from...
0
by: mar23 | last post by:
Here's the situation. I have a form called frmDiceInventory with subform called subfrmDice. The subform's control source is linked to a query called qryDiceInventory. I've been trying to pick up the...
2
by: jimatqsi | last post by:
The boss wants the word "CONFIDENTIAL" overlaying certain reports. He wants it large, slanted across the page, on every page, very light gray, outlined letters, not block letters. I thought Word Art...
2
isladogs
by: isladogs | last post by:
The next Access Europe meeting will be on Wednesday 7 Feb 2024 starting at 18:00 UK time (6PM UTC) and finishing at about 19:30 (7.30PM). In this month's session, the creator of the excellent VBE...
0
by: fareedcanada | last post by:
Hello I am trying to split number on their count. suppose i have 121314151617 (12cnt) then number should be split like 12,13,14,15,16,17 and if 11314151617 (11cnt) then should be split like...
0
by: stefan129 | last post by:
Hey forum members, I'm exploring options for SSL certificates for multiple domains. Has anyone had experience with multi-domain SSL certificates? Any recommendations on reliable providers or specific...
1
by: davi5007 | last post by:
Hi, Basically, I am trying to automate a field named TraceabilityNo into a web page from an access form. I've got the serial held in the variable strSearchString. How can I get this into the...
0
by: MeoLessi9 | last post by:
I have VirtualBox installed on Windows 11 and now I would like to install Kali on a virtual machine. However, on the official website, I see two options: "Installer images" and "Virtual machines"....

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.