how to produce library documentation?

Lloyd Dupont

I'm trying to write the documentation of my library using XML tags.
I'm using NDoc but it doesn't support C# 2.0 very well.
Any tip on what other product I could use?

Jun 28 '06 #1

Subscribe Post Reply

1632

Peter Bromberg [C# MVP]

Lloyd,

Jonas Lagerblad has a nice build of NDoc targeted to the 2.0 Framework that
works well for me:

http://jonas.lagerblad.com/blog/?p=4

Peter

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

"Lloyd Dupont" wrote:

I'm trying to write the documentation of my library using XML tags.
I'm using NDoc but it doesn't support C# 2.0 very well.
Any tip on what other product I could use?

Jun 28 '06 #2

Lloyd Dupont

Doesn't for me :(

Anyway apparently Microsoft is coming up with a documentation compiler for
very soon...

"Peter Bromberg [C# MVP]" <pb*******@yahoo.nospammin.com> wrote in message
news:96**********************************@microsof t.com...

Lloyd,

Jonas Lagerblad has a nice build of NDoc targeted to the 2.0 Framework
that
works well for me:

http://jonas.lagerblad.com/blog/?p=4

Peter

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

"Lloyd Dupont" wrote:
I'm trying to write the documentation of my library using XML tags.
I'm using NDoc but it doesn't support C# 2.0 very well.
Any tip on what other product I could use?

Jun 28 '06 #3

Frans Bouma [C# MVP]

Peter Bromberg [C# MVP] wrote:

Lloyd,

Jonas Lagerblad has a nice build of NDoc targeted to the 2.0
Framework that works well for me:

http://jonas.lagerblad.com/blog/?p=4

Didn't work for me, unfortunately. It does generate the pages but the
helpcompiler simply dies, so no .CHM. I went for a commercial solution
(DocumentX). Not perfect either, but at least I get output ;)

FB

--
------------------------------------------------------------------------
Lead developer of LLBLGen Pro, the productive O/R mapper for .NET
LLBLGen Pro website: http://www.llblgen.com
My .NET blog: http://weblogs.asp.net/fbouma
Microsoft MVP (C#)
------------------------------------------------------------------------

Jun 29 '06 #4

Jeff Grossman

I am using NDoc 1.3.1 with Framework 2.0 with no problems.

What are your issues?

"Lloyd Dupont" wrote:

I'm trying to write the documentation of my library using XML tags.
I'm using NDoc but it doesn't support C# 2.0 very well.
Any tip on what other product I could use?

Jun 29 '06 #5

Lloyd Dupont

All my generic methods get screwed up documentation.
Sometimes the method don't even appears!

--
Regards,
Lloyd Dupont

NovaMind development team
NovaMind Software
Mind Mapping Software
<www.nova-mind.com>
"Jeff Grossman" <Je**********@discussions.microsoft.com> wrote in message
news:78**********************************@microsof t.com...

I am using NDoc 1.3.1 with Framework 2.0 with no problems.

What are your issues?

"Lloyd Dupont" wrote:
I'm trying to write the documentation of my library using XML tags.
I'm using NDoc but it doesn't support C# 2.0 very well.
Any tip on what other product I could use?

Jun 30 '06 #6

Mini-Tools Timm

"Lloyd Dupont" wrote:

I'm trying to write the documentation of my library using XML tags.
I'm using NDoc but it doesn't support C# 2.0 very well.
Any tip on what other product I could use?

If you are willing to pay, DocumentX by Innovasys does an excellent job
generating documentation and works well for .NET 2.0.

http://www.innovasys.com/products/dx5/overview.asp

(I am not associated with Innovasys in any way, other than as a satisfied
customer of their products.)

--
Timm Martin
Mini-Tools
..NET Components and Windows Software
http://www.mini-tools.com

Jul 3 '06 #7

Lloyd Dupont

It is for home made product (not yet finished)
When I see th eprice I think I will wait a lottle more...
But thanks for the tip!

--
Regards,
Lloyd Dupont

NovaMind development team
NovaMind Software
Mind Mapping Software
<www.nova-mind.com>
"Mini-Tools Timm" <info at mini-tools dot comwrote in message
news:26**********************************@microsof t.com...

"Lloyd Dupont" wrote:

>I'm trying to write the documentation of my library using XML tags.
I'm using NDoc but it doesn't support C# 2.0 very well.
Any tip on what other product I could use?

If you are willing to pay, DocumentX by Innovasys does an excellent job
generating documentation and works well for .NET 2.0.

http://www.innovasys.com/products/dx5/overview.asp

(I am not associated with Innovasys in any way, other than as a satisfied
customer of their products.)

--
Timm Martin
Mini-Tools
.NET Components and Windows Software
http://www.mini-tools.com

Jul 3 '06 #8

Similar topics

Symbols in library.

by: Torbak | last post by:

I got some question about symbols in libraries ... In libraries, there is public symbols and "not public" symbols (private, static)... In C when we use the "static" keyword on the declaration of...

C / C++

Shared library upward compatible versions in MSI kits

by: Lee Gillie | last post by:

We have systems built upon shared libraries, which are maintained by a group of programmers. We install these to the GAC on production servers. For saftey, when a programmer uses one of these...

.NET Framework

Make library module comments appear in object browser

by: Gary James | last post by:

I'm making a C# library module that has methods & properties that I've commented. I would like these comments to appear in the object browser when the library is used by another .NET application....

C# / C Sharp

Enterprise Library June 2005 - Creating Documentation

by: Mythran | last post by:

I have installed NDoc and VSHIK2003. If I install a clean Enterprise Library June 2005, how can I go about getting the exact same documentation that is installed with the release (in the...

C# / C Sharp

Cache feature doesn't produce expected result (bug?)

by: Tom.PesterDELETETHISSS | last post by:

Hi, I think this question requires an in depth understanding of how a browser cache works. I hope I can reach an expert here. I may have found a quirk in the asp.net documentation or I don't...

ASP.NET

Looking for a good C++ logging library

by: bill1974 | last post by:

I'm looking for a good logging library that is easy to use, and well documented. I've already looked at log4cxx, log4cplus, and Log4cpp. Either I couldn't find the documentation, or I couldn't...

C / C++

va_list: how to produce warnings at compile time if calledincorrectly?

by: Felix Kater | last post by:

Hi, I would like to write a variadic function f(const int MY_TYPE_X, ...) were MY_TYPE_X is not the amount of arguments but an index representing both: the amount of args and their type. So,...

C / C++

managed string library

by: Robert Seacord | last post by:

The SEI has published CMU/SEI-2006-TR-006 "Specifications for Managed Strings" and released a "proof-of-concept" implementation of the managed string library. The specification, source code for...

C / C++

Way to view public function names in a library

by: Xiaoxiao | last post by:

Hi, I got a C library, is there a way to view the public function names in this library so that I can use in my C program? Thanks.

C / C++

Migrating Website to Cloud - Emmanuel Katto

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

General

Looking to do Android software development, any suggestions? Is flutter better?

by: nemocccc | last post by:

hello, everyone, I want to develop a software for my android phone for daily needs, any suggestions?

General

Is that possible of reading the .csv file in column wise and the column have different lengths ?

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...

C / C++

How to build RAID in BIOS?

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...

Computer Hardware

Changing the language in Windows 10

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...

Windows Server

Problem With Comparison Operator <=> in G++

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,...

C / C++

Maximizing Business Potential: The Nexus of Website Design and Digital Marketing

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...

Online Marketing

The easy way to turn off automatic updates for Windows 10/11

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...

Windows Server

Discussion: How does Zigbee compare with other wireless protocols in smart home applications?

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...

General