#246 Newbie: Missing <summary> documentation for T:...

[L Scott]

Version: NDoc 1.3
Framework: MS 1.1
Documenter: MSDN

I have a simple C# WinForm application (with a very
long name) that, I believe, has the proper comment
decorators, but when I run NDoc (both console & gui
and originally from NANT) I get the 'Missing <summary>
documentation for' line at the 'Classes' level in the
output. Decorated as:

namespace SomeFakeNamespaceHere
{
/// <summary>
/// Form1 is a form that is numbered one.
/// </summary>
public class Form1 :
System.Windows.Forms.Form

It appears to me I'm not successfully getting the /doc:
XML file into NDoc because if I look at the contents of
that file, it contains:

<member
name="T:SomeFakeNamespaceHere.Form1">
<summary>
Summary description for Form1.
</summary>
</member>

So I put together a Windows .BAT file to run the NDoc
console. Here's what the command line looks like:

"\Program Files\NDoc 1.3\bin\net\1.1
\NDocConsole.exe" "C:\Apps\CCNet\Viper\2.0.ViperDev\
NAntBuildOutput\bin\RemotingEx.exe","C:\Apps\CCNet\
Viper\2.0.ViperDev\NAntBuildOutput\bin\RemotingEx.xm
l" -
referencepath="C:\Apps\CCNet\Viper\2.0.ViperDev\NAnt
BuildOutput\bin\" -
namespacesummaries="C:\Apps\CCNet\Viper\1.0.Viper
Scripts\NamespaceSummary.xml" -
documenter=MSDN -
OutputDirectory="C:\Apps\CCNet\Viper\2.0.ViperDev\ND
ocDoc" -HtmlHelpName=Viper -
HtmlHelpCompilerFilename=hhc.exe -
IncludeFavorites=False -Title="Viper Documentation" -
SplitTOCs=False -DefaulTOC= -ShowVisualBasic=True -
ShowMissingSummaries=True -
ShowMissingRemarks=True -
ShowMissingParams=True -ShowMissingReturns=True -
ShowMissingValues=True -DocumentInternals=False -
DocumentProtected=True -DocumentPrivates=False -
DocumentEmptyNamespaces=False -
IncludeAssemblyVersion=False -CopyrightText= -
CopyrightHref=

What am I doing wrong? Any help would be greatly
appreciated. Thanks.

[Kevin Downs]

Logged In: YES
user_id=919791

I believe there are two issues here...

1. From your description it looks as if the xml does not
match the code comments.

Given,

namespace RemotingEx
{
/// <summary>
/// Form1 is a form that is numbered one.
/// </summary>
public class Form1 : System.Windows.Forms.Form

I would expect the xml to be something like,

<member name="T:RemotingEx.Form1">
<summary>
Form1 is a form that is numbered one.
</summary>
</member>

Check "Configuration Properties | Advanced | Incremental
Build" in the project properties dialog, and ensure it is set to
false. VS defaults to incremental builds in debug
configurations, which does not rebuild the xml on every
compile...

2. If I remember correctly, any summary description of the
form "Summary for " is flagged as missing; since this is the
standard 'boilerplate' comment added when a class is
created, it has no actual documentation value and so is
considered useless filler....