diff --git a/docs/manual/OptionalTasks/dotnet.html b/docs/manual/OptionalTasks/dotnet.html index 6fc99fc87..2122d2eb6 100644 --- a/docs/manual/OptionalTasks/dotnet.html +++ b/docs/manual/OptionalTasks/dotnet.html @@ -221,6 +221,200 @@ Example />
+All parameters are optional: <vbc/> should suffice to produce a debug +build of all *.vb files. References to external files do require explicit +enumeration, so are one of the first attributes to consider adding.
+ ++ +The task is a directory based task, so attributes like +includes="**/*.vb" and +excludes="broken.vb" can be used to control +the files pulled in. By default, +all *.vb files from the project folder down are included in the command. +When this happens the destFile -if not specified- +is taken as the first file in the list, which may be somewhat hard to control. +Specifying the output file with 'destfile' seems prudent.
++Also, dependency checking only works if destfile is set. + +
Attribute | +Description | +Example Values | +
additionalModules | +Semicolon separated list of modules to refer to | +|
defaultexcludes | +indicates whether default excludes should be used or not + | +"true"(default) or "false" | +
definitions | +defined constants | +"RELEASE;BETA1" | +
debug | +include debug information | +"true"(default) | +
destFile | +name of exe/library to create | +"example.exe" | +
excludes | +comma- or space-separated list of patterns of files that must be + excluded. No files (except default excludes) are excluded when omitted. | +|
excludesfile | +the name of a file. Each line of this file is + taken to be an exclude pattern | +|
extraOptions | +Any extra options which aren't explicitly + supported by the VisualBasicCompile task | +"/warnaserror+ /baseaddress:0x12840000" | +
failOnError | +Should a failed compile halt the build? | +"true"(default) or "false" | +
imports | +comma-separated list of global imports for namespaces + in referenced metadata files. | +|
includes | +comma- or space-separated list of patterns of files that must be + included. All files are included when omitted. | +|
includesfile | +the name of a file. Each line of this file is + taken to be an include pattern | +|
mainClass | +name of main class for executables | +"com.example.project.entrypoint" | +
optimize | +optimisation flag | +"true" or "false"(default) | +
optionCompare | +Text or binary string comparisons. | +"text" or "binary"(default) | +
optionExplicit | +Require explicit declaration of variables? | +"true" or "false"(default) | +
optionStrict | +Enforce strict language semantics? | +"true" or "false"(default) | +
references | +Semicolon separated list of dlls to refer to | +"mylib.dll;nunit.dll" | +
referenceFiles | +Ant Path descriptioon of references to include. + Wildcards should work. | ++ |
removeIntChecks | +Remove integer checks? | +"true" or "false"(default) | +
rootNamespace | +Root namespace for all type declarations. | +com.example | +
srcDir | +source directory (default = project directory) | +"." | +
targetType | +Type of target | +"exe", "module", "winexe" or "library" | +
utf8output | +require all compiler output to be in utf-8 format | +"true" or "false"(default) | +
warnLevel | +level of warning currently between 1 and 4 with 4 + being the strictest. | +"1"-"4" | +
win32Icon | +filename of icon to include | +"res/myicon.ico" | +
win32res | +filename of a win32 resource (.RES)file to include + This is not a .NET resource, but it what windows is used to. | +"res/myapp.res" | +
+Example +
+<vbc + optimize="true" + debug="false" + warnLevel="4" + targetType="exe" + definitions="RELEASE" + excludes="src/unicode_class.vb" + mainClass = "MainApp" + destFile="NetApp.exe" + optionExplicit="true" + optionCompare="text" + /> ++
Task to assemble .net 'Intermediate Language' files. The task will only work on windows until other platforms support csc.exe or