473,788 Members | 2,726 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

VBCommenter and NDoc

Is anyone using these tools with VB 2003 to document UserControls that
they're writing? In particular, I'm having trouble with the way that Events
are being generated in intermediate XML and finished help file.

VBCommenter seems to create /two/ distinct entries for each Event:
1) the Event itself, which doesn't seem to include /any/ of the XML
comments I've coded, and
2) the EventHandler Delegate, which does include all my comments, but
which my Developers (VB "Proper" stalwarts, all) won't even think to
look at.

Looking at MSDN, Events have lots of useful stuff in them - mine don't.
Is this just what it does, or am I coding my XML comments incorrectly,
or do I have an out-of-date copy of VBCommenter (1.0.1) and/or
NDoc (1.3.1851.0)?

TIA,
Phill W.

Sample Comments:

''' -----------------------------------------------------------------------------
''' <summary>
''' Event raised after [data from] a DataRow has been added to the Grid.
''' </summary>
''' <param name="iaRow">
''' Index of the row being processed.
</param>
''' <param name="oaDataRow ">
''' [A reference to] the DataRow object from which values have been loaded.
''' </param>
''' <remarks>
''' This event is raised after values have been copied from the
''' DataRow to cells within the grid (where the column's
''' BoundAttributeN ame property matches the DataRow's column
''' name).
''' <para>Use this event to form any row-by-row processing or
''' additional data transfer from the DataRow to the grid. </para>
''' </remarks>
''' -----------------------------------------------------------------------------

Generated XML :

<member name="E:OU.Appl etUI.OUFlexGrid .RowLoaded" />

<member name="T:OU.Appl etUI.OUFlexGrid .RowLoadedEvent Handler">
<summary>
Event raised after [data from] a DataRow has been added to the Grid.
</summary>
<param name="iaRow">In dex of the row being processed. </param>
<param name="oaDataRow ">
[A reference to] the DataRow object from which values have been loaded.
</param>
<remarks>
This event is raised after values have been copied from the
DataRow to cells within the grid (where the column's
BoundAttributeN ame property matches the DataRow's column
name).
<para>Use this event to form any row-by-row processing or
additional data transfer from the DataRow to the grid. </para>
</remarks>
</member>
Jan 17 '06 #1
0 1080

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

7
2602
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 like NDOC not to generate documentation for those public classes that do not have an XML documentation. Can anyone suggest how I do that? All help much appreciated
11
1426
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 Mymethod() { ..... <mytag>...</mytag> .... }
0
259
by: Michael Gross | last post by:
Hi NG, I commentate my VB.NET source code with "vbCommenter" from PowerToys for Visual Studio .NET. The generated XML File is correct. So far is all OK. But after, I get problems with building the help documentation. I tried with "Custom Help Builder" and "nDOC". I get this error message form "Custom Help Builder" : "The object reference was not specified on an object instance."
0
916
by: Calvin | last post by:
Hi I' m sorry the thread is a bit off topic, but there is no support from the vbcommenter page I'm using vbcommenter 1.1 I have the following problem. In some method the namespaces are not included in the name attribute of the XML file, generated by the vbcommenter. NDOC cannot use it to generate a correct comment.
3
1669
by: pmclinn | last post by:
In a sumary tag within the vbcommentor xml tag is there a way to insert a carriage return? Sumary line 1 Summary Line 2 I tried using <para></para> and it did not split the line in intellisense. -Peter
1
1189
by: Joe | last post by:
Hello. We still use Studio 2003 and I have VBCommenter 1.2.6 beta. I want to custmize the template but can't figure out how to do it. The GotDotNet website is not very helpful on this subject. I thought there should be a file called default-autoinsert.xslt somewhere. But where? There's none in the VBCommenter folder. Can someone please help or point to a helpful site? Thanks.
7
3031
by: Lonifasiko | last post by:
I need something like NDoc that supports .NET Framework 2.0? I've downloaded last NDoc but did not work with 2.0 assemblies. Also googled deep enough to find this URL that seems to be down: http://ndoc.sourceforge.net/wiki/dotNet_2.0_Support Any other ideas?
8
1859
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 I can find step by step information, I would be greatly obliged.
4
4563
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 m.p.d.framework)
0
9498
by: Hystou | last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can effortlessly switch the default language on Windows 10 without reinstalling. I'll walk you through it. First, let's disable language synchronization. With a Microsoft account, language settings sync across devices. To prevent any complications,...
0
10366
Oralloy
by: Oralloy | last post by:
Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers, it seems that the internal comparison operator "<=>" tries to promote arguments from unsigned to signed. This is as boiled down as I can make it. Here is my compilation command: g++-12 -std=c++20 -Wnarrowing bit_field.cpp Here is the code in...
1
10112
by: Hystou | last post by:
Overview: Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows Update option using the Control Panel or Settings app; it automatically checks for updates and installs any it finds, whether you like it or not. For most users, this new feature is actually very convenient. If you want to control the update process,...
0
9969
tracyyun
by: tracyyun | last post by:
Dear forum friends, With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each protocol has its own unique characteristics and advantages, but as a user who is planning to build a smart home system, I am a bit confused by the choice of these technologies. I'm particularly interested in Zigbee because I've heard it does some...
0
8993
agi2029
by: agi2029 | last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing, and deployment—without human intervention. Imagine an AI that can take a project description, break it down, write the code, debug it, and then launch it, all on its own.... Now, this would greatly impact the work of software developers. The idea...
1
7518
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 1 May 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome a new presenter, Adolph Dupré who will be discussing some powerful techniques for using class modules. He will explain when you may want to use classes instead of User Defined Types (UDT). For example, to manage the data in unbound forms. Adolph will...
0
6750
by: conductexam | last post by:
I have .net C# application in which I am extracting data from word file and save it in database particularly. To store word all data as it is I am converting the whole word file firstly in HTML and then checking html paragraph one by one. At the time of converting from word file to html my equations which are in the word document file was convert into image. Globals.ThisAddIn.Application.ActiveDocument.Select();...
1
4070
by: 6302768590 | last post by:
Hai team i want code for transfer the data from one system to another through IP address by using C# our system has to for every 5mins then we have to update the data what the data is updated we have to send another system
3
2894
bsmnconsultancy
by: bsmnconsultancy | last post by:
In today's digital era, a well-designed website is crucial for businesses looking to succeed. Whether you're a small business owner or a large corporation in Toronto, having a strong online presence can significantly impact your brand's success. BSMN Consultancy, a leader in Website Development in Toronto offers valuable insights into creating effective websites that not only look great but also perform exceptionally well. In this comprehensive...

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.