I think I found a small defect with the <ndoc> task or I am just not
understanding how it works.
We are developing documentation for a project I am working on, adding our
own custom tags and created an NDoc xslt for the tags. These things all
work fine when I use the GUI or the console app. When I use the <ndoc> task
in nant the pages compile, but I get a red error message on the compiled
webpages saying:
"Missing <summary> documentation for T:ENS.src.Driver"
Please keep in mind when I build my assembly, I ask it to send the xml
comments to a different location than the "bin" directory. Here is my nant
script for the <ndoc> task.
<ndoc>
<assemblies>
<include name="${project.root}bin\ENS.dll" />
</assemblies>
<referencepaths>
<include name="${project.root}xml\ENS.xml" />
</referencepaths>
<documenters>
<documenter name="MSDN">
<property name="OutputDirectory" value="${project.root}doc\NDoc"
/>
<property name="ExtensibilityStyleSheet"
value="${project.root}web\xsl\EnsNDoc.xsl" />
.... ommitted for brevity
</documenter>
</documenters>
</ndoc>
If I use this command with the console app (see below), I do not get the
error message. Please note that the first parameter of the console app
allows you to specify the EXACT location of the assembly and its xml comment
file. I see no place in the <ndoc> task that allows you to replicate this
behavior of the console app. What am I missing?
C:\Program Files\bin\net\1.1>ndocconsole
D:\projects\ENS\bin\ENS.dll,D:\projects\ENS\xml\ENS.xml -documentor=MSDN
-ExtensibilityStyleSheet=D:\projects
\ENS\web\xsl\ENSNDoc.xsl -OutputDirectory=D:\projects\ENS\doc\NDoc
Now for my questions:
1) What are the <referencepaths> tags for? I think any assemblies (your own
or a third party) you use in the project, but I am not sure. Can some one
show me an example?
2) What are the <summaries> tag for? Again please provide some examples.
Carlton
-------------------------------------------------------
SF email is sponsored by - The IT Product Guide
Read honest & candid reviews on hundreds of IT Products from real users.
Discover which products truly live up to the hype. Start reading now.
http://ads.osdn.com/?ad_id=6595&alloc_id=14396&op=click
_______________________________________________
Nant-users mailing list
Nant-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/nant-users
