171 lines
7.4 KiB
HTML
171 lines
7.4 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
|||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|||
|
|
<!-- Documenting T:NAnt.DotNet.Tasks.NDocTask-->
|
|||
|
|
<head>
|
|||
|
|
<meta http-equiv="Content-Language" content="en-ca" />
|
|||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../style.css" />
|
|||
|
|
<title><ndoc> Task</title>
|
|||
|
|
</head>
|
|||
|
|
<body>
|
|||
|
|
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
|
|||
|
|
<tr>
|
|||
|
|
<td class="NavBar-Cell">
|
|||
|
|
<a href="http://nant.sourceforge.net">
|
|||
|
|
<b>NAnt</b>
|
|||
|
|
</a>
|
|||
|
|
<img alt="->" src="../images/arrow.gif" />
|
|||
|
|
<a href="../index.html">Help</a>
|
|||
|
|
<img alt="->" src="../images/arrow.gif" />
|
|||
|
|
<a href="../tasks/index.html">Task Reference</a>
|
|||
|
|
<img alt="->" src="../images/arrow.gif" /> <ndoc></td>
|
|||
|
|
<td class="NavBar-Cell" align="right">
|
|||
|
|
v0.91</td>
|
|||
|
|
</tr>
|
|||
|
|
</table>
|
|||
|
|
<h1><ndoc></h1>
|
|||
|
|
<p> Runs NDoc V1.3.1 to create documentation. </p>
|
|||
|
|
<p> See the <a href="http://ndoc.sourceforge.net/">NDoc home page</a> for more information. </p>
|
|||
|
|
<p class="i2">
|
|||
|
|
<b>Note:</b> By default, only the NDoc MSDN documenter ships as part of the NAnt distribution. To make another NDoc documenter from the NDoc V1.3.1 distribution available to the <a href="../tasks/ndoc.html"><ndoc></a> task, copy the documenter assembly (and possible dependencies) to the "lib" directory corresponding with the CLR you're running NAnt on (eg. <nant root>/bin/lib/net/1.1). </p>
|
|||
|
|
<h3>Parameters</h3>
|
|||
|
|
<div class="table">
|
|||
|
|
<table>
|
|||
|
|
<tr>
|
|||
|
|
<th>Attribute</th>
|
|||
|
|
<th style="text-align: center;">Type</th>
|
|||
|
|
<th>Description</th>
|
|||
|
|
<th style="text-align: center;">Required</th>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td valign="top">failonerror</td>
|
|||
|
|
<td style="text-align: center;">bool</td>
|
|||
|
|
<td> Determines if task failure stops the build, or is just reported. The default is <b>true</b>. </td>
|
|||
|
|
<td style="text-align: center;">False</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td valign="top">if</td>
|
|||
|
|
<td style="text-align: center;">bool</td>
|
|||
|
|
<td> If <b>true</b> then the task will be executed; otherwise, skipped. The default is <b>true</b>. </td>
|
|||
|
|
<td style="text-align: center;">False</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td valign="top">unless</td>
|
|||
|
|
<td style="text-align: center;">bool</td>
|
|||
|
|
<td> Opposite of <code>if</code>. If <b>false</b> then the task will be executed; otherwise, skipped. The default is <b>false</b>. </td>
|
|||
|
|
<td style="text-align: center;">False</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td valign="top">verbose</td>
|
|||
|
|
<td style="text-align: center;">bool</td>
|
|||
|
|
<td> Determines whether the task should report detailed build log messages. The default is <b>false</b>. </td>
|
|||
|
|
<td style="text-align: center;">False</td>
|
|||
|
|
</tr>
|
|||
|
|
</table>
|
|||
|
|
</div>
|
|||
|
|
<h3>Nested Elements:</h3>
|
|||
|
|
<!--Element-->
|
|||
|
|
<h4>
|
|||
|
|
<a id="assemblies">
|
|||
|
|
</a>
|
|||
|
|
<<a href="../types/assemblyfileset.html">assemblies</a>>
|
|||
|
|
</h4>
|
|||
|
|
<div class="nested-element"> The set of assemblies to document. <p /></div>
|
|||
|
|
<h4>
|
|||
|
|
<a id="assemblies">
|
|||
|
|
</a>
|
|||
|
|
</<a href="../types/assemblyfileset.html">assemblies</a>>
|
|||
|
|
</h4>
|
|||
|
|
<!--Element-->
|
|||
|
|
<h4>
|
|||
|
|
<a id="summaries">
|
|||
|
|
</a>
|
|||
|
|
<<a href="../types/fileset.html">summaries</a>>
|
|||
|
|
</h4>
|
|||
|
|
<div class="nested-element"> The set of namespace summary files. <p /></div>
|
|||
|
|
<h4>
|
|||
|
|
<a id="summaries">
|
|||
|
|
</a>
|
|||
|
|
</<a href="../types/fileset.html">summaries</a>>
|
|||
|
|
</h4>
|
|||
|
|
<!--Element-->
|
|||
|
|
<h4>
|
|||
|
|
<a id="documenters">
|
|||
|
|
</a>
|
|||
|
|
<documenters>
|
|||
|
|
</h4>
|
|||
|
|
<div class="nested-element"> Specifies the formats in which the documentation should be generated. <p> Represents an element of which the XML is processed by its parent task or type. </p><p /></div>
|
|||
|
|
<h4>
|
|||
|
|
<a id="documenters">
|
|||
|
|
</a>
|
|||
|
|
</documenters>
|
|||
|
|
</h4>
|
|||
|
|
<!--Element-->
|
|||
|
|
<h4>
|
|||
|
|
<a id="referencepaths">
|
|||
|
|
</a>
|
|||
|
|
<<a href="../types/dirset.html">referencepaths</a>>
|
|||
|
|
</h4>
|
|||
|
|
<div class="nested-element"> Collection of additional directories to search for referenced assemblies. <p /></div>
|
|||
|
|
<h4>
|
|||
|
|
<a id="referencepaths">
|
|||
|
|
</a>
|
|||
|
|
</<a href="../types/dirset.html">referencepaths</a>>
|
|||
|
|
</h4>
|
|||
|
|
<h3>Examples</h3>
|
|||
|
|
<ul class="examples">
|
|||
|
|
<li>
|
|||
|
|
<p> Document two assemblies using the MSDN documenter. The namespaces are documented in <code>NamespaceSummary.xml</code>. </p>
|
|||
|
|
<pre class="code">
|
|||
|
|
<ndoc>
|
|||
|
|
<assemblies basedir="${build.dir}">
|
|||
|
|
<include name="NAnt.exe" />
|
|||
|
|
<include name="NAnt.Core.dll" />
|
|||
|
|
</assemblies>
|
|||
|
|
<summaries basedir="${build.dir}">
|
|||
|
|
<include name="NamespaceSummary.xml" />
|
|||
|
|
</summaries>
|
|||
|
|
<documenters>
|
|||
|
|
<documenter name="MSDN">
|
|||
|
|
<property name="OutputDirectory" value="doc\MSDN" />
|
|||
|
|
<property name="HtmlHelpName" value="NAnt" />
|
|||
|
|
<property name="IncludeFavorites" value="False" />
|
|||
|
|
<property name="Title" value="An NDoc Documented Class Library" />
|
|||
|
|
<property name="SplitTOCs" value="False" />
|
|||
|
|
<property name="DefaulTOC" value="" />
|
|||
|
|
<property name="ShowVisualBasic" value="True" />
|
|||
|
|
<property name="ShowMissingSummaries" value="True" />
|
|||
|
|
<property name="ShowMissingRemarks" value="True" />
|
|||
|
|
<property name="ShowMissingParams" value="True" />
|
|||
|
|
<property name="ShowMissingReturns" value="True" />
|
|||
|
|
<property name="ShowMissingValues" value="True" />
|
|||
|
|
<property name="DocumentInternals" value="False" />
|
|||
|
|
<property name="DocumentProtected" value="True" />
|
|||
|
|
<property name="DocumentPrivates" value="False" />
|
|||
|
|
<property name="DocumentEmptyNamespaces" value="False" />
|
|||
|
|
<property name="IncludeAssemblyVersion" value="False" />
|
|||
|
|
<property name="CopyrightText" value="" />
|
|||
|
|
<property name="CopyrightHref" value="" />
|
|||
|
|
</documenter>
|
|||
|
|
</documenters>
|
|||
|
|
</ndoc>
|
|||
|
|
</pre>
|
|||
|
|
<p>Content of <code>NamespaceSummary.xml</code> :</p>
|
|||
|
|
<pre class="code">
|
|||
|
|
<namespaces>
|
|||
|
|
<namespace name="Foo.Bar">
|
|||
|
|
The <b>Foo.Bar</b> namespace reinvents the wheel.
|
|||
|
|
</namespace>
|
|||
|
|
<namespace name="Foo.Bar.Tests">
|
|||
|
|
The <b>Foo.Bar.Tests</b> namespace ensures that the Foo.Bar namespace reinvents the wheel correctly.
|
|||
|
|
</namespace>
|
|||
|
|
</namespaces>
|
|||
|
|
</pre>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<h3>Requirements</h3>
|
|||
|
|
<div style="margin-left: 20px;">
|
|||
|
|
<b>Assembly:</b> NAnt.DotNetTasks (0.91.4312.0)
|
|||
|
|
</div>
|
|||
|
|
</body>
|
|||
|
|
</html>
|