473,399 Members | 3,832 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,399 software developers and data experts.

.Net 2.0 Xml Documentation Generation

Hi all,
does anyone know of any tools which can be used with .Net 2.0 to create
XML documentation. There used to be a tool in VS2003 which would do this,
but it is not in 2005 and I also used to use NDoc but that does not support
2.0 (only a subset). Seems to me like there is nothing out there to do this
at the moment, do other people not find this documentation useful?

Mark.
Jan 16 '06 #1
4 1340
You might want to re-check the NDOC status for .NET 2.0 here:

http://ndoc.sourceforge.net/wiki/dotNet_2.0_Support

Peter
--
Co-founder, Eggheadcafe.com developer portal:
http://www.eggheadcafe.com
UnBlog:
http://petesbloggerama.blogspot.com


"Mark R. Dawson" wrote:
Hi all,
does anyone know of any tools which can be used with .Net 2.0 to create
XML documentation. There used to be a tool in VS2003 which would do this,
but it is not in 2005 and I also used to use NDoc but that does not support
2.0 (only a subset). Seems to me like there is nothing out there to do this
at the moment, do other people not find this documentation useful?

Mark.

Jan 16 '06 #2
VS 2005 does have this feature.

Ex.

/// <summary>
/// Clean up any resources being used.
/// </summary>
protected override void Dispose( bool disposing )
{

then you have to set the Project settings so that it compiles the XML
Documentation whenever u compile ur program, u can find the XML document in
your bin\debug or release folder.

You can turn on XML documenation compilation by right clicking the project
file in the solution explorer, clicking properties and then on the screen
that comes click on the Build tab then Check the XML documenation file
checkbox and specify the filename.
"Mark R. Dawson" wrote:
Hi all,
does anyone know of any tools which can be used with .Net 2.0 to create
XML documentation. There used to be a tool in VS2003 which would do this,
but it is not in 2005 and I also used to use NDoc but that does not support
2.0 (only a subset). Seems to me like there is nothing out there to do this
at the moment, do other people not find this documentation useful?

Mark.

Jan 16 '06 #3
Hi Alex,
thanks for the reply. I should have been a little bit clearer, I wanted
a program that can produce graphical output like html from the Xml
Documentation.

Thanks
Mark.

"AlexDP" wrote:
VS 2005 does have this feature.

Ex.

/// <summary>
/// Clean up any resources being used.
/// </summary>
protected override void Dispose( bool disposing )
{

then you have to set the Project settings so that it compiles the XML
Documentation whenever u compile ur program, u can find the XML document in
your bin\debug or release folder.

You can turn on XML documenation compilation by right clicking the project
file in the solution explorer, clicking properties and then on the screen
that comes click on the Build tab then Check the XML documenation file
checkbox and specify the filename.
"Mark R. Dawson" wrote:
Hi all,
does anyone know of any tools which can be used with .Net 2.0 to create
XML documentation. There used to be a tool in VS2003 which would do this,
but it is not in 2005 and I also used to use NDoc but that does not support
2.0 (only a subset). Seems to me like there is nothing out there to do this
at the moment, do other people not find this documentation useful?

Mark.

Jan 17 '06 #4
Hi Peter,
thanks for the reply. I had looked at this link, unfortunately at the
moment there does not seem to be any support for VS2005 solutions and
projects and not full 2.0 compatibility. Guess I wil have to wait a bit.

Thanks
Mark.

"Peter Bromberg [C# MVP]" wrote:
You might want to re-check the NDOC status for .NET 2.0 here:

http://ndoc.sourceforge.net/wiki/dotNet_2.0_Support

Peter
--
Co-founder, Eggheadcafe.com developer portal:
http://www.eggheadcafe.com
UnBlog:
http://petesbloggerama.blogspot.com


"Mark R. Dawson" wrote:
Hi all,
does anyone know of any tools which can be used with .Net 2.0 to create
XML documentation. There used to be a tool in VS2003 which would do this,
but it is not in 2005 and I also used to use NDoc but that does not support
2.0 (only a subset). Seems to me like there is nothing out there to do this
at the moment, do other people not find this documentation useful?

Mark.

Jan 17 '06 #5

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

Similar topics

2
by: JackFrost | last post by:
Hi all, I recently read an article on the Windows Scripting Host Object Model (WSHOM) in a back issue of Visual Studios Journal from 2000. As it gives me a useful and easy way to access all of...
8
by: Robin Becker | last post by:
It seems the Gods are proposing to distribute the documentation and help for Python-2.3.1 in .chm form. I particularly detest .chm and much prefer .html as it works across all platforms....
1
by: Colin J. Williams | last post by:
I am building a module which is based on the numarray package and its sub-packages. I am proposing to use PyDoc to document this module. The problem is that PyDoc generates links to...
3
by: Matthias | last post by:
Hello, I have a Canvas-Widget and will use as a "array of pixel". At Positon x,y I print a rectangle with a special color. I give the rectangle no objectname. Then I will ask the...
0
by: Jeff Levinson [mcsd] | last post by:
I'm an architect for a very large fortune 100 company and we still struggle with the best balance. However, I use a couple of simple guidelines that have worked very well for me in almost all...
1
by: Ole Hanson | last post by:
I would like to be able to generate documentation for a custom configuration file (xml) to enable future support engineers to understand applicable values to the various elements inside the...
8
by: Will Pittenger | last post by:
I have a Windows program C# .NET solution where when I update its XML documentation, some tags are not recognized and turned into the corresponding HTML. Those tags include <c>, <code>, <para>,...
1
by: Lonnie Princehouse | last post by:
I plan on writing some documentation that will consist of blocks of commentary with interspersed snippets of syntax-colored Python code and the occaisional image. Does anyone know of a package...
1
by: Ryan Ginstrom | last post by:
I have been maintaining a body of documentation in plain HTML files. I would now like to automate the generation of the HTML files. Maintaining the HTML files now is tedious and error prone,...
1
by: nemocccc | last post by:
hello, everyone, I want to develop a software for my android phone for daily needs, any suggestions?
0
by: Hystou | last post by:
There are some requirements for setting up RAID: 1. The motherboard and BIOS support RAID configuration. 2. The motherboard has 2 or more available SATA protocol SSD/HDD slots (including MSATA, M.2...
0
marktang
by: marktang | last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However,...
0
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...
0
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,...
0
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...
0
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...
0
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,...
0
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...

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.