473,651 Members | 2,787 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

.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 1351
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
11235
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 the registry instead of just the VB and VBA registry branch, as GetSettings(...) does; I can't find any useful documentation on it. There is a section on Microsoft's web site, but it isn't the detailed listing of properties, methods and...
8
5745
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. Additionally by having a single index.html for all of the various bits of Python help I can link in things like Pmw, PIL and Quick Guide etc with a simple text editor. The argument is made that .chm is a better mechanism (more searchable indexable etc)...
1
4759
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 documentation on the imported modules and expects to find HTML files in the style: nameOfImportedModule.html. The numarray documentation is not in this style. Is there some way that I can guide PyDoc in the generation of names to
3
2374
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 "root-Canvas-Widget" for the color in position x,y like: color=cw.cget('bg',x,y) I need HELP :))
0
2150
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 cases (there have been some times when I've lived to regret some decisions). Use case work flows are the bread and butter of the documentation and all others flow from them. Each of the high-level processes needs to be broken down into lower level...
1
2974
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 configuration file. (see below for sample). Does any program exist (like NDoc) that is able to generate MSDN like documentation?
8
1992
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>, <paramref>, and <exception>. <remarks> works; I have not tried <include>. Is this a bug in Studio or am I using those tags incorrectly? When the tag appears to have an attribute, I have tried <paramref="parameter">paramter name</paramref> and...
1
1654
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 that will take a high level description of what I just described and auto-generate clean-looking web pages, including syntax coloring? I'm already using epydoc for API reference generation; what I'm looking for here is just something to help out...
1
1558
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, because every time I move/remove/add a section, I have to renumber the following sections and update my internal links. I have looked at some of the HTML-generation frameworks, but the selection is somewhat bewildering, and most also seem geared to...
0
8352
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, people are often confused as to whether an ONU can Work As a Router. In this blog post, we’ll explore What is ONU, What Is Router, ONU & Router’s main usage, and What is the difference between ONU and Router. Let’s take a closer look ! Part I. Meaning of...
0
8275
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
8802
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
8465
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,...
1
6158
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
5612
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();...
0
4144
by: TSSRALBI | last post by:
Hello I'm a network technician in training and I need your help. I am currently learning how to create and manage the different types of VPNs and I have a question about LAN-to-LAN VPNs. The last exercise I practiced was to create a LAN-to-LAN VPN between two Pfsense firewalls, by using IPSEC protocols. I succeeded, with both firewalls in the same network. But I'm wondering if it's possible to do the same thing, with 2 Pfsense firewalls...
1
1909
muto222
by: muto222 | last post by:
How can i add a mobile payment intergratation into php mysql website.
2
1587
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.