NCoverExplorer.NAntTasks
![]() ![]() ![]() |
v1.3.6.15 |
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.
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 |
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 |
Represents an element of which the XML is processed by its parent task or type.
Represents a command-line argument.
Attribute | Type | Description | Required |
---|---|---|---|
dir | directory | The value for a directory-based command-line argument; will be replaced with the absolute path of the directory. | False |
file | file | The name of a file as a single command-line argument; will be replaced with the absolute filename of the file. | False |
if | bool | 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 |
line | string | 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 |
unless | bool | 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 |
value | string | A single command-line argument; can contain space characters. | False |
A single command-line argument containing a space character.
<arg value="-l -a" />
Two separate command-line arguments.
<arg line="-l -a" />
A single command-line argument with the value \dir;\dir2;\dir3
on DOS-based systems and /dir:/dir2:/dir3
on Unix-like systems.
<arg path="/dir;/dir2:\dir3" />
Document two assemblies using the MSDN-CHM documenter. The namespaces are documented in NamespaceSummary.xml
. This is assuming that the NDocConsole.exe is in your path. If not, use the "program" attribute on the ndoc2 node to specify the path to NDocConsole.exe.
<ndoc2> <assemblies basedir="${build.dir}"> <include name="MyApp.exe" /> <include name="MyApp.dll" /> </assemblies> <summaries basedir="${build.dir}"> <include name="NamespaceSummary.xml" /> </summaries> <documenters> <documenter name="MSDN-CHM"> <property name="IncludeFavorites" value="False" /> <property name="OutputDirectory" value="doc\MSDN" /> <property name="HtmlHelpName" value="MyApp" /> <property name="Title" value="MyApp Class Library" /> <property name="Version" value="" /> <property name="UseAssemblyShadowCache" value="False" /> <property name="DocumentExplicitInterfaceImplementations" value="True" /> <property name="AssemblyVersionInfo" value="AssemblyFileVersion" /> <property name="CopyrightText" value="© 2007 Kiwi Development" /> </documenter> </documenters> </ndoc2>
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>