Menu
▾
▴
#64 namespace summary
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
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>
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.
Logged In: YES
user_id=742011
Is there a command-line way to specify a namespace
summary?
Thanks,
Philippe
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.
Logged In: YES
user_id=742011
I went via the project file approach and it worked great. The
weird thing was any cref's need to use the generated
assembly.xml style ("T:fully-qualified-class").
Is the project file UTF-8?
Thanks,
Philippe
Logged In: YES
user_id=235364
Since it is the C# compiler that resolves the cref's into fully
qualified member references, you have to do it manually for
the namespace summaries.
UTF-8 encoding is used to write NDoc's project files.