Home All Groups Group Topic Archive Search About

how to produce library documentation?

Author
28 Jun 2006 2:23 PM
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?

Author
28 Jun 2006 2:46 PM
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




Show quote
"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?
>
>
>
Author
28 Jun 2006 3:50 PM
Lloyd Dupont
Doesn't for me :(

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

Show quote
"Peter Bromberg [C# MVP]" <pbromberg@yahoo.nospammin.com> wrote in message
news:965514DE-5F7E-4387-9BAC-BFDA64DE713F@microsoft.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?
>>
>>
>>
Author
29 Jun 2006 7:15 AM
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#)
------------------------------------------------------------------------
Author
29 Jun 2006 3:42 PM
Jeff Grossman
I am using NDoc 1.3.1 with Framework 2.0 with no problems.

What are your issues?

Show quote
"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?
>
>
>
Author
30 Jun 2006 4:08 AM
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>
Show quote
"Jeff Grossman" <JeffGross***@discussions.microsoft.com> wrote in message
news:781120B1-471C-4488-9A59-8C705CD01FBE@microsoft.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?
>>
>>
>>
Author
3 Jul 2006 4:26 PM
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
Author
3 Jul 2006 11:35 PM
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>
Show quote
"Mini-Tools Timm" <info at mini-tools dot com> wrote in message
news:26F3BEFD-4801-45FB-B6F6-2FA5DA60ABB9@microsoft.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
>

AddThis Social Bookmark Button