Professional.Open.Source.dot.NET.Development.Programming.with.NAnt.NUnit.NDoc [Electronic resources]

John Wait

نسخه متنی -صفحه : 275/ 155
نمايش فراداده

<ndoc>Runs NDoc to create documentation.

Attribute

Description

Required

failonerror

Determines whether task failure stops the build or is just reported. Default is "true."

False

verbose

Task reports detailed build log messages. Default is "false."

False

if

If true then the task will be executed; otherwise skipped. Default is "true."

False

unless

Opposite of if. If false then the task will be executed; otherwise skipped. Default is "false."

False

Example

<ndoc>
<assemblies basedir="${build.dir}">
<includes name="NAnt.exe"/>
<includes name="NAnt.Core.dll"/>
</assemblies>
<summaries basedir="${build.dir}">
<includes name="NamespaceSummary.xml"/>
</summaries>
<documenters>
<documenter name="MSDN">
<property name="OutputDirectory" value="doc\MSDN" />
<property name="HtmlHelpName" value="NAnt" />
<property name="HtmlHelpCompilerFilename" value="hhc.exe" />
<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" /v
<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>
________________________________________________________________
NamespaceSummary.xml contents
________________________________________________________________
<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>