473,405 Members | 2,279 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,405 software developers and data experts.

API Documentation

I can't seem to find any guidance around this...is there a way to generate
API documention for my classes using VS2005?

--
Pat McGovern
215-416-6490
Dec 5 '05 #1
4 1446
Patrick,

No, there is not, not outright. What you have to do is generate the XML
documentation from your class. Once you have that, there are third party
tools you can use which will create help files, HTML files, etc, etc through
an XML transformation.

Hope this helps.
--
- Nicholas Paldino [.NET/C# MVP]
- mv*@spam.guard.caspershouse.com

"Patrick McGovern" <pa**************@unisys.cm> wrote in message
news:dn**********@trsvr.tr.unisys.com...
I can't seem to find any guidance around this...is there a way to generate
API documention for my classes using VS2005?

--
Pat McGovern
215-416-6490

Dec 5 '05 #2
Nicholas,

thanks! that does help. i see that option now. Do you have the names of any
of those 3rd party tools?

pat

"Nicholas Paldino [.NET/C# MVP]" <mv*@spam.guard.caspershouse.com> wrote in
message news:ej***************@TK2MSFTNGP12.phx.gbl...
Patrick,

No, there is not, not outright. What you have to do is generate the
XML documentation from your class. Once you have that, there are third
party tools you can use which will create help files, HTML files, etc, etc
through an XML transformation.

Hope this helps.
--
- Nicholas Paldino [.NET/C# MVP]
- mv*@spam.guard.caspershouse.com

"Patrick McGovern" <pa**************@unisys.cm> wrote in message
news:dn**********@trsvr.tr.unisys.com...
I can't seem to find any guidance around this...is there a way to generate
API documention for my classes using VS2005?

--
Pat McGovern
215-416-6490


Dec 5 '05 #3
Patrick McGovern wrote:
Nicholas,

thanks! that does help. i see that option now. Do you have the names
of any of those 3rd party tools?


NDoc (http://ndoc.sourceforge.net/)

Arnaud
MVP - VC
Dec 5 '05 #4

"Arnaud Debaene" <ad******@club-internet.fr> wrote in message
news:e2****************@tk2msftngp13.phx.gbl...
Patrick McGovern wrote:
Nicholas,

thanks! that does help. i see that option now. Do you have the names
of any of those 3rd party tools?
NDoc (http://ndoc.sourceforge.net/)


thanks. i need one for VS 2005 though. kind of strange that MS doesnt
support this out of the box isnt it?

Arnaud
MVP - VC

Dec 6 '05 #5

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

Similar topics

20
by: Daniel R. Smorey Jr. | last post by:
I'm looking for a good place for Python documentation. I'm really lost on why it's so hard to find anything when it comes to me looking up a particular function in Python. My example would be the...
11
by: Steve | last post by:
posted on: comp.lang.python emailed to: docs@python.org I have a suggestion/request that will, I think, improve the Python documentation. Currently, the Python documentation in HTML format is...
24
by: Christopher J. Bottaro | last post by:
This post is just the culmination of my thoughts and discussions with my coworkers on Python. If you are not interested, please skip over it. At my work, we are developing a product from...
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...
0
by: Almoni | last post by:
Hi, I have a few .xsd files that include each other in the following way: <!-- lets call the main schema file AA.xsd and it includes BB.xsd inside it --> <xs:schema...
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...
97
by: Cameron Laird | last post by:
QOTW: "Python makes it easy to implement algorithms." - casevh "Most of the discussion of immutables here seems to be caused by newcomers wanting to copy an idiom from another language which...
0
by: innovasys | last post by:
TORQUAY, DEVON, UK - Innovasys announced the release of Document! X 5, the fifth version of the documentation solution of choice for developers using Microsoft Visual Studio or the .NET Framework....
34
by: nicolasfr | last post by:
Hi, I am a bit disapointed with the current Python online documentation. I have read many messages of people complaining about the documentation, it's lack of examples and the use of complicated...
0
by: Charles Arthur | last post by:
How do i turn on java script on a villaon, callus and itel keypad mobile phone
0
by: emmanuelkatto | last post by:
Hi All, I am Emmanuel katto from Uganda. I want to ask what challenges you've faced while migrating a website to cloud. Please let me know. Thanks! Emmanuel
0
BarryA
by: BarryA | last post by:
What are the essential steps and strategies outlined in the Data Structures and Algorithms (DSA) roadmap for aspiring data scientists? How can individuals effectively utilize this roadmap to progress...
1
by: nemocccc | last post by:
hello, everyone, I want to develop a software for my android phone for daily needs, any suggestions?
1
by: Sonnysonu | last post by:
This is the data of csv file 1 2 3 1 2 3 1 2 3 1 2 3 2 3 2 3 3 the lengths should be different i have to store the data by column-wise with in the specific length. suppose the i have to...
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
jinu1996
by: jinu1996 | last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven...
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.