467,915 Members | 1,861 Online
Bytes | Developer Community
New Post

Home Posts Topics Members FAQ

Post your question to a community of 467,915 developers. It's quick & easy.

Excluding some Public Classes in NDoc

Hi there,

I am using NDOC to generate docs for one C# project which I wrote. My
assembly has some public classes that are not meant to be used by others and
I have not documented them. I would like NDOC not to generate documentation
for those public classes that do not have an XML documentation. Can anyone
suggest how I do that?

All help much appreciated

Thanks
Ash Moollan
Software Developer / Consultant
Nov 17 '05 #1
  • viewed: 2397
Share:
7 Replies
I believe there is a /nodoc compiler switch you should look at.
"Ash Moollan [InfoMaster]" <As************@infomaster.com.au> wrote in
message news:uK**************@tk2msftngp13.phx.gbl...
Hi there,

I am using NDOC to generate docs for one C# project which I wrote. My
assembly has some public classes that are not meant to be used by others
and I have not documented them. I would like NDOC not to generate
documentation for those public classes that do not have an XML
documentation. Can anyone suggest how I do that?

All help much appreciated

Thanks
Ash Moollan
Software Developer / Consultant

Nov 17 '05 #2
I may have misundrstood your question initially, but I found this in the
NDOC docs:

If you scroll to the bottom of the property grid in NdocGui, you will see a
category of options called "Visibility". These options will allow you to,
for instance, document internal or private classes. If you try changing
'DocumentInternals' to true, you should produce some documentation.
Not sure if this answers your question, but I hope it is helpful.

"AdamM" <no****@nospam.com> wrote in message
news:Hv********************@comcast.com...
I believe there is a /nodoc compiler switch you should look at.
"Ash Moollan [InfoMaster]" <As************@infomaster.com.au> wrote in
message news:uK**************@tk2msftngp13.phx.gbl...
Hi there,

I am using NDOC to generate docs for one C# project which I wrote. My
assembly has some public classes that are not meant to be used by others
and I have not documented them. I would like NDOC not to generate
documentation for those public classes that do not have an XML
documentation. Can anyone suggest how I do that?

All help much appreciated

Thanks
Ash Moollan
Software Developer / Consultant


Nov 17 '05 #3
"Ash Moollan [InfoMaster]" <As************@infomaster.com.au> wrote in
message news:uK**************@tk2msftngp13.phx.gbl...
Hi there,

I am using NDOC to generate docs for one C# project which I wrote. My
assembly has some public classes that are not meant to be used by others
and I have not documented them. I would like NDOC not to generate
documentation for those public classes that do not have an XML
documentation. Can anyone suggest how I do that?

All help much appreciated


Add the <exclude /> tag like this:

/// <summary>
/// <exclude />
/// This won't be in NDoc!
/// </summary>
Nov 17 '05 #4
KD
Try using the <exclude/> tag

http://ndoc.sourceforge.net/content/tag_exclude.htm

"Ash Moollan [InfoMaster]" <As************@infomaster.com.au> wrote in
message news:uK**************@tk2msftngp13.phx.gbl...
Hi there,

I am using NDOC to generate docs for one C# project which I wrote. My
assembly has some public classes that are not meant to be used by others
and I have not documented them. I would like NDOC not to generate
documentation for those public classes that do not have an XML
documentation. Can anyone suggest how I do that?

All help much appreciated

Thanks
Ash Moollan
Software Developer / Consultant

Nov 17 '05 #5
Hi all,
Thanks for all your help. I ended up looking at the NDOC source code and I
added a new option in there not to document classes that do not have
comment.

e.g
/// <Summary>Blah Class</Summary>
Public Class Blah {}

Public Class Blah1{}

After running this through my version of NDOC, documentation will only be
generated for class Blah and not Blah.
I did that because the access modifiers option in NDOC is not enough because
both classes are public.

If anyone is interrested to know how i set that flag, give me a yell and
i'll post the code.

Thanks
Ash Moollan
Software Developer / Consultant

"KD" <kd@home> wrote in message
news:eg**************@TK2MSFTNGP12.phx.gbl...
Try using the <exclude/> tag

http://ndoc.sourceforge.net/content/tag_exclude.htm

"Ash Moollan [InfoMaster]" <As************@infomaster.com.au> wrote in
message news:uK**************@tk2msftngp13.phx.gbl...
Hi there,

I am using NDOC to generate docs for one C# project which I wrote. My
assembly has some public classes that are not meant to be used by others
and I have not documented them. I would like NDOC not to generate
documentation for those public classes that do not have an XML
documentation. Can anyone suggest how I do that?

All help much appreciated

Thanks
Ash Moollan
Software Developer / Consultant


Nov 17 '05 #6
Ash,

Yes, I would be interested in seeing your version of the NDOC source
code. Please post it.

As it stands, I am not much impressed with NDOCS. It seems to pump out
a lot of boilerplate. Documentation was better back in the heyday of
VB5, when there was an OCX from Sheridan called vbDocumenter. It
created help files without the BS.

Jeff Roughgarden.

Ash Moollan [InfoMaster] wrote:
Hi all,
Thanks for all your help. I ended up looking at the NDOC source code and I added a new option in there not to document classes that do not have
comment.

e.g
/// <Summary>Blah Class</Summary>
Public Class Blah {}

Public Class Blah1{}

After running this through my version of NDOC, documentation will only be generated for class Blah and not Blah.
I did that because the access modifiers option in NDOC is not enough because both classes are public.

If anyone is interrested to know how i set that flag, give me a yell and i'll post the code.

Thanks
Ash Moollan
Software Developer / Consultant


Nov 17 '05 #7
Jeff,

I have put the code up on http://www.moollan.net/files

The code is under the same licencing scheme as the original code: the
gnu gpl.
If you dont know what that is, please get yourself a copy and read it
before you download.

Thanks
Ash Moollan
www.moollan.net

Nov 17 '05 #8

This discussion thread is closed

Replies have been disabled for this discussion.

Similar topics

2 posts views Thread by Henrik Dahl | last post: by
reply views Thread by GearsR4Girls | last post: by
reply views Thread by Kent Boogaart | last post: by
6 posts views Thread by Al-Burak | last post: by
1 post views Thread by Steve Barnett | last post: by
7 posts views Thread by Lonifasiko | last post: by
10 posts views Thread by Brian Richards | last post: by
8 posts views Thread by Kuldeep | last post: by
4 posts views Thread by Peter Lykkegaard | last post: by
By using this site, you agree to our Privacy Policy and Terms of Use.