<ndoc2>

Runs NDoc2 Alpha to create documentation for .NET 2.0 assemblies. Unlike the original <ndoc> task, this one simply runs the NDoc.Console.exe with the configuration file created.

The easiest way to create the correct contents for this task is to use the NDocGui and save the resulting configuration file. Then just paste in the <documenter> and other sections you want into your NAnt script as is. See the NDoc2 Alpha page for more information about NDoc Alpha.

Parameters

Attribute Type Description Required
program string The name of the executable that should be used to launch the external program. False
failonerror bool Determines if task failure stops the build, or is just reported. The default is true. False
if bool If true then the task will be executed; otherwise, skipped. The default is true. False
timeout int The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out. False
unless bool Opposite of if. If false then the task will be executed; otherwise, skipped. The default is false. False
verbose bool Determines whether the task should report detailed build log messages. The default is false. False

Framework-configurable parameters

Attribute Type Description Required
useruntimeengine bool Specifies whether the external program should be executed using a runtime engine, if configured. The default is false. False

Nested Elements:

<assemblies>

The set of assemblies to document.

</assemblies>

<summaries>

The set of namespace summary files.

</summaries>

<documenters>

Specifies the formats in which the documentation should be generated.

Represents an element of which the XML is processed by its parent task or type.

</documenters>

<referencepaths>

Collection of additional directories to search for referenced assemblies.

</referencepaths>

<arg>

The command-line arguments for the external program.

Represents a command-line argument.

Parameters

AttributeTypeDescriptionRequired
dirdirectory The value for a directory-based command-line argument; will be replaced with the absolute path of the directory. False
filefile The name of a file as a single command-line argument; will be replaced with the absolute filename of the file. False
ifbool Indicates if the argument should be passed to the external program. If true then the argument will be passed; otherwise, skipped. The default is true. False
linestring List of command-line arguments; will be passed to the executable as is. False
path<path> The value for a PATH-like command-line argument; you can use : or ; as path separators and NAnt will convert it to the platform's local conventions, while resolving references to environment variables. False
unlessbool Indicates if the argument should not be passed to the external program. If false then the argument will be passed; otherwise, skipped. The default is false. False
valuestring A single command-line argument; can contain space characters. False

Nested Elements:

<path>

Sets a single command-line argument and treats it like a PATH - ensures the right separator for the local platform is used.

</path>

Examples

</arg>

Examples

Requirements

Assembly: NCoverExplorer.NAntTasks (1.3.6.15)