[ndoc-tracker] [ ndoc-Support Requests-710088 ] namespace summary

[SourceForge.net <no...@so...>]

Support Requests item #710088, was opened at 2003-03-26 07:10
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=416079&aid=710088&group_id=36057

Category: None
Group: None
Status: Open
Priority: 5
Submitted By: Philippe Bertrand (pfbertrand)
Assigned to: Jean-Claude Manoli (jcman)
Summary: namespace summary

Initial Comment:
When I enable ShowMissingSummaries while building 
MSDN docs, I get a warning that my namespace is 
missing its summary, yet, I can't figure out how to 
specify a summary in such a way that the C# compiler 
doesn't complain.

.cs(2,1): error CS1587: XML comment is not placed on a 
valid language element

I tried placing the summary before and after 
the "namespace foo.bar {" line in one of my classes.

Is there a way to externally specify the namespace 
summary to ndoc?

Thanks,
Philippe

----------------------------------------------------------------------

>Comment By: Jean-Claude Manoli (jcman)
Date: 2003-03-26 12:29

Message:
Logged In: YES 
user_id=235364

There are two possibilities:

1. You create an ndoc project file with the NDocGUI and use 
the "-project" option with NDocConsole.

2. You use the "-namespacesummaries" option of 
NDocConsole (only available with NDoc's latest source code 
from CVS).

Run NDocConsole with no parameters to see the complete 
list of options.


----------------------------------------------------------------------

Comment By: Philippe Bertrand (pfbertrand)
Date: 2003-03-26 11:43

Message:
Logged In: YES 
user_id=742011

Is there a command-line way to specify a namespace 
summary?

Thanks,
Philippe

----------------------------------------------------------------------

Comment By: Jean-Claude Manoli (jcman)
Date: 2003-03-26 10:35

Message:
Logged In: YES 
user_id=235364

C# does not support documenting namespaces.  However, 
you can use NDoc's "Namespace Summaries" button to add 
namespace summaries that will be saved in the NDoc project 
file.


----------------------------------------------------------------------

Comment By: Philippe Bertrand (pfbertrand)
Date: 2003-03-26 10:22

Message:
Logged In: YES 
user_id=742011

I tried manually inserting a <summary> in the C# generated 
xml file but ndoc did not pick it up.

<assembly>
<name>Foo</name>
<summary><para>
Bar
</para></summary>
</assembly>

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=416079&aid=710088&group_id=36057