NAnt SDK Documentation - v0.92 |

# NDocTask Class

Runs NDoc V1.3.1 to create documentation.

For a list of all members of this type, see NDocTask Members.

System.Object
NAnt.Core.Element
NAnt.Core.Task
NAnt.DotNet.Tasks.NDocTask

[Visual Basic]
<TaskName(Name:="ndoc")>
Public Class NDocTask
Inherits Task
[C#]
[TaskName(Name="ndoc")]
public class NDocTask : Task

#### Thread Safety

Public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Instance members are not guaranteed to be thread-safe.

#### Remarks

See the NDoc home page for more information.

> Note 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 NDocTask, 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).

#### Example

Document two assemblies using the MSDN documenter. The namespaces are documented in `NamespaceSummary.xml`.

    <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>

Content of `NamespaceSummary.xml` :

    <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>

#### Requirements

Namespace: NAnt.DotNet.Tasks

Assembly: NAnt.DotNetTasks (in NAnt.DotNetTasks.dll)

#### See Also

NDocTask Members | NAnt.DotNet.Tasks Namespace