PageRenderTime 81ms CodeModel.GetById 16ms RepoModel.GetById 0ms app.codeStats 1ms

/tools/nant/NAnt.DotNetTasks.xml

http://github.com/philiplaureano/LinFu
XML | 5334 lines | 5329 code | 4 blank | 1 comment | 0 complexity | dfb78d57640bd326361f35e90fd04bcd MD5 | raw file
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>NAnt.DotNetTasks</name>
  5. </assembly>
  6. <members>
  7. <member name="T:NAnt.DotNet.Tasks.AssemblyInfoTask">
  8. <summary>
  9. Generates an AssemblyInfo file using the attributes given.
  10. </summary>
  11. <example>
  12. <para>
  13. Create a C# AssemblyInfo file containing the specified assembly-level
  14. attributes.
  15. </para>
  16. <code>
  17. <![CDATA[
  18. <asminfo output="AssemblyInfo.cs" language="CSharp">
  19. <imports>
  20. <import namespace="System" />
  21. <import namespace="System.Reflection" />
  22. <import namespace="System.EnterpriseServices" />
  23. <import namespace="System.Runtime.InteropServices" />
  24. </imports>
  25. <attributes>
  26. <attribute type="ComVisibleAttribute" value="false" />
  27. <attribute type="CLSCompliantAttribute" value="true" />
  28. <attribute type="AssemblyVersionAttribute" value="1.0.0.0" />
  29. <attribute type="AssemblyTitleAttribute" value="My fun assembly" />
  30. <attribute type="AssemblyDescriptionAttribute" value="More fun than a barrel of monkeys" />
  31. <attribute type="AssemblyCopyrightAttribute" value="Copyright (c) 2002, Monkeyboy, Inc." />
  32. <attribute type="ApplicationNameAttribute" value="FunAssembly" />
  33. </attributes>
  34. <references>
  35. <include name="System.EnterpriseServices.dll" />
  36. </references>
  37. </asminfo>
  38. ]]>
  39. </code>
  40. </example>
  41. <example>
  42. <para>
  43. Create a C# AssemblyInfo file containing an attribute with multiple
  44. named properties by setting the <see cref="P:NAnt.DotNet.Types.AssemblyAttribute.AsIs"/>
  45. attribute on the <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> element to
  46. <see langword="true"/>.
  47. </para>
  48. <code>
  49. <![CDATA[
  50. <asminfo output="AssemblyInfo.cs" language="CSharp">
  51. <imports>
  52. <import namespace="log4net.Config" />
  53. </imports>
  54. <attributes>
  55. <attribute type="DOMConfiguratorAttribute" value="ConfigFile=&quot;config.log4net&quot;,Watch=true" asis="true" />
  56. </attributes>
  57. <references>
  58. <include name="log4net.dll" />
  59. </references>
  60. </asminfo>
  61. ]]>
  62. </code>
  63. </example>
  64. </member>
  65. <member name="M:NAnt.DotNet.Tasks.AssemblyInfoTask.ExecuteTask">
  66. <summary>
  67. Generates an AssemblyInfo file.
  68. </summary>
  69. </member>
  70. <member name="M:NAnt.DotNet.Tasks.AssemblyInfoTask.NeedsPersisting(System.IO.Stream)">
  71. <summary>
  72. Determines whether the specified AssemblyInfo file in the given
  73. <see cref="T:System.IO.Stream"/> needs to be persisted.
  74. </summary>
  75. <param name="generatedAsmInfoStream"><see cref="T:System.IO.Stream"/> holding the newly generated AssemblyInfo source.</param>
  76. <returns>
  77. <see langword="true"/> if the generated AssemblyInfo source needs
  78. to be persisted; otherwise, <see langword="false"/>.
  79. </returns>
  80. </member>
  81. <member name="P:NAnt.DotNet.Tasks.AssemblyInfoTask.Output">
  82. <summary>
  83. Name of the AssemblyInfo file to generate.
  84. </summary>
  85. <value>
  86. The name of the AssemblyInfo file to generate.
  87. </value>
  88. </member>
  89. <member name="P:NAnt.DotNet.Tasks.AssemblyInfoTask.Language">
  90. <summary>
  91. The code language in which the AssemblyInfo file should be
  92. generated.
  93. </summary>
  94. </member>
  95. <member name="P:NAnt.DotNet.Tasks.AssemblyInfoTask.AssemblyAttributes">
  96. <summary>
  97. The assembly-level attributes to generate.
  98. </summary>
  99. <value>
  100. The assembly-level attributes to generate.
  101. </value>
  102. </member>
  103. <member name="P:NAnt.DotNet.Tasks.AssemblyInfoTask.Imports">
  104. <summary>
  105. The namespaces to import.
  106. </summary>
  107. <value>
  108. The namespaces to import.
  109. </value>
  110. </member>
  111. <member name="P:NAnt.DotNet.Tasks.AssemblyInfoTask.References">
  112. <summary>
  113. Assembly files used to locate the types of the specified attributes.
  114. </summary>
  115. </member>
  116. <member name="T:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeLanguage">
  117. <summary>
  118. Defines the supported code languages for generating an AssemblyInfo
  119. file.
  120. </summary>
  121. </member>
  122. <member name="F:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeLanguage.CSharp">
  123. <summary>
  124. A value for generating C# code.
  125. </summary>
  126. </member>
  127. <member name="F:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeLanguage.JScript">
  128. <summary>
  129. A value for generating JScript code.
  130. </summary>
  131. </member>
  132. <member name="F:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeLanguage.VB">
  133. <summary>
  134. A value for generating Visual Basic code.
  135. </summary>
  136. </member>
  137. <member name="T:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeProvider">
  138. <summary>
  139. Encapsulates functionality to generate a code file with imports
  140. and assembly-level attributes.
  141. </summary>
  142. </member>
  143. <member name="M:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeProvider.#ctor(NAnt.DotNet.Tasks.AssemblyInfoTask,NAnt.DotNet.Tasks.AssemblyInfoTask.CodeLanguage)">
  144. <summary>
  145. Initializes a new instance of the <see cref="T:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeProvider"/>
  146. for the specified <see cref="T:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeLanguage"/>.
  147. </summary>
  148. <param name="assemblyInfoTask">The <see cref="T:NAnt.DotNet.Tasks.AssemblyInfoTask"/> for which an instance of the <see cref="T:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeProvider"/> class should be initialized.</param>
  149. <param name="codeLanguage">The <see cref="T:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeLanguage"/> for which an instance of the <see cref="T:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeProvider"/> class should be initialized.</param>
  150. </member>
  151. <member name="M:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeProvider.GenerateImportCode(System.Collections.Specialized.StringCollection,System.IO.TextWriter)">
  152. <summary>
  153. Generates code for the specified imports.
  154. </summary>
  155. <param name="imports">The imports for which code should be generated.</param>
  156. <param name="writer">The <see cref="T:System.IO.TextWriter"/> to which the generated code will be written.</param>
  157. </member>
  158. <member name="M:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeProvider.GenerateAssemblyAttributesCode(NAnt.DotNet.Types.AssemblyAttributeCollection,System.Collections.Specialized.StringCollection,System.Collections.Specialized.StringCollection,System.IO.TextWriter)">
  159. <summary>
  160. Generates code for the specified assembly attributes.
  161. </summary>
  162. <param name="assemblyAttributes">The assembly attributes for which code should be generated.</param>
  163. <param name="imports">Imports used to resolve the assembly attribute names to fully qualified type names.</param>
  164. <param name="assemblies">Assembly that will be used to resolve the attribute names to <see cref="T:System.Type"/> instances.</param>
  165. <param name="writer">The <see cref="T:System.IO.TextWriter"/> to which the generated code will be written.</param>
  166. </member>
  167. <member name="P:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeProvider.Language">
  168. <summary>
  169. Gets the <see cref="T:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeLanguage"/> in which the AssemblyInfo
  170. code will be generated.
  171. </summary>
  172. </member>
  173. <member name="P:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeProvider.Generator">
  174. <summary>
  175. Gets the <see cref="T:System.CodeDom.Compiler.ICodeGenerator"/> that will be used to
  176. generate the AssemblyInfo code.
  177. </summary>
  178. </member>
  179. <member name="T:NAnt.DotNet.Tasks.AssemblyInfoTask.TypedValueGatherer">
  180. <summary>
  181. Responsible for returning the specified value converted to a
  182. <see cref="T:System.Type"/> accepted by a constructor for a given
  183. <see cref="T:System.Type"/>.
  184. </summary>
  185. </member>
  186. <member name="M:NAnt.DotNet.Tasks.AssemblyInfoTask.TypedValueGatherer.InitializeLifetimeService">
  187. <summary>
  188. Obtains a lifetime service object to control the lifetime policy for
  189. this instance.
  190. </summary>
  191. <returns>
  192. An object of type <see cref="T:System.Runtime.Remoting.Lifetime.ILease"/> used to control the lifetime
  193. policy for this instance. This is the current lifetime service object
  194. for this instance if one exists; otherwise, a new lifetime service
  195. object initialized with a lease that will never time out.
  196. </returns>
  197. </member>
  198. <member name="M:NAnt.DotNet.Tasks.AssemblyInfoTask.TypedValueGatherer.GetTypedValue(System.Collections.Specialized.StringCollection,System.Collections.Specialized.StringCollection,System.String,System.String)">
  199. <summary>
  200. Retrieves the specified <see cref="T:System.Type"/> corresponding with the specified
  201. type name from a list of assemblies.
  202. </summary>
  203. <param name="assemblies">The collection of assemblies that the type should tried to be instantiated from.</param>
  204. <param name="imports">The list of imports that can be used to resolve the typename to a full typename.</param>
  205. <param name="typename">The typename that should be used to determine the type to which the specified value should be converted.</param>
  206. <param name="value">The <see cref="T:System.String"/> value that should be converted to a typed value.</param>
  207. <returns></returns>
  208. <exception cref="T:NAnt.Core.BuildException">
  209. <para><paramref name="value"/> is <see langword="null"/> and the <see cref="T:System.Type"/> identified by <paramref name="typename"/> has no default public constructor.</para>
  210. <para>-or-</para>
  211. <para><paramref name="value"/> cannot be converted to a value that's suitable for one of the constructors of the <see cref="T:System.Type"/> identified by <paramref name="typename"/>.</para>
  212. <para>-or-</para>
  213. <para>The <see cref="T:System.Type"/> identified by <paramref name="typename"/> has no suitable constructor.</para>
  214. <para>-or-</para>
  215. <para>A <see cref="T:System.Type"/> identified by <paramref name="typename"/> could not be located or loaded.</para>
  216. </exception>
  217. </member>
  218. <member name="T:NAnt.DotNet.Tasks.AssemblyLinkerTask">
  219. <summary>
  220. Wraps <c>al.exe</c>, the assembly linker for the .NET Framework.
  221. </summary>
  222. <remarks>
  223. <para>
  224. All specified sources will be embedded using the <c>/embed</c> flag.
  225. Other source types are not supported.
  226. </para>
  227. </remarks>
  228. <example>
  229. <para>
  230. Create a library containing all icon files in the current directory.
  231. </para>
  232. <code>
  233. <![CDATA[
  234. <al output="MyIcons.dll" target="lib">
  235. <sources>
  236. <include name="*.ico" />
  237. </sources>
  238. </al>
  239. ]]>
  240. </code>
  241. </example>
  242. <example>
  243. <para>
  244. Create an executable assembly manifest from modules.
  245. </para>
  246. <code>
  247. <![CDATA[
  248. <al output="Client.exe" target="exe" main="Program.Main">
  249. <modules>
  250. <include name="Client.netmodule" />
  251. <include name="Common.netmodule" />
  252. </modules>
  253. </al>
  254. ]]>
  255. </code>
  256. </example>
  257. </member>
  258. <member name="M:NAnt.DotNet.Tasks.AssemblyLinkerTask.ExecuteTask">
  259. <summary>
  260. Generates an assembly manifest.
  261. </summary>
  262. </member>
  263. <member name="M:NAnt.DotNet.Tasks.AssemblyLinkerTask.NeedsCompiling">
  264. <summary>
  265. Determines whether the assembly manifest needs compiling or is
  266. uptodate.
  267. </summary>
  268. <returns>
  269. <see langword="true" /> if the assembly manifest needs compiling;
  270. otherwise, <see langword="false" />.
  271. </returns>
  272. </member>
  273. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.AlgorithmID">
  274. <summary>
  275. Specifies an algorithm (in hexadecimal) to hash all files in a
  276. multifile assembly except the file that contains the assembly
  277. manifest. The default algorithm is CALG_SHA1.
  278. </summary>
  279. </member>
  280. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Company">
  281. <summary>
  282. Specifies a string for the <b>Company</b> field in the assembly.
  283. </summary>
  284. <value>
  285. A string for the <b>Company</b> field in the assembly.
  286. </value>
  287. <remarks>
  288. If <see cref="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Company"/> is an empty string (""), the Win32
  289. <b>Company</b> resource appears as a single space.
  290. </remarks>
  291. </member>
  292. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Configuration">
  293. <summary>
  294. Specifies a string for the <b>Configuration</b> field in the assembly.
  295. </summary>
  296. <value>
  297. A string for the <b>Configuration</b> field in the assembly.
  298. </value>
  299. <remarks>
  300. If <see cref="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Configuration"/> is an empty string (""), the Win32
  301. <b>Configuration</b> resource appears as a single space.
  302. </remarks>
  303. </member>
  304. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Copyright">
  305. <summary>
  306. Specifies a string for the <b>Copyright</b> field in the assembly.
  307. </summary>
  308. <value>
  309. A string for the <b>Copyright</b> field in the assembly.
  310. </value>
  311. <remarks>
  312. If <see cref="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Copyright"/> is an empty string (""), the Win32
  313. <b>Copyright</b> resource appears as a single space.
  314. </remarks>
  315. </member>
  316. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Culture">
  317. <summary>
  318. The culture string associated with the output assembly.
  319. The string must be in RFC 1766 format, such as "en-US".
  320. </summary>
  321. <remarks>
  322. <para>
  323. Corresponds with the <c>/c[ulture]:</c> flag.
  324. </para>
  325. </remarks>
  326. </member>
  327. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.DelaySign">
  328. <summary>
  329. Specifies whether the assembly should be partially signed. The default
  330. is <see langword="NAnt.DotNet.Types.DelaySign.NotSet" />.
  331. </summary>
  332. </member>
  333. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Description">
  334. <summary>
  335. Specifies a string for the <b>Description</b> field in the assembly.
  336. </summary>
  337. <value>
  338. A string for the <b>Description</b> field in the assembly.
  339. </value>
  340. <remarks>
  341. If <see cref="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Description"/> is an empty string (""), the Win32
  342. <b>Description</b> resource appears as a single space.
  343. </remarks>
  344. </member>
  345. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.EvidenceFile">
  346. <summary>
  347. Security evidence file to embed.
  348. </summary>
  349. <value>
  350. The security evidence file to embed.
  351. </value>
  352. <remarks>
  353. <para>
  354. Corresponds with the <c>/e[vidence]</c> flag.
  355. </para>
  356. </remarks>
  357. </member>
  358. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.FileVersion">
  359. <summary>
  360. Specifies a string for the <b>File Version</b> field in the assembly.
  361. </summary>
  362. <value>
  363. A string for the <b>File Version</b> field in the assembly.
  364. </value>
  365. </member>
  366. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Flags">
  367. <summary>
  368. Specifies a value (in hexadecimal) for the <b>Flags</b> field in
  369. the assembly.
  370. </summary>
  371. <value>
  372. A value (in hexadecimal) for the <b>Flags</b> field in the assembly.
  373. </value>
  374. </member>
  375. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.KeyContainer">
  376. <summary>
  377. Specifies a container that holds a key pair.
  378. </summary>
  379. </member>
  380. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.KeyFile">
  381. <summary>
  382. Specifies a file (filename) that contains a key pair or
  383. just a public key to sign an assembly.
  384. </summary>
  385. <value>
  386. The complete path to the key file.
  387. </value>
  388. <remarks>
  389. <para>
  390. Corresponds with the <c>/keyf[ile]:</c> flag.
  391. </para>
  392. </remarks>
  393. </member>
  394. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.MainMethod">
  395. <summary>
  396. Specifies the fully-qualified name (class.method) of the method to
  397. use as an entry point when converting a module to an executable file.
  398. </summary>
  399. <value>
  400. The fully-qualified name (class.method) of the method to use as an
  401. entry point when converting a module to an executable file.
  402. </value>
  403. </member>
  404. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.ModuleSet">
  405. <summary>
  406. One or more modules to be compiled into an assembly.
  407. </summary>
  408. </member>
  409. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.OutputFile">
  410. <summary>
  411. The name of the output file for the assembly manifest.
  412. </summary>
  413. <value>
  414. The complete output path for the assembly manifest.
  415. </value>
  416. <remarks>
  417. <para>
  418. Corresponds with the <c>/out</c> flag.
  419. </para>
  420. </remarks>
  421. </member>
  422. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.OutputTarget">
  423. <summary>
  424. The target type (one of <c>lib</c>, <c>exe</c>, or <c>winexe</c>).
  425. </summary>
  426. <remarks>
  427. <para>
  428. Corresponds with the <c>/t[arget]:</c> flag.
  429. </para>
  430. </remarks>
  431. </member>
  432. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Product">
  433. <summary>
  434. Specifies a string for the <b>Product</b> field in the assembly.
  435. </summary>
  436. <value>
  437. A string for the <b>Product</b> field in the assembly.
  438. </value>
  439. </member>
  440. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.ProductVersion">
  441. <summary>
  442. Specifies a string for the <b>Product Version</b> field in the assembly.
  443. </summary>
  444. <value>
  445. A string for the <b>Product Version</b> field in the assembly.
  446. </value>
  447. </member>
  448. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Resources">
  449. <summary>
  450. The set of resources to embed.
  451. </summary>
  452. </member>
  453. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.EmbeddedResources">
  454. <summary>
  455. The set of compiled resources to embed.
  456. </summary>
  457. <remarks>
  458. Do not yet expose this to build authors.
  459. </remarks>
  460. </member>
  461. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.SupportsTemplate">
  462. <summary>
  463. Indicates whether the assembly linker for a given target framework
  464. supports the "template" option, which takes an assembly from which
  465. to get all options except the culture field.
  466. The default is <see langword="true" />.
  467. </summary>
  468. <remarks>
  469. TODO: remove this once Mono bug #74814 is fixed.
  470. </remarks>
  471. </member>
  472. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.TemplateFile">
  473. <summary>
  474. Specifies an assembly from which to get all options except the
  475. culture field.
  476. </summary>
  477. <value>
  478. The complete path to the assembly template.
  479. </value>
  480. <remarks>
  481. <para>
  482. Corresponds with the <c>/template:</c> flag.
  483. </para>
  484. </remarks>
  485. </member>
  486. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Title">
  487. <summary>
  488. Specifies a string for the <b>Title</b> field in the assembly.
  489. </summary>
  490. <value>
  491. A string for the <b>Title</b> field in the assembly.
  492. </value>
  493. </member>
  494. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Trademark">
  495. <summary>
  496. Specifies a string for the <b>Trademark</b> field in the assembly.
  497. </summary>
  498. <value>
  499. A string for the <b>Trademark</b> field in the assembly.
  500. </value>
  501. </member>
  502. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Version">
  503. <summary>
  504. Specifies version information for the assembly. The format of the
  505. version string is <c>major</c>.<c>minor</c>.<c>build</c>.<c>revision</c>.
  506. </summary>
  507. </member>
  508. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Win32Icon">
  509. <summary>
  510. Icon to associate with the assembly.
  511. </summary>
  512. </member>
  513. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Win32Res">
  514. <summary>
  515. Inserts a Win32 resource (.res file) in the output file.
  516. </summary>
  517. </member>
  518. <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.ProgramArguments">
  519. <summary>
  520. Gets the command-line arguments for the external program.
  521. </summary>
  522. <value>
  523. The command-line arguments for the external program or
  524. <see langword="null" /> if the task is not being executed.
  525. </value>
  526. </member>
  527. <member name="T:NAnt.DotNet.Tasks.CompilerBase">
  528. <summary>
  529. Provides the abstract base class for compiler tasks.
  530. </summary>
  531. </member>
  532. <member name="F:NAnt.DotNet.Tasks.CompilerBase.CodebehindExtensions">
  533. <summary>
  534. Contains a list of extensions for all file types that should be treated as
  535. 'code-behind' when looking for resources. Ultimately this will determine
  536. if we use the "namespace+filename" or "namespace+classname" algorithm, since
  537. code-behind will use the "namespace+classname" algorithm.
  538. </summary>
  539. </member>
  540. <member name="F:NAnt.DotNet.Tasks.CompilerBase.CultureNames">
  541. <summary>
  542. Case-insensitive list of valid culture names for this platform.
  543. </summary>
  544. <remarks>
  545. The key of the <see cref="T:System.Collections.Hashtable"/> is the culture name and
  546. the value is <see langword="null"/>.
  547. </remarks>
  548. </member>
  549. <member name="M:NAnt.DotNet.Tasks.CompilerBase.#cctor">
  550. <summary>
  551. Class constructor for <see cref="T:NAnt.DotNet.Tasks.CompilerBase"/>.
  552. </summary>
  553. </member>
  554. <member name="M:NAnt.DotNet.Tasks.CompilerBase.ExecuteTask">
  555. <summary>
  556. Compiles the sources and resources.
  557. </summary>
  558. </member>
  559. <member name="M:NAnt.DotNet.Tasks.CompilerBase.GetManifestResourceName(NAnt.DotNet.Types.ResourceFileSet,System.String,System.String,System.String)">
  560. <summary>
  561. Determines the manifest resource name of the given resource file.
  562. </summary>
  563. <param name="resources">The <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> containing information that will used to assemble the manifest resource name.</param>
  564. <param name="resourcePhysicalFile">The resource file of which the manifest resource name should be determined.</param>
  565. <param name="resourceLogicalFile">The logical location of the resource file.</param>
  566. <param name="dependentFile">The source file on which the resource file depends.</param>
  567. <returns>
  568. The manifest resource name of the specified resource file.
  569. </returns>
  570. </member>
  571. <member name="M:NAnt.DotNet.Tasks.CompilerBase.GetManifestResourceName(NAnt.DotNet.Types.ResourceFileSet,System.String)">
  572. <summary>
  573. Determines the manifest resource name of the given resource file.
  574. </summary>
  575. <param name="resources">The <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> containing information that will used to assemble the manifest resource name.</param>
  576. <param name="resourceFile">The resource file of which the manifest resource name should be determined.</param>
  577. <returns>
  578. The manifest resource name of the specified resource file.
  579. </returns>
  580. <remarks>
  581. For .resx resources, the name of the dependent is determined by
  582. replacing the extension of the file with the extension of the
  583. source files for the compiler, and removing the culture name from
  584. the file name for localized resources.
  585. </remarks>
  586. </member>
  587. <member name="M:NAnt.DotNet.Tasks.CompilerBase.PerformSearchForResourceLinkage(System.IO.TextReader)">
  588. <summary>
  589. Extracts the associated namespace/classname linkage found in the
  590. given stream.
  591. </summary>
  592. <param name="sr">The read-only stream of the source file to search.</param>
  593. <returns>
  594. The namespace/classname of the source file matching the resource.
  595. </returns>
  596. </member>
  597. <member name="M:NAnt.DotNet.Tasks.CompilerBase.WritePackageReferences(System.IO.TextWriter)">
  598. <summary>
  599. Writes package references to the specified <see cref="T:System.IO.TextWriter"/>.
  600. </summary>
  601. <param name="writer">The <see cref="T:System.IO.TextWriter"/> to which the package references should be written.</param>
  602. </member>
  603. <member name="M:NAnt.DotNet.Tasks.CompilerBase.WriteWarningsAsError(System.IO.TextWriter)">
  604. <summary>
  605. Writes list of warnings to (not) treat as errors to the specified
  606. <see cref="T:System.IO.TextWriter"/>.
  607. </summary>
  608. <param name="writer">The <see cref="T:System.IO.TextWriter"/> to which the list of warnings should be written.</param>
  609. </member>
  610. <member name="M:NAnt.DotNet.Tasks.CompilerBase.WriteNoWarnList(System.IO.TextWriter)">
  611. <summary>
  612. Writes list of warnings to suppress to the specified
  613. <see cref="T:System.IO.TextWriter"/>.
  614. </summary>
  615. <param name="writer">The <see cref="T:System.IO.TextWriter"/> to which the list of warnings to suppress should be written.</param>
  616. </member>
  617. <member name="M:NAnt.DotNet.Tasks.CompilerBase.WriteConditionalCompilationConstants(System.IO.TextWriter)">
  618. <summary>
  619. Writes conditional compilation constants to the specified
  620. <see cref="T:System.IO.TextWriter"/>.
  621. </summary>
  622. <param name="writer">The <see cref="T:System.IO.TextWriter"/> to which the conditional compilation constants should be written.</param>
  623. </member>
  624. <member name="M:NAnt.DotNet.Tasks.CompilerBase.WriteModuleReferences(System.IO.TextWriter)">
  625. <summary>
  626. Writes module references to the specified <see cref="T:System.IO.TextWriter"/>.
  627. </summary>
  628. <param name="writer">The <see cref="T:System.IO.TextWriter"/> to which the module references should be written.</param>
  629. </member>
  630. <member name="M:NAnt.DotNet.Tasks.CompilerBase.WriteOptions(System.IO.TextWriter)">
  631. <summary>
  632. Allows derived classes to provide compiler-specific options.
  633. </summary>
  634. <param name="writer">The <see cref="T:System.IO.TextWriter"/> to which the compiler options should be written.</param>
  635. </member>
  636. <member name="M:NAnt.DotNet.Tasks.CompilerBase.WriteOption(System.IO.TextWriter,System.String)">
  637. <summary>
  638. Writes an option using the default output format.
  639. </summary>
  640. <param name="writer">The <see cref="T:System.IO.TextWriter"/> to which the compiler options should be written.</param>
  641. <param name="name">The name of the option which should be passed to the compiler.</param>
  642. </member>
  643. <member name="M:NAnt.DotNet.Tasks.CompilerBase.WriteOption(System.IO.TextWriter,System.String,System.String)">
  644. <summary>
  645. Writes an option and its value using the default output format.
  646. </summary>
  647. <param name="writer">The <see cref="T:System.IO.TextWriter"/> to which the compiler options should be written.</param>
  648. <param name="name">The name of the option which should be passed to the compiler.</param>
  649. <param name="value">The value of the option which should be passed to the compiler.</param>
  650. <remarks>
  651. The combination of <paramref name="name"/> and
  652. <paramref name="value"/> (separated by a colon) is quoted
  653. unless <paramref name="value"/> is already surrounded by quotes.
  654. </remarks>
  655. </member>
  656. <member name="M:NAnt.DotNet.Tasks.CompilerBase.NeedsCompiling">
  657. <summary>
  658. Determines whether compilation is needed.
  659. </summary>
  660. </member>
  661. <member name="M:NAnt.DotNet.Tasks.CompilerBase.GetResourceLinkage(System.String,System.Globalization.CultureInfo)">
  662. <summary>
  663. Finds the correct namespace/classname for a resource file from the
  664. given dependent source file.
  665. </summary>
  666. <param name="dependentFile">The file from which the resource linkage of the resource file should be determined.</param>
  667. <param name="resourceCulture">The culture of the resource file for which the resource linkage should be determined.</param>
  668. <returns>
  669. The namespace/classname of the source file matching the resource or
  670. <see langword="null" /> if the dependent source file does not exist.
  671. </returns>
  672. <remarks>
  673. This behaviour may be overidden by each particular compiler to
  674. support the namespace/classname syntax for that language.
  675. </remarks>
  676. </member>
  677. <member name="M:NAnt.DotNet.Tasks.CompilerBase.LinkResourceAssembly(System.Collections.Hashtable,System.IO.FileInfo,System.String)">
  678. <summary>
  679. Link a list of files into a resource assembly.
  680. </summary>
  681. <param name="resourceFiles">The collection of resources.</param>
  682. <param name="resourceAssemblyFile">Resource assembly to generate</param>
  683. <param name="culture">Culture of the generated assembly.</param>
  684. </member>
  685. <member name="M:NAnt.DotNet.Tasks.CompilerBase.CompileResxResources(System.Collections.Specialized.StringCollection)">
  686. <summary>
  687. Compiles a set of resx files to a .resources files.
  688. </summary>
  689. <param name="resxFiles">The set of resx files to compile.</param>
  690. </member>
  691. <member name="M:NAnt.DotNet.Tasks.CompilerBase.GetResourceCulture(System.String,System.String)">
  692. <summary>
  693. Determines the culture associated with a given resource file by
  694. scanning the filename for valid culture names.
  695. </summary>
  696. <param name="resourceFile">The resource file path to check for culture info.</param>
  697. <param name="dependentFile">The file on which the resource file depends.</param>
  698. <returns>
  699. A valid <see cref="T:System.Globalization.CultureInfo"/> instance if the resource is
  700. associated with a specific culture; otherwise, <see langword="null"/>.
  701. </returns>
  702. </member>
  703. <member name="P:NAnt.DotNet.Tasks.CompilerBase.Debug">
  704. <summary>
  705. Generate debug output. The default is <see langword="false" />.
  706. </summary>
  707. <remarks>
  708. Only used for &lt;jsc&gt; tasks, but retained for backward
  709. compatibility (Clover.NET).
  710. </remarks>
  711. </member>
  712. <member name="P:NAnt.DotNet.Tasks.CompilerBase.OutputFile">
  713. <summary>
  714. The output file created by the compiler.
  715. </summary>
  716. </member>
  717. <member name="P:NAnt.DotNet.Tasks.CompilerBase.OutputTarget">
  718. <summary>
  719. Output type. Possible values are <c>exe</c>, <c>winexe</c>,
  720. <c>library</c> or <c>module</c>.
  721. </summary>
  722. </member>
  723. <member name="P:NAnt.DotNet.Tasks.CompilerBase.Define">
  724. <summary>
  725. Define conditional compilation symbol(s).
  726. </summary>
  727. <remarks>
  728. <para>
  729. Corresponds to <c>/d[efine]:</c> flag.
  730. </para>
  731. </remarks>
  732. </member>
  733. <member name="P:NAnt.DotNet.Tasks.CompilerBase.Win32Icon">
  734. <summary>
  735. Icon to associate with the application.
  736. </summary>
  737. <remarks>
  738. <para>
  739. Corresponds to <c>/win32icon:</c> flag.
  740. </para>
  741. </remarks>
  742. </member>
  743. <member name="P:NAnt.DotNet.Tasks.CompilerBase.Win32Res">
  744. <summary>
  745. Specifies a Win32 resource file (.res).
  746. </summary>
  747. <remarks>
  748. <para>
  749. Corresponds to <c>/win32res[ource]:</c> flag.
  750. </para>
  751. </remarks>
  752. </member>
  753. <member name="P:NAnt.DotNet.Tasks.CompilerBase.WarnAsError">
  754. <summary>
  755. Instructs the compiler to treat all warnings as errors. The default
  756. is <see langword="false" />.
  757. </summary>
  758. <remarks>
  759. <para>
  760. Corresponds to the <c>/warnaserror[+|-]</c> flag of the compiler.
  761. </para>
  762. <para>
  763. When this property is set to <see langword="true" />, any messages
  764. that would ordinarily be reported as warnings will instead be
  765. reported as errors.
  766. </para>
  767. </remarks>
  768. </member>
  769. <member name="P:NAnt.DotNet.Tasks.CompilerBase.WarningAsError">
  770. <summary>
  771. Controls which warnings should be reported as errors.
  772. </summary>
  773. </member>
  774. <member name="P:NAnt.DotNet.Tasks.CompilerBase.NoWarn">
  775. <summary>
  776. Specifies a comma-separated list of warnings that should be suppressed
  777. by the compiler.
  778. </summary>
  779. <value>
  780. Comma-separated list of warnings that should be suppressed by the
  781. compiler.
  782. </value>
  783. <remarks>
  784. <para>
  785. Corresponds with the <c>/nowarn</c> flag.
  786. </para>
  787. </remarks>
  788. </member>
  789. <member name="P:NAnt.DotNet.Tasks.CompilerBase.SuppressWarnings">
  790. <summary>
  791. Specifies a list of warnings that you want the compiler to suppress.
  792. </summary>
  793. </member>
  794. <member name="P:NAnt.DotNet.Tasks.CompilerBase.ForceRebuild">
  795. <summary>
  796. Instructs NAnt to recompile the output file regardless of the file timestamps.
  797. </summary>
  798. <remarks>
  799. When this parameter is to <see langword="true" />, NAnt will always
  800. run the compiler to rebuild the output file, regardless of the file timestamps.
  801. </remarks>
  802. </member>
  803. <member name="P:NAnt.DotNet.Tasks.CompilerBase.MainType">
  804. <summary>
  805. Specifies which type contains the Main method that you want to use
  806. as the entry point into the program.
  807. </summary>
  808. <remarks>
  809. <para>
  810. Corresponds to the <c>/m[ain]:</c> flag of the compiler.
  811. </para>
  812. <para>
  813. Use this property when creating an executable file. If this property
  814. is not set, the compiler searches for a valid Main method in all
  815. public classes.
  816. </para>
  817. </remarks>
  818. </member>
  819. <member name="P:NAnt.DotNet.Tasks.CompilerBase.KeyContainer">
  820. <summary>
  821. Specifies the key pair container used to strongname the assembly.
  822. </summary>
  823. </member>
  824. <member name="P:NAnt.DotNet.Tasks.CompilerBase.KeyFile">
  825. <summary>
  826. Specifies a strong name key file.
  827. </summary>
  828. </member>
  829. <member name="P:NAnt.DotNet.Tasks.CompilerBase.DelaySign">
  830. <summary>
  831. Specifies whether to delay sign the assembly using only the public
  832. portion of the strong name key. The default is
  833. <see cref="F:NAnt.DotNet.Types.DelaySign.NotSet"/>.
  834. </summary>
  835. </member>
  836. <member name="P:NAnt.DotNet.Tasks.CompilerBase.Lib">
  837. <summary>
  838. Additional directories to search in for assembly references.
  839. </summary>
  840. <remarks>
  841. <para>
  842. Corresponds with the <c>/lib[path]:</c> flag.
  843. </para>
  844. </remarks>
  845. </member>
  846. <member name="P:NAnt.DotNet.Tasks.CompilerBase.References">
  847. <summary>
  848. Reference metadata from the specified assembly files.
  849. </summary>
  850. </member>
  851. <member name="P:NAnt.DotNet.Tasks.CompilerBase.Packages">
  852. <summary>
  853. Specifies list of packages to reference.
  854. </summary>
  855. </member>
  856. <member name="P:NAnt.DotNet.Tasks.CompilerBase.ResourcesList">
  857. <summary>
  858. Resources to embed.
  859. </summary>
  860. <remarks>
  861. <para>
  862. This can be a combination of resx files and file resources.
  863. </para>
  864. <para>
  865. .resx files will be compiled by <see cref="T:NAnt.DotNet.Tasks.ResGenTask"/> and then
  866. embedded into the resulting executable.
  867. </para>
  868. <para>
  869. The <see cref="P:NAnt.DotNet.Types.ResourceFileSet.Prefix"/> property is used to make
  870. up the resource name added to the assembly manifest for non-resx
  871. files.
  872. </para>
  873. <para>
  874. For .resx files the namespace from the matching source file is used
  875. as prefix. This matches the behaviour of Visual Studio.
  876. </para>
  877. <para>
  878. Multiple resources tags with different namespace prefixes may be
  879. specified.
  880. </para>
  881. </remarks>
  882. </member>
  883. <member name="P:NAnt.DotNet.Tasks.CompilerBase.Modules">
  884. <summary>
  885. Link the specified modules into this assembly.
  886. </summary>
  887. </member>
  888. <member name="P:NAnt.DotNet.Tasks.CompilerBase.Sources">
  889. <summary>
  890. The set of source files for compilation.
  891. </summary>
  892. </member>
  893. <member name="P:NAnt.DotNet.Tasks.CompilerBase.SupportsPackageReferences">
  894. <summary>
  895. Indicates whether package references are supported by compiler for
  896. a given target framework. The default is <see langword="false" />.
  897. </summary>
  898. </member>
  899. <member name="P:NAnt.DotNet.Tasks.CompilerBase.SupportsWarnAsErrorList">
  900. <summary>
  901. Indicates whether the compiler for a given target framework supports
  902. the "warnaserror" option that takes a list of warnings. The default
  903. is <see langword="false" />.
  904. </summary>
  905. </member>
  906. <member name="P:NAnt.DotNet.Tasks.CompilerBase.SupportsNoWarnList">
  907. <summary>
  908. Indicates whether the compiler for a given target framework supports
  909. a command line option that allows a list of warnings to be
  910. suppressed. The default is <see langword="false" />.
  911. </summary>
  912. </member>
  913. <member name="P:NAnt.DotNet.Tasks.CompilerBase.SupportsKeyContainer">
  914. <summary>
  915. Indicates whether the compiler for a given target framework supports
  916. the "keycontainer" option. The default is <see langword="false" />.
  917. </summary>
  918. </member>
  919. <member name="P:NAnt.DotNet.Tasks.CompilerBase.SupportsKeyFile">
  920. <summary>
  921. Indicates whether the compiler for a given target framework supports
  922. the "keyfile" option. The default is <see langword="false" />.
  923. </summary>
  924. </member>
  925. <member name="P:NAnt.DotNet.Tasks.CompilerBase.SupportsDelaySign">
  926. <summary>
  927. Indicates whether the compiler for a given target framework supports
  928. the "delaysign" option. The default is <see langword="false" />.
  929. </summary>
  930. </member>
  931. <member name="P:NAnt.DotNet.Tasks.CompilerBase.Extension">
  932. <summary>
  933. Gets the file extension required by the current compiler.
  934. </summary>
  935. <value>
  936. The file extension required by the current compiler.
  937. </value>
  938. </member>
  939. <member name="P:NAnt.DotNet.Tasks.CompilerBase.ClassNameRegex">
  940. <summary>
  941. Gets the class name regular expression for the language of the current compiler.
  942. </summary>
  943. <value> class name regular expression for the language of the current compiler</value>
  944. </member>
  945. <member name="P:NAnt.DotNet.Tasks.CompilerBase.NamespaceRegex">
  946. <summary>
  947. Gets the namespace regular expression for the language of the current compiler.
  948. </summary>
  949. <value> namespace regular expression for the language of the current compiler</value>
  950. </member>
  951. <member name="P:NAnt.DotNet.Tasks.CompilerBase.ProgramArguments">
  952. <summary>
  953. Gets the command-line arguments for the external program.
  954. </summary>
  955. <value>
  956. The command-line arguments for the external program.
  957. </value>
  958. </member>
  959. <member name="T:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage">
  960. <summary>
  961. Holds class and namespace information for resource (*.resx) linkage.
  962. </summary>
  963. </member>
  964. <member name="M:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage.#ctor(System.String,System.String)">
  965. <summary>
  966. Initializes a new instance of the <see cref="T:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage"/>
  967. class.
  968. </summary>
  969. <param name="namespaceName">The namespace the resource is under.</param>
  970. <param name="className">The class name the resource is associated with.</param>
  971. </member>
  972. <member name="M:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage.ToString">
  973. <summary>
  974. Returns the resource linkage as a string.
  975. </summary>
  976. <returns>
  977. A string representation of the resource linkage.
  978. </returns>
  979. </member>
  980. <member name="P:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage.IsValid">
  981. <summary>
  982. Gets a value indicating whether the <see cref="T:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage"/>
  983. instances contains valid data.
  984. </summary>
  985. <value>
  986. <see langword="true"/> if the <see cref="T:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage"/>
  987. instance contains valid data; otherwise, <see langword="false"/>.
  988. </value>
  989. </member>
  990. <member name="P:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage.HasNamespaceName">
  991. <summary>
  992. Gets a value indicating whether a namespace name is available
  993. for this <see cref="T:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage"/> instance.
  994. </summary>
  995. <value>
  996. <see langword="true"/> if a namespace name is available for
  997. this <see cref="T:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage"/> instance; otherwise,
  998. <see langword="false"/>.
  999. </value>
  1000. </member>
  1001. <member name="P:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage.HasClassName">
  1002. <summary>
  1003. Gets a value indicating whether a class name is available
  1004. for this <see cref="T:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage"/> instance.
  1005. </summary>
  1006. <value>
  1007. <see langword="true"/> if a class name is available for
  1008. this <see cref="T:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage"/> instance; otherwise,
  1009. <see langword="false"/>.
  1010. </value>
  1011. </member>
  1012. <member name="P:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage.NamespaceName">
  1013. <summary>
  1014. Gets the name of namespace the resource is under.
  1015. </summary>
  1016. <value>
  1017. The name of namespace the resource is under.
  1018. </value>
  1019. </member>
  1020. <member name="P:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage.ClassName">
  1021. <summary>
  1022. Gets the name of the class (most likely a form) that the resource
  1023. is associated with.
  1024. </summary>
  1025. <value>
  1026. The name of the class the resource is associated with.
  1027. </value>
  1028. </member>
  1029. <member name="P:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage.Culture">
  1030. <summary>
  1031. Gets the culture that the resource is associated with.
  1032. </summary>
  1033. <value>
  1034. The culture that the resource is associated with.
  1035. </value>
  1036. </member>
  1037. <member name="T:NAnt.DotNet.Tasks.CscTask">
  1038. <summary>
  1039. Compiles C# programs.
  1040. </summary>
  1041. <remarks>
  1042. <note>
  1043. In order to have <see cref="T:NAnt.DotNet.Tasks.CscTask"/> generate manifest resource names
  1044. that match those generated by Microsoft Visual Studio.NET, the value of
  1045. the <see cref="P:NAnt.DotNet.Types.ResourceFileSet.Prefix"/> attribute of the &lt;<see cref="P:NAnt.DotNet.Tasks.CompilerBase.ResourcesList"/>&gt;
  1046. element should match the "Default Namespace" of the C# project, and the
  1047. value of the <see cref="P:NAnt.DotNet.Types.ResourceFileSet.DynamicPrefix"/> attribute
  1048. should be set to "<see langword="true"/>".
  1049. </note>
  1050. </remarks>
  1051. <example>
  1052. <para>Compile a "HelloWorld" application, including embedded resources.</para>
  1053. <code>
  1054. <![CDATA[
  1055. <csc target="exe" output="HelloWorld.exe" debug="true">
  1056. <nowarn>
  1057. <!-- do not report warnings for missing XML comments -->
  1058. <warning number="0519" />
  1059. </nowarn>
  1060. <sources>
  1061. <include name="**/*.cs" />
  1062. </sources>
  1063. <resources dynamicprefix="true" prefix="HelloWorld">
  1064. <include name="**/*.resx" />
  1065. </resources>
  1066. <references>
  1067. <include name="System.dll" />
  1068. <include name="System.Data.dll" />
  1069. </references>
  1070. </csc>
  1071. ]]>
  1072. </code>
  1073. </example>
  1074. </member>
  1075. <member name="M:NAnt.DotNet.Tasks.CscTask.WriteOptions(System.IO.TextWriter)">
  1076. <summary>
  1077. Writes the compiler options to the specified <see cref="T:System.IO.TextWriter"/>.
  1078. </summary>
  1079. <param name="writer"><see cref="T:System.IO.TextWriter"/> to which the compiler options should be written.</param>
  1080. </member>
  1081. <member name="M:NAnt.DotNet.Tasks.CscTask.NeedsCompiling">
  1082. <summary>
  1083. Determines whether compilation is needed.
  1084. </summary>
  1085. </member>
  1086. <member name="P:NAnt.DotNet.Tasks.CscTask.BaseAddress">
  1087. <summary>
  1088. The preferred base address at which to load a DLL. The default base
  1089. address for a DLL is set by the .NET Framework common language
  1090. runtime.
  1091. </summary>
  1092. <value>
  1093. The preferred base address at which to load a DLL.
  1094. </value>
  1095. <remarks>
  1096. This address can be specified as a decimal, hexadecimal, or octal
  1097. number.
  1098. </remarks>
  1099. </member>
  1100. <member name="P:NAnt.DotNet.Tasks.CscTask.DebugOutput">
  1101. <summary>
  1102. Specifies the type of debugging information generated by the
  1103. compiler. The default is <see cref="F:NAnt.DotNet.Types.DebugOutput.None"/>.
  1104. </summary>
  1105. </member>
  1106. <member name="P:NAnt.DotNet.Tasks.CscTask.Debug">
  1107. <summary>
  1108. No longer expose this to build authors. Use <see cref="P:NAnt.DotNet.Tasks.CscTask.DebugOutput"/>
  1109. instead.
  1110. </summary>
  1111. </member>
  1112. <member name="P:NAnt.DotNet.Tasks.CscTask.DocFile">
  1113. <summary>
  1114. The name of the XML documentation file to generate.
  1115. </summary>
  1116. <remarks>
  1117. <para>
  1118. Corresponds with the <c>/doc:</c> flag.
  1119. </para>
  1120. </remarks>
  1121. </member>
  1122. <member name="P:NAnt.DotNet.Tasks.CscTask.FileAlign">
  1123. <summary>
  1124. Specifies the size of sections in the output file. Valid values are
  1125. 512, 1024, 2048, 4096, and 8192.
  1126. </summary>
  1127. <value>
  1128. The size of sections in the output file.
  1129. </value>
  1130. </member>
  1131. <member name="P:NAnt.DotNet.Tasks.CscTask.NoStdLib">
  1132. <summary>
  1133. Instructs the compiler not to import mscorlib.dll. The default is
  1134. <see langword="false" />.
  1135. </summary>
  1136. <remarks>
  1137. <para>
  1138. Corresponds with the <c>/nostdlib[+|-]</c> flag.
  1139. </para>
  1140. </remarks>
  1141. </member>
  1142. <member name="P:NAnt.DotNet.Tasks.CscTask.NoConfig">
  1143. <summary>
  1144. Instructs the compiler not to use implicit references to assemblies.
  1145. The default is <see langword="false" />.
  1146. </summary>
  1147. <remarks>
  1148. <para>
  1149. Corresponds with the <c>/noconfig</c> flag.
  1150. </para>
  1151. </remarks>
  1152. </member>
  1153. <member name="P:NAnt.DotNet.Tasks.CscTask.Checked">
  1154. <summary>
  1155. Specifies whether an integer arithmetic statement that is not in
  1156. the scope of the <c>checked</c> or <c>unchecked</c> keywords and
  1157. that results in a value outside the range of the data type should
  1158. cause a run-time exception. The default is <see langword="false" />.
  1159. </summary>
  1160. <remarks>
  1161. <para>
  1162. Corresponds with the <c>/checked[+|-]</c> flag.
  1163. </para>
  1164. </remarks>
  1165. </member>
  1166. <member name="P:NAnt.DotNet.Tasks.CscTask.Unsafe">
  1167. <summary>
  1168. Instructs the compiler to allow code that uses the <c>unsafe</c>
  1169. keyword. The default is <see langword="false" />.
  1170. </summary>
  1171. <remarks>
  1172. <para>
  1173. Corresponds with the <c>/unsafe[+|-]</c> flag.
  1174. </para>
  1175. </remarks>
  1176. </member>
  1177. <member name="P:NAnt.DotNet.Tasks.CscTask.LangVersion">
  1178. <summary>
  1179. Causes the compiler to only accept syntax that is included in a
  1180. given specification.
  1181. </summary>
  1182. <remarks>
  1183. <para>
  1184. Corresponds with the <c>/langversion</c> flag.
  1185. </para>
  1186. </remarks>
  1187. </member>
  1188. <member name="P:NAnt.DotNet.Tasks.CscTask.Optimize">
  1189. <summary>
  1190. Specifies whether the compiler should perform optimizations to the
  1191. make output files smaller, faster, and more effecient. The default
  1192. is <see langword="false" />.
  1193. </summary>
  1194. <value>
  1195. <see langword="true" /> if the compiler should perform optimizations;
  1196. otherwise, <see langword="false" />.
  1197. </value>
  1198. <remarks>
  1199. <para>
  1200. Corresponds with the <c>/optimize[+|-]</c> flag.
  1201. </para>
  1202. </remarks>
  1203. </member>
  1204. <member name="P:NAnt.DotNet.Tasks.CscTask.Platform">
  1205. <summary>
  1206. Specifies which platform version of common language runtime (CLR)
  1207. can run the output file.
  1208. </summary>
  1209. <value>
  1210. The platform version of common language runtime (CLR) that can run
  1211. the output file.
  1212. </value>
  1213. <remarks>
  1214. <para>
  1215. Corresponds with the <c>/platform</c> flag.
  1216. </para>
  1217. </remarks>
  1218. </member>
  1219. <member name="P:NAnt.DotNet.Tasks.CscTask.WarningLevel">
  1220. <summary>
  1221. Specifies the warning level for the compiler to display. Valid values
  1222. are <c>0</c>-<c>4</c>. The default is <c>4</c>.
  1223. </summary>
  1224. <value>
  1225. The warning level for the compiler to display.
  1226. </value>
  1227. <remarks>
  1228. <para>
  1229. Corresponds with the <c>/warn</c> flag.
  1230. </para>
  1231. </remarks>
  1232. </member>
  1233. <member name="P:NAnt.DotNet.Tasks.CscTask.Codepage">
  1234. <summary>
  1235. Specifies the code page to use for all source code files in the
  1236. compilation.
  1237. </summary>
  1238. <remarks>
  1239. <para>
  1240. Corresponds with the <c>/codepage</c> flag.
  1241. </para>
  1242. </remarks>
  1243. </member>
  1244. <member name="P:NAnt.DotNet.Tasks.CscTask.SupportsDocGeneration">
  1245. <summary>
  1246. Specifies whether the compiler for the active target framework
  1247. supports generation of XML Documentation file. The default is
  1248. <see langword="true" />.
  1249. </summary>
  1250. </member>
  1251. <member name="P:NAnt.DotNet.Tasks.CscTask.SupportsPlatform">
  1252. <summary>
  1253. Specifies whether the compiler for the active target framework
  1254. supports limiting the platform on which the compiled code can run.
  1255. The default is <see langword="false" />.
  1256. </summary>
  1257. </member>
  1258. <member name="P:NAnt.DotNet.Tasks.CscTask.SupportsLangVersion">
  1259. <summary>
  1260. Specifies whether the compiler for the active target framework
  1261. supports accepting only a specific language syntax.
  1262. The default is <see langword="false" />.
  1263. </summary>
  1264. </member>
  1265. <member name="P:NAnt.DotNet.Tasks.CscTask.Extension">
  1266. <summary>
  1267. Gets the file extension required by the current compiler.
  1268. </summary>
  1269. <value>
  1270. For the C# compiler, the file extension is always <c>cs</c>.
  1271. </value>
  1272. </member>
  1273. <member name="P:NAnt.DotNet.Tasks.CscTask.ClassNameRegex">
  1274. <summary>
  1275. Gets the class name regular expression for the language of the
  1276. current compiler.
  1277. </summary>
  1278. <value>
  1279. Class name regular expression for the language of the current
  1280. compiler.
  1281. </value>
  1282. </member>
  1283. <member name="P:NAnt.DotNet.Tasks.CscTask.NamespaceRegex">
  1284. <summary>
  1285. Gets the namespace regular expression for the language of the current compiler.
  1286. </summary>
  1287. <value>
  1288. Namespace regular expression for the language of the current
  1289. compiler.
  1290. </value>
  1291. </member>
  1292. <member name="T:NAnt.DotNet.Tasks.DelaySignTask">
  1293. <summary>
  1294. Signs delay-signed .NET Assemblies, or re-signs existing assemblies.
  1295. </summary>
  1296. <remarks>
  1297. <para>
  1298. The delay-signing mechanism takes a fileset (named targets)
  1299. and either a <see cref="P:NAnt.DotNet.Tasks.DelaySignTask.KeyFile"/> attribute for a file containing the
  1300. public and private keys, or <see cref="P:NAnt.DotNet.Tasks.DelaySignTask.KeyContainer"/> to name a key
  1301. container.
  1302. </para>
  1303. </remarks>
  1304. <example>
  1305. <para>Sign partially-signed <c>foo.dll</c> with <c>bar.snk</c>.</para>
  1306. <code>
  1307. <![CDATA[
  1308. <delay-sign keyfile="bar.snk" verbose="false">
  1309. <targets>
  1310. <include name="foo.dll" />
  1311. </targets>
  1312. </delay-sign>
  1313. ]]>
  1314. </code>
  1315. </example>
  1316. </member>
  1317. <member name="M:NAnt.DotNet.Tasks.DelaySignTask.ExecuteTask">
  1318. <summary>
  1319. Converts a single file or group of files.
  1320. </summary>
  1321. </member>
  1322. <member name="P:NAnt.DotNet.Tasks.DelaySignTask.Targets">
  1323. <summary>
  1324. List of assemblies/executables to sign.
  1325. </summary>
  1326. </member>
  1327. <member name="P:NAnt.DotNet.Tasks.DelaySignTask.KeyFile">
  1328. <summary>
  1329. Specifies the filesystem path to the signing key.
  1330. </summary>
  1331. </member>
  1332. <member name="P:NAnt.DotNet.Tasks.DelaySignTask.KeyContainer">
  1333. <summary>
  1334. Specifies the key container.
  1335. </summary>
  1336. </member>
  1337. <member name="P:NAnt.DotNet.Tasks.DelaySignTask.ProgramArguments">
  1338. <summary>
  1339. Gets the command line arguments for the external program.
  1340. </summary>
  1341. <value>
  1342. The command line arguments for the external program.
  1343. </value>
  1344. </member>
  1345. <member name="T:NAnt.DotNet.Tasks.IlasmTask">
  1346. <summary>
  1347. Compiles ILASM programs.
  1348. </summary>
  1349. <example>
  1350. <para>
  1351. Compiles <c>helloworld.il</c> to <c>helloworld.exe</c>.
  1352. </para>
  1353. <code>
  1354. <![CDATA[
  1355. <ilasm target="exe" output="helloworld.exe" debug="true">
  1356. <sources>
  1357. <include name="helloworld.il" />
  1358. </sources>
  1359. </ilasm>
  1360. ]]>
  1361. </code>
  1362. </example>
  1363. </member>
  1364. <member name="M:NAnt.DotNet.Tasks.IlasmTask.ExecuteTask">
  1365. <summary>
  1366. Compiles the sources.
  1367. </summary>
  1368. </member>
  1369. <member name="M:NAnt.DotNet.Tasks.IlasmTask.WriteOptions">
  1370. <summary>
  1371. Writes the compiler options.
  1372. </summary>
  1373. </member>
  1374. <member name="M:NAnt.DotNet.Tasks.IlasmTask.WriteOption(System.IO.StringWriter,System.String)">
  1375. <summary>
  1376. Writes an option using the default output format.
  1377. </summary>
  1378. <param name="writer">
  1379. The <see cref="T:System.IO.StringWriter"/> to which the compiler options should
  1380. be written.
  1381. </param>
  1382. <param name="name">
  1383. A <see cref="T:System.String"/> that contains the name of the
  1384. option which should be passed to the compiler.
  1385. </param>
  1386. </member>
  1387. <member name="M:NAnt.DotNet.Tasks.IlasmTask.WriteOption(System.IO.StringWriter,System.String,System.String)">
  1388. <summary>
  1389. Writes an option and its value using the default output format.
  1390. </summary>
  1391. <param name="writer">
  1392. The <see cref="T:System.IO.StringWriter"/> to which the compiler options should
  1393. be written.
  1394. </param>
  1395. <param name="name">
  1396. A <see cref="T:System.String"/> that contains the name of the
  1397. option which should be passed to the compiler.
  1398. </param>
  1399. <param name="arg">
  1400. A <see cref="T:System.String"/> that contains the value of the
  1401. option which should be passed to the compiler.
  1402. </param>
  1403. </member>
  1404. <member name="M:NAnt.DotNet.Tasks.IlasmTask.NeedsCompiling">
  1405. <summary>
  1406. Determines whether or not compilation is needed.
  1407. </summary>
  1408. <returns>
  1409. <see langword="true" /> if compilation is needed; otherwise,
  1410. <see langword="false" />.
  1411. </returns>
  1412. </member>
  1413. <member name="P:NAnt.DotNet.Tasks.IlasmTask.Clock">
  1414. <summary>
  1415. Specifies whether or not the compiler should measure and report
  1416. the compilation times.
  1417. </summary>
  1418. <value>
  1419. <see langword="true" /> if the compilation times should be
  1420. measured and reported; otherwise, <see langword="false" />. The
  1421. default is <see langword="false" />.
  1422. </value>
  1423. <remarks>
  1424. <para>
  1425. Corresponds to the <c>/CLOCK</c> flag.
  1426. </para>
  1427. </remarks>
  1428. </member>
  1429. <member name="P:NAnt.DotNet.Tasks.IlasmTask.Debug">
  1430. <summary>
  1431. Specifies whether or not the compiler should generate debug
  1432. information.
  1433. </summary>
  1434. <value>
  1435. <see langword="true" /> if debug information should be generated;
  1436. otherwise, <see langword="false" />. The default is
  1437. <see langword="false" />.
  1438. </value>
  1439. <remarks>
  1440. <para>
  1441. Corresponds to the <c>/DEBUG</c> flag.
  1442. </para>
  1443. </remarks>
  1444. </member>
  1445. <member name="P:NAnt.DotNet.Tasks.IlasmTask.Error">
  1446. <summary>
  1447. Specifies whether or not the compiler should attempt to create a
  1448. PE file even if compilation errors have been reported.
  1449. </summary>
  1450. <value>
  1451. <see langword="true" /> if a PE file has to be created even if
  1452. compilation errors have been reported; otherwise,
  1453. <see langword="false" />. The default is <see langword="false" />.
  1454. </value>
  1455. <remarks>
  1456. <para>
  1457. Corresponds to the <c>/ERROR</c> flag.
  1458. </para>
  1459. </remarks>
  1460. </member>
  1461. <member name="P:NAnt.DotNet.Tasks.IlasmTask.ForceRebuild">
  1462. <summary>
  1463. Instructs NAnt to recompile the output file regardless of the file
  1464. timestamps.
  1465. </summary>
  1466. <value>
  1467. <see langword="true" /> if the output file should be recompiled
  1468. regardless of its timestamps; otherwise <see langword="false" />.
  1469. The default is <see langword="false" />.
  1470. </value>
  1471. </member>
  1472. <member name="P:NAnt.DotNet.Tasks.IlasmTask.Listing">
  1473. <summary>
  1474. Specifies whether or not the compiler should type a formatted
  1475. listing of the compilation result.
  1476. </summary>
  1477. <value>
  1478. <see langword="true" /> if a formatted listing of the compilation
  1479. result should be typed; otherwise, <see langword="false" />. The
  1480. default is <see langword="false" />.
  1481. </value>
  1482. <remarks>
  1483. <para>
  1484. Corresponds to the <c>/LISTING</c> flag.
  1485. </para>
  1486. </remarks>
  1487. </member>
  1488. <member name="P:NAnt.DotNet.Tasks.IlasmTask.Alignment">
  1489. <summary>
  1490. Instructs the compiler to set the <i>FileAlignment</i> value in
  1491. the PE header.
  1492. </summary>
  1493. <value>
  1494. An <see cref="T:System.Int32"/> that represents the <i>FileAlignment</i>
  1495. value to set in the PE header. The value must be a power of 2, in
  1496. range from 512 to 65536.
  1497. </value>
  1498. <remarks>
  1499. <para>
  1500. Corresponds to the <c>/ALIGNMENT</c> flag.
  1501. </para>
  1502. </remarks>
  1503. </member>
  1504. <member name="P:NAnt.DotNet.Tasks.IlasmTask.Base">
  1505. <summary>
  1506. Instructs the compiler to set the <i>ImageBase</i> value in
  1507. the PE header.
  1508. </summary>
  1509. <value>
  1510. A <see cref="T:System.Int32"/> that represents the <i>ImageBase</i>
  1511. value to set in the PE header.
  1512. </value>
  1513. <remarks>
  1514. <para>
  1515. Corresponds to the <c>/BASE</c> flag.
  1516. </para>
  1517. </remarks>
  1518. </member>
  1519. <member name="P:NAnt.DotNet.Tasks.IlasmTask.Flags">
  1520. <summary>
  1521. Instructs the compiler to set the <i>Flags</i> value in the CLR
  1522. header.
  1523. </summary>
  1524. <value>
  1525. An <see cref="T:System.Int32"/> that represents the <i>Flags</i>
  1526. value to set in the CLR header. The most frequently value are 1
  1527. (pre-IL code) and 2 (mixed code). The third bit indicating that
  1528. the PE file is strong signed, is ignored.
  1529. </value>
  1530. <remarks>
  1531. <para>
  1532. Corresponds to the <c>/FLAGS</c> flag.
  1533. </para>
  1534. </remarks>
  1535. </member>
  1536. <member name="P:NAnt.DotNet.Tasks.IlasmTask.Subsystem">
  1537. <summary>
  1538. Instructs the compiler to set the <i>Subsystem</i> value in the PE
  1539. header.
  1540. </summary>
  1541. <value>
  1542. An <see cref="T:System.Int32"/> that represents the <i>Subsystem</i>
  1543. value to set in the PE header. The most frequently value are 3
  1544. (console application) and 2 (GUI application).
  1545. </value>
  1546. <remarks>
  1547. <para>
  1548. Corresponds to the <c>/SUBSYSTEM</c> flag.
  1549. </para>
  1550. </remarks>
  1551. </member>
  1552. <member name="P:NAnt.DotNet.Tasks.IlasmTask.Target">
  1553. <summary>
  1554. Specifies which output type should be generated.
  1555. </summary>
  1556. <value>
  1557. A <see cref="T:System.String"/> that contains the target type.
  1558. Possible values are <c>dll</c> and <c>exe</c>.
  1559. </value>
  1560. <remarks>
  1561. <para>
  1562. Corresponds to the <c>/OUTPUT</c> flag.
  1563. </para>
  1564. </remarks>
  1565. </member>
  1566. <member name="P:NAnt.DotNet.Tasks.IlasmTask.KeySource">
  1567. <summary>
  1568. Instructs the compiler to generate a strong signature of the PE
  1569. file.
  1570. </summary>
  1571. <value>
  1572. A <see cref="T:System.String"/> that contains the private
  1573. encryption key.
  1574. </value>
  1575. <remarks>
  1576. <para>
  1577. Corresponds to the <c>/KEY=<![CDATA[@<]]>keysource<![CDATA[>]]></c>
  1578. flag.
  1579. </para>
  1580. </remarks>
  1581. </member>
  1582. <member name="P:NAnt.DotNet.Tasks.IlasmTask.KeyFile">
  1583. <summary>
  1584. Instructs the compiler to generate a strong signature of the PE
  1585. file.
  1586. </summary>
  1587. <value>
  1588. A <see cref="T:System.IO.FileInfo"/> that represents the file
  1589. containing the private encryption key.
  1590. </value>
  1591. <remarks>
  1592. <para>
  1593. Corresponds to the <c>/KEY=<![CDATA[<]]>keyfile<![CDATA[>]]></c>
  1594. flag.
  1595. </para>
  1596. </remarks>
  1597. </member>
  1598. <member name="P:NAnt.DotNet.Tasks.IlasmTask.OutputFile">
  1599. <summary>
  1600. Specifies the name of the output file created by the compiler.
  1601. </summary>
  1602. <value>
  1603. A <see cref="T:System.IO.FileInfo"/> that represents the name of
  1604. the output file.
  1605. </value>
  1606. <remarks>
  1607. <para>
  1608. Corresponds to the <c>/OUTPUT</c> flag.
  1609. </para>
  1610. </remarks>
  1611. </member>
  1612. <member name="P:NAnt.DotNet.Tasks.IlasmTask.ResourceFile">
  1613. <summary>
  1614. Instructs the compiler to link the specified unmanaged resource
  1615. file into the resulting PE file.
  1616. </summary>
  1617. <value>
  1618. A <see cref="T:System.IO.FileInfo"/> that represents the unmanaged
  1619. resource file to link.
  1620. </value>
  1621. <remarks>
  1622. <para>
  1623. Corresponds to the <c>/RESOURCE</c> flag.
  1624. </para>
  1625. </remarks>
  1626. </member>
  1627. <member name="P:NAnt.DotNet.Tasks.IlasmTask.Sources">
  1628. <summary>
  1629. Specifies the set of source files to compile.
  1630. </summary>
  1631. <value>
  1632. A <see cref="T:NAnt.Core.Types.FileSet"/> that represents the set
  1633. of source files to compile.
  1634. </value>
  1635. </member>
  1636. <member name="P:NAnt.DotNet.Tasks.IlasmTask.ProgramArguments">
  1637. <summary>
  1638. Gets the command-line arguments for the external program.
  1639. </summary>
  1640. <value>
  1641. A <see cref="T:System.String"/> that contains the command-line
  1642. arguments for the external program.
  1643. </value>
  1644. </member>
  1645. <member name="T:NAnt.DotNet.Tasks.JscTask">
  1646. <summary>
  1647. Compiles JScript.NET programs.
  1648. </summary>
  1649. <example>
  1650. <para>Compile <c>helloworld.js</c> to <c>helloworld.exe</c>.</para>
  1651. <code>
  1652. <![CDATA[
  1653. <jsc target="exe" output="helloworld.exe" debug="true">
  1654. <sources>
  1655. <include name="helloworld.js" />
  1656. </sources>
  1657. </jsc>
  1658. ]]>
  1659. </code>
  1660. </example>
  1661. </member>
  1662. <member name="M:NAnt.DotNet.Tasks.JscTask.WriteModuleReferences(System.IO.TextWriter)">
  1663. <summary>
  1664. Writes module references to the specified <see cref="T:System.IO.TextWriter"/>.
  1665. </summary>
  1666. <param name="writer">The <see cref="T:System.IO.TextWriter"/> to which the module references should be written.</param>
  1667. </member>
  1668. <member name="M:NAnt.DotNet.Tasks.JscTask.WriteOptions(System.IO.TextWriter)">
  1669. <summary>
  1670. Writes the compiler options to the specified <see cref="T:System.IO.TextWriter"/>.
  1671. </summary>
  1672. <param name="writer"><see cref="T:System.IO.TextWriter"/> to which the compiler options should be written.</param>
  1673. </member>
  1674. <member name="P:NAnt.DotNet.Tasks.JscTask.AutoRef">
  1675. <summary>
  1676. Automatically references assemblies if they have the same name as
  1677. an imported namespace or as a type annotation when declaring a
  1678. variable. The default is <see langword="false" />.
  1679. </summary>
  1680. <remarks>
  1681. <para>
  1682. Corresponds with the <c>/autoref</c> flag.
  1683. </para>
  1684. </remarks>
  1685. </member>
  1686. <member name="P:NAnt.DotNet.Tasks.JscTask.NoStdLib">
  1687. <summary>
  1688. Instructs the compiler not to import standard library, and changes
  1689. <see cref="P:NAnt.DotNet.Tasks.JscTask.AutoRef"/> to <see langword="false"/>. The default is
  1690. <see langword="false"/>.
  1691. </summary>
  1692. <remarks>
  1693. <para>
  1694. Corresponds with the <c>/noconfig</c> flag.
  1695. </para>
  1696. </remarks>
  1697. </member>
  1698. <member name="P:NAnt.DotNet.Tasks.JscTask.Platform">
  1699. <summary>
  1700. Specifies which platform version of common language runtime (CLR)
  1701. can run the output file.
  1702. </summary>
  1703. <value>
  1704. The platform version of common language runtime (CLR) that can run
  1705. the output file.
  1706. </value>
  1707. <remarks>
  1708. <para>
  1709. Corresponds with the <c>/platform</c> flag.
  1710. </para>
  1711. </remarks>
  1712. </member>
  1713. <member name="P:NAnt.DotNet.Tasks.JscTask.VersionSafe">
  1714. <summary>
  1715. Causes the compiler to generate errors for implicit method
  1716. overrides. The default is <see langword="false" />.
  1717. </summary>
  1718. <remarks>
  1719. <para>
  1720. Corresponds with the <c>/versionsafe</c> flag.
  1721. </para>
  1722. </remarks>
  1723. </member>
  1724. <member name="P:NAnt.DotNet.Tasks.JscTask.WarningLevel">
  1725. <summary>
  1726. Specifies the warning level for the compiler to display. Valid
  1727. values are <c>0</c>-<c>4</c>. The default is <c>4</c>.
  1728. </summary>
  1729. <value>
  1730. The warning level for the compiler to display.
  1731. </value>
  1732. <remarks>
  1733. <para>
  1734. Corresponds with the <c>/warn</c> flag.
  1735. </para>
  1736. </remarks>
  1737. </member>
  1738. <member name="P:NAnt.DotNet.Tasks.JscTask.WarningAsError">
  1739. <summary>
  1740. Controls which warnings should be reported as errors.
  1741. </summary>
  1742. <remarks>
  1743. Override to avoid exposing this to build authors, as the JScript.NET
  1744. compiler does not allow control over which warnings should be
  1745. reported as errors.
  1746. </remarks>
  1747. </member>
  1748. <member name="P:NAnt.DotNet.Tasks.JscTask.NoWarn">
  1749. <summary>
  1750. Specifies a comma-separated list of warnings that should be suppressed
  1751. by the compiler.
  1752. </summary>
  1753. <remarks>
  1754. Override to avoid exposing this to build authors, as the JScript.NET
  1755. compiler does not support package references.
  1756. </remarks>
  1757. </member>
  1758. <member name="P:NAnt.DotNet.Tasks.JscTask.SuppressWarnings">
  1759. <summary>
  1760. Specifies a list of warnings that you want the compiler to suppress.
  1761. </summary>
  1762. <remarks>
  1763. Override to avoid exposing this to build authors, as the JScript.NET
  1764. compiler does not support suppressing warnings.
  1765. </remarks>
  1766. </member>
  1767. <member name="P:NAnt.DotNet.Tasks.JscTask.Codepage">
  1768. <summary>
  1769. Specifies the code page to use for all source code files in the
  1770. compilation.
  1771. </summary>
  1772. <remarks>
  1773. <para>
  1774. Corresponds with the <c>/codepage</c> flag.
  1775. </para>
  1776. </remarks>
  1777. </member>
  1778. <member name="P:NAnt.DotNet.Tasks.JscTask.KeyContainer">
  1779. <summary>
  1780. Specifies the key pair container used to strongname the assembly.
  1781. </summary>
  1782. <remarks>
  1783. Override to avoid exposing this to build authors, as the JScript.NET
  1784. does not support this.
  1785. </remarks>
  1786. </member>
  1787. <member name="P:NAnt.DotNet.Tasks.JscTask.KeyFile">
  1788. <summary>
  1789. Specifies a strong name key file.
  1790. </summary>
  1791. <remarks>
  1792. Override to avoid exposing this to build authors, as the JScript.NET
  1793. does not support this.
  1794. </remarks>
  1795. </member>
  1796. <member name="P:NAnt.DotNet.Tasks.JscTask.DelaySign">
  1797. <summary>
  1798. Specifies whether to delay sign the assembly using only the public
  1799. portion of the strong name key.
  1800. </summary>
  1801. <remarks>
  1802. Override to avoid exposing this to build authors, as the JScript.NET
  1803. does not support this.
  1804. </remarks>
  1805. </member>
  1806. <member name="P:NAnt.DotNet.Tasks.JscTask.SupportsKeyContainer">
  1807. <summary>
  1808. Indicates whether the compiler for a given target framework supports
  1809. the "keycontainer" option. The default is <see langword="false" />.
  1810. </summary>
  1811. <value>
  1812. <see langword="false" />.
  1813. </value>
  1814. <remarks>
  1815. Override to avoid exposing this to build authors, as the JScript.NET
  1816. does not support this.
  1817. </remarks>
  1818. </member>
  1819. <member name="P:NAnt.DotNet.Tasks.JscTask.SupportsKeyFile">
  1820. <summary>
  1821. Indicates whether the compiler for a given target framework supports
  1822. the "keyfile" option. The default is <see langword="false" />.
  1823. </summary>
  1824. <value>
  1825. <see langword="false" />.
  1826. </value>
  1827. <remarks>
  1828. Override to avoid exposing this to build authors, as the JScript.NET
  1829. does not support this.
  1830. </remarks>
  1831. </member>
  1832. <member name="P:NAnt.DotNet.Tasks.JscTask.SupportsDelaySign">
  1833. <summary>
  1834. Indicates whether the compiler for a given target framework supports
  1835. the "delaysign" option. The default is <see langword="false" />.
  1836. </summary>
  1837. <value>
  1838. <see langword="false" />.
  1839. </value>
  1840. <remarks>
  1841. Override to avoid exposing this to build authors, as the JScript.NET
  1842. does not support this.
  1843. </remarks>
  1844. </member>
  1845. <member name="P:NAnt.DotNet.Tasks.JscTask.SupportsPlatform">
  1846. <summary>
  1847. Specifies whether the compiler for the active target framework
  1848. supports limiting the platform on which the compiled code can run.
  1849. The default is <see langword="false" />.
  1850. </summary>
  1851. </member>
  1852. <member name="P:NAnt.DotNet.Tasks.JscTask.Modules">
  1853. <summary>
  1854. Link the specified modules into this assembly.
  1855. </summary>
  1856. <remarks>
  1857. Override to avoid exposing this to build authors, as the JScript.NET
  1858. compiler does not support linking modules.
  1859. </remarks>
  1860. </member>
  1861. <member name="P:NAnt.DotNet.Tasks.JscTask.Extension">
  1862. <summary>
  1863. Gets the file extension required by the current compiler.
  1864. </summary>
  1865. <value>
  1866. For the JScript.NET compiler, the file extension is always <c>js</c>.
  1867. </value>
  1868. </member>
  1869. <member name="P:NAnt.DotNet.Tasks.JscTask.ClassNameRegex">
  1870. <summary>
  1871. Gets the class name regular expression for the language of the
  1872. current compiler.
  1873. </summary>
  1874. <value>
  1875. Class name regular expression for the language of the current
  1876. compiler.
  1877. </value>
  1878. </member>
  1879. <member name="P:NAnt.DotNet.Tasks.JscTask.NamespaceRegex">
  1880. <summary>
  1881. Gets the namespace regular expression for the language of the
  1882. current compiler.
  1883. </summary>
  1884. <value>
  1885. Namespace regular expression for the language of the current
  1886. compiler.
  1887. </value>
  1888. </member>
  1889. <member name="T:NAnt.DotNet.Tasks.LicenseTask">
  1890. <summary>
  1891. Generates a <c>.licence</c> file from a <c>.licx</c> file.
  1892. </summary>
  1893. <remarks>
  1894. <para>
  1895. If no output file is specified, the default filename is the name of the
  1896. target file with the extension <c>.licenses</c> appended.
  1897. </para>
  1898. </remarks>
  1899. <example>
  1900. <para>
  1901. Generate the file <c>component.exe.licenses</c> file from <c>component.licx</c>.
  1902. </para>
  1903. <code>
  1904. <![CDATA[
  1905. <license input="component.licx" licensetarget="component.exe" />
  1906. ]]>
  1907. </code>
  1908. </example>
  1909. </member>
  1910. <member name="M:NAnt.DotNet.Tasks.LicenseTask.Initialize">
  1911. <summary>
  1912. Initializes the <see cref="T:NAnt.DotNet.Tasks.LicenseTask"/> class.
  1913. </summary>
  1914. </member>
  1915. <member name="M:NAnt.DotNet.Tasks.LicenseTask.PrepareProcess(System.Diagnostics.Process)">
  1916. <summary>
  1917. Updates the <see cref="T:System.Diagnostics.ProcessStartInfo"/> of the specified
  1918. <see cref="T:System.Diagnostics.Process"/>.
  1919. </summary>
  1920. <param name="process">The <see cref="T:System.Diagnostics.Process"/> of which the <see cref="T:System.Diagnostics.ProcessStartInfo"/> should be updated.</param>
  1921. </member>
  1922. <member name="M:NAnt.DotNet.Tasks.LicenseTask.ExecuteTask">
  1923. <summary>
  1924. Generates the license file.
  1925. </summary>
  1926. </member>
  1927. <member name="M:NAnt.DotNet.Tasks.LicenseTask.NeedsCompiling(System.IO.FileInfo)">
  1928. <summary>
  1929. Determines whether the <c>.licenses</c> file needs to be recompiled
  1930. or is uptodate.
  1931. </summary>
  1932. <param name="licensesFile">The <c>.licenses</c> file.</param>
  1933. <returns>
  1934. <see langword="true" /> if the <c>.licenses</c> file needs compiling;
  1935. otherwise, <see langword="false" />.
  1936. </returns>
  1937. </member>
  1938. <member name="P:NAnt.DotNet.Tasks.LicenseTask.InputFile">
  1939. <summary>
  1940. Input file to process.
  1941. </summary>
  1942. </member>
  1943. <member name="P:NAnt.DotNet.Tasks.LicenseTask.OutputFile">
  1944. <summary>
  1945. Name of the license file to output.
  1946. </summary>
  1947. </member>
  1948. <member name="P:NAnt.DotNet.Tasks.LicenseTask.Assemblies">
  1949. <summary>
  1950. Names of the references to scan for the licensed component.
  1951. </summary>
  1952. </member>
  1953. <member name="P:NAnt.DotNet.Tasks.LicenseTask.LicenseTarget">
  1954. <summary>
  1955. Specifies the executable for which the .licenses file is generated.
  1956. </summary>
  1957. </member>
  1958. <member name="P:NAnt.DotNet.Tasks.LicenseTask.Target">
  1959. <summary>
  1960. Specifies the executable for which the .licenses file is generated.
  1961. </summary>
  1962. </member>
  1963. <member name="P:NAnt.DotNet.Tasks.LicenseTask.SupportsAssemblyReferences">
  1964. <summary>
  1965. Indicates whether assembly references are supported by the current
  1966. target framework. The default is <see langword="false" />.
  1967. </summary>
  1968. <remarks>
  1969. Applies only to frameworks having a command line tool for compiling
  1970. licenses files.
  1971. </remarks>
  1972. </member>
  1973. <member name="P:NAnt.DotNet.Tasks.LicenseTask.HasCommandLineCompiler">
  1974. <summary>
  1975. Indicates whether the current target framework has a command line
  1976. tool for compiling licenses files. The default is
  1977. <see langword="true" />.
  1978. </summary>
  1979. </member>
  1980. <member name="P:NAnt.DotNet.Tasks.LicenseTask.BaseDirectory">
  1981. <summary>
  1982. Gets the working directory for the application.
  1983. </summary>
  1984. <value>
  1985. The working directory for the application.
  1986. </value>
  1987. </member>
  1988. <member name="P:NAnt.DotNet.Tasks.LicenseTask.Arguments">
  1989. <summary>
  1990. The command-line arguments for the external program.
  1991. </summary>
  1992. <remarks>
  1993. Override to avoid exposing these elements in build file.
  1994. </remarks>
  1995. </member>
  1996. <member name="P:NAnt.DotNet.Tasks.LicenseTask.ProgramArguments">
  1997. <summary>
  1998. Gets the command-line arguments for the external program.
  1999. </summary>
  2000. <value>
  2001. The command-line arguments for the external program.
  2002. </value>
  2003. </member>
  2004. <member name="P:NAnt.DotNet.Tasks.LicenseTask.ProgramFileName">
  2005. <summary>
  2006. Gets the filename of the external program to start.
  2007. </summary>
  2008. <value>
  2009. The filename of the external program.
  2010. </value>
  2011. <remarks>
  2012. Override in derived classes to explicitly set the location of the
  2013. external tool.
  2014. </remarks>
  2015. </member>
  2016. <member name="T:NAnt.DotNet.Tasks.LicenseTask.LicenseGatherer">
  2017. <summary>
  2018. Responsible for reading the license and writing them to a license
  2019. file.
  2020. </summary>
  2021. </member>
  2022. <member name="M:NAnt.DotNet.Tasks.LicenseTask.LicenseGatherer.InitializeLifetimeService">
  2023. <summary>
  2024. Obtains a lifetime service object to control the lifetime policy for
  2025. this instance.
  2026. </summary>
  2027. <returns>
  2028. An object of type <see cref="T:System.Runtime.Remoting.Lifetime.ILease"/> used to control the lifetime
  2029. policy for this instance. This is the current lifetime service object
  2030. for this instance if one exists; otherwise, a new lifetime service
  2031. object initialized with a lease that will never time out.
  2032. </returns>
  2033. </member>
  2034. <member name="M:NAnt.DotNet.Tasks.LicenseTask.LicenseGatherer.CreateLicenseFile(NAnt.DotNet.Tasks.LicenseTask,System.String)">
  2035. <summary>
  2036. Creates the whole license file.
  2037. </summary>
  2038. <param name="licenseTask">The <see cref="T:NAnt.DotNet.Tasks.LicenseTask"/> instance for which the license file should be created.</param>
  2039. <param name="licensesFile">The .licenses file to create.</param>
  2040. </member>
  2041. <member name="M:NAnt.DotNet.Tasks.LicenseTask.LicenseGatherer.IsSerializable(System.Object)">
  2042. <summary>
  2043. Determines whether the given object is serializable in binary
  2044. format.
  2045. </summary>
  2046. <param name="value">The object to check.</param>
  2047. <returns>
  2048. <see langword="true" /> if <paramref name="value" /> is
  2049. serializable in binary format; otherwise, <see langword="false" />.
  2050. </returns>
  2051. </member>
  2052. <member name="T:NAnt.DotNet.Tasks.NDocTask">
  2053. <summary>
  2054. Runs NDoc V1.3.1 to create documentation.
  2055. </summary>
  2056. <remarks>
  2057. <para>
  2058. See the <see href="http://ndoc.sourceforge.net/">NDoc home page</see> for more
  2059. information.
  2060. </para>
  2061. <note>
  2062. By default, only the NDoc MSDN documenter ships as part of the NAnt
  2063. distribution. To make another NDoc documenter from the NDoc V1.3.1
  2064. distribution available to the <see cref="T:NAnt.DotNet.Tasks.NDocTask"/>, copy the
  2065. documenter assembly (and possible dependencies) to the "lib"
  2066. directory corresponding with the CLR you're running NAnt on
  2067. (eg. &lt;nant root&gt;/bin/lib/net/1.1).
  2068. </note>
  2069. </remarks>
  2070. <example>
  2071. <para>
  2072. Document two assemblies using the MSDN documenter. The namespaces are
  2073. documented in <c>NamespaceSummary.xml</c>.
  2074. </para>
  2075. <code>
  2076. <![CDATA[
  2077. <ndoc>
  2078. <assemblies basedir="${build.dir}">
  2079. <include name="NAnt.exe" />
  2080. <include name="NAnt.Core.dll" />
  2081. </assemblies>
  2082. <summaries basedir="${build.dir}">
  2083. <include name="NamespaceSummary.xml" />
  2084. </summaries>
  2085. <documenters>
  2086. <documenter name="MSDN">
  2087. <property name="OutputDirectory" value="doc\MSDN" />
  2088. <property name="HtmlHelpName" value="NAnt" />
  2089. <property name="HtmlHelpCompilerFilename" value="hhc.exe" />
  2090. <property name="IncludeFavorites" value="False" />
  2091. <property name="Title" value="An NDoc Documented Class Library" />
  2092. <property name="SplitTOCs" value="False" />
  2093. <property name="DefaulTOC" value="" />
  2094. <property name="ShowVisualBasic" value="True" />
  2095. <property name="ShowMissingSummaries" value="True" />
  2096. <property name="ShowMissingRemarks" value="True" />
  2097. <property name="ShowMissingParams" value="True" />
  2098. <property name="ShowMissingReturns" value="True" />
  2099. <property name="ShowMissingValues" value="True" />
  2100. <property name="DocumentInternals" value="False" />
  2101. <property name="DocumentProtected" value="True" />
  2102. <property name="DocumentPrivates" value="False" />
  2103. <property name="DocumentEmptyNamespaces" value="False" />
  2104. <property name="IncludeAssemblyVersion" value="False" />
  2105. <property name="CopyrightText" value="" />
  2106. <property name="CopyrightHref" value="" />
  2107. </documenter>
  2108. </documenters>
  2109. </ndoc>
  2110. ]]>
  2111. </code>
  2112. <para>Content of <c>NamespaceSummary.xml</c> :</para>
  2113. <code>
  2114. <![CDATA[
  2115. <namespaces>
  2116. <namespace name="Foo.Bar">
  2117. The <b>Foo.Bar</b> namespace reinvents the wheel.
  2118. </namespace>
  2119. <namespace name="Foo.Bar.Tests">
  2120. The <b>Foo.Bar.Tests</b> namespace ensures that the Foo.Bar namespace reinvents the wheel correctly.
  2121. </namespace>
  2122. </namespaces>
  2123. ]]>
  2124. </code>
  2125. </example>
  2126. </member>
  2127. <member name="M:NAnt.DotNet.Tasks.NDocTask.Initialize">
  2128. <summary>
  2129. Initializes the taks and verifies the parameters.
  2130. </summary>
  2131. </member>
  2132. <member name="M:NAnt.DotNet.Tasks.NDocTask.ExecuteTask">
  2133. <summary>
  2134. Generates an NDoc project and builds the documentation.
  2135. </summary>
  2136. </member>
  2137. <member name="M:NAnt.DotNet.Tasks.NDocTask.OnDocBuildingStep(System.Object,NDoc.Core.ProgressArgs)">
  2138. <summary>
  2139. Represents the method that will be called to update the overall
  2140. percent complete value and the current step name.
  2141. </summary>
  2142. <param name="sender">The source of the event.</param>
  2143. <param name="e">A <see cref="T:NDoc.Core.ProgressArgs"/> that contains the event data.</param>
  2144. </member>
  2145. <member name="M:NAnt.DotNet.Tasks.NDocTask.OnDocBuildingProgress(System.Object,NDoc.Core.ProgressArgs)">
  2146. <summary>
  2147. Represents the method that will be called to update the current
  2148. step's precent complete value.
  2149. </summary>
  2150. <param name="sender">The source of the event.</param>
  2151. <param name="e">A <see cref="T:NDoc.Core.ProgressArgs"/> that contains the event data.</param>
  2152. </member>
  2153. <member name="M:NAnt.DotNet.Tasks.NDocTask.CheckAndGetDocumenter(NDoc.Core.Project,System.String)">
  2154. <summary>
  2155. Returns the documenter for the given project.
  2156. </summary>
  2157. <exception cref="T:NAnt.Core.BuildException">
  2158. Documenter <paramref name="documenterName"/> is not found.
  2159. </exception>
  2160. <exception cref="T:System.ArgumentNullException">
  2161. <paramref name="project"/> is <see langword="null"/>.
  2162. </exception>
  2163. </member>
  2164. <member name="M:NAnt.DotNet.Tasks.NDocTask.ExpandPropertiesInNodes(System.Xml.XmlNodeList)">
  2165. <summary>
  2166. Performs macro expansion for the given nodes.
  2167. </summary>
  2168. <param name="nodes"><see cref="T:System.Xml.XmlNodeList"/> for which expansion should be performed.</param>
  2169. </member>
  2170. <member name="P:NAnt.DotNet.Tasks.NDocTask.Assemblies">
  2171. <summary>
  2172. The set of assemblies to document.
  2173. </summary>
  2174. </member>
  2175. <member name="P:NAnt.DotNet.Tasks.NDocTask.Summaries">
  2176. <summary>
  2177. The set of namespace summary files.
  2178. </summary>
  2179. </member>
  2180. <member name="P:NAnt.DotNet.Tasks.NDocTask.Documenters">
  2181. <summary>
  2182. Specifies the formats in which the documentation should be generated.
  2183. </summary>
  2184. </member>
  2185. <member name="P:NAnt.DotNet.Tasks.NDocTask.ReferencePaths">
  2186. <summary>
  2187. Collection of additional directories to search for referenced
  2188. assemblies.
  2189. </summary>
  2190. </member>
  2191. <member name="T:NAnt.DotNet.Tasks.RegsvcsTask">
  2192. <summary>
  2193. Installs or removes .NET Services.
  2194. </summary>
  2195. <remarks>
  2196. <para>
  2197. This tasks provides the same functionality as the <c>regsvcs</c> tool
  2198. provided in the .NET SDK.
  2199. </para>
  2200. <para>
  2201. It performs the following actions:
  2202. </para>
  2203. <list type="bullet">
  2204. <item>
  2205. <description>Loads and registers an assembly.</description>
  2206. </item>
  2207. <item>
  2208. <description>Generates, registers, and installs a type library into a specified COM+ application.</description>
  2209. </item>
  2210. <item>
  2211. <description>Configures services that are added programmatically to your class.</description>
  2212. </item>
  2213. </list>
  2214. <para>
  2215. Refer to the <see href="ms-help://MS.NETFrameworkSDK/cptools/html/cpgrfnetservicesinstallationutilityregsvcsexe.htm">.NET Services Installation Tool (Regsvcs.exe)</see> for more information.
  2216. </para>
  2217. </remarks>
  2218. <example>
  2219. <para>
  2220. Adds all public classes contained in <c>myTest.dll</c> to a COM+
  2221. application and produces the <c>myTest.tlb</c> type library. If the
  2222. application already exists, it is overwritten.
  2223. </para>
  2224. <code>
  2225. <![CDATA[
  2226. <regsvcs action="FindOrCreate" assembly="myTest.dll" />
  2227. ]]>
  2228. </code>
  2229. </example>
  2230. <example>
  2231. <para>
  2232. Adds all public classes contained in <c>myTest.dll</c> to <c>myTargetApp</c>
  2233. and produces the <c>myTest.tlb</c> type library. If the application already
  2234. exists, it is overwritten.
  2235. </para>
  2236. <code>
  2237. <![CDATA[
  2238. <regsvcs action="FindOrCreate" assembly="myTest.dll" application="myTargetApp" />
  2239. ]]>
  2240. </code>
  2241. </example>
  2242. <example>
  2243. <para>
  2244. Adds all public classes contained in <c>myTest.dll</c> to a COM+
  2245. application and produces the <c>myTest.tlb</c> type library. A new
  2246. application is always created.
  2247. </para>
  2248. <code>
  2249. <![CDATA[
  2250. <regsvcs action="Create" assembly="myTest.dll" />
  2251. ]]>
  2252. </code>
  2253. </example>
  2254. <example>
  2255. <para>
  2256. Uninstalls the COM+ application contained in <c>myTest.dll</c>.
  2257. </para>
  2258. <code>
  2259. <![CDATA[
  2260. <regsvcs action="Uninstall" assembly="myTest.dll" />
  2261. ]]>
  2262. </code>
  2263. </example>
  2264. </member>
  2265. <member name="M:NAnt.DotNet.Tasks.RegsvcsTask.ExecuteTask">
  2266. <summary>
  2267. Performs the specified action.
  2268. </summary>
  2269. </member>
  2270. <member name="P:NAnt.DotNet.Tasks.RegsvcsTask.Action">
  2271. <summary>
  2272. Defines the action to take with the assembly. The default is
  2273. <see cref="F:NAnt.DotNet.Tasks.RegsvcsTask.ActionType.FindOrCreate"/>.
  2274. </summary>
  2275. </member>
  2276. <member name="P:NAnt.DotNet.Tasks.RegsvcsTask.AssemblyFile">
  2277. <summary>
  2278. The source assembly file.
  2279. </summary>
  2280. <remarks>
  2281. The assembly must be signed with a strong name.
  2282. </remarks>
  2283. </member>
  2284. <member name="P:NAnt.DotNet.Tasks.RegsvcsTask.TypeLibrary">
  2285. <summary>
  2286. Specifies the type library file to install.
  2287. </summary>
  2288. </member>
  2289. <member name="P:NAnt.DotNet.Tasks.RegsvcsTask.ExistingTypeLibrary">
  2290. <summary>
  2291. Uses an existing type library. The default is <see langword="false" />.
  2292. </summary>
  2293. </member>
  2294. <member name="P:NAnt.DotNet.Tasks.RegsvcsTask.NoReconfig">
  2295. <summary>
  2296. Do not reconfigure an existing target application.
  2297. The default is <see langword="false" />.
  2298. </summary>
  2299. </member>
  2300. <member name="P:NAnt.DotNet.Tasks.RegsvcsTask.ComponentsOnly">
  2301. <summary>
  2302. Configures components only; ignores methods and interfaces.
  2303. The default is <see langword="false" />.
  2304. </summary>
  2305. </member>
  2306. <member name="P:NAnt.DotNet.Tasks.RegsvcsTask.ExistingApplication">
  2307. <summary>
  2308. Expect an existing application. The default is <see langword="false" />.
  2309. </summary>
  2310. </member>
  2311. <member name="P:NAnt.DotNet.Tasks.RegsvcsTask.ApplicationName">
  2312. <summary>
  2313. Specifies the name of the COM+ application to either find or create.
  2314. </summary>
  2315. </member>
  2316. <member name="P:NAnt.DotNet.Tasks.RegsvcsTask.PartitionName">
  2317. <summary>
  2318. Specifies the name or id of the COM+ application to either find or
  2319. create.
  2320. </summary>
  2321. </member>
  2322. <member name="P:NAnt.DotNet.Tasks.RegsvcsTask.ProgramArguments">
  2323. <summary>
  2324. Gets the command-line arguments for the external program.
  2325. </summary>
  2326. <value>
  2327. The command-line arguments for the external program.
  2328. </value>
  2329. </member>
  2330. <member name="T:NAnt.DotNet.Tasks.RegsvcsTask.ActionType">
  2331. <summary>
  2332. Defines the possible actions for a .NET Service.
  2333. </summary>
  2334. </member>
  2335. <member name="F:NAnt.DotNet.Tasks.RegsvcsTask.ActionType.FindOrCreate">
  2336. <summary>
  2337. Finds or creates the target application.
  2338. </summary>
  2339. </member>
  2340. <member name="F:NAnt.DotNet.Tasks.RegsvcsTask.ActionType.Create">
  2341. <summary>
  2342. Creates the target application.
  2343. </summary>
  2344. </member>
  2345. <member name="F:NAnt.DotNet.Tasks.RegsvcsTask.ActionType.Uninstall">
  2346. <summary>
  2347. Uninstalls the target application.
  2348. </summary>
  2349. </member>
  2350. <member name="T:NAnt.DotNet.Tasks.ResGenTask">
  2351. <summary>
  2352. Converts files from one resource format to another.
  2353. </summary>
  2354. <remarks>
  2355. <note>
  2356. If no <see cref="P:NAnt.DotNet.Tasks.ResGenTask.ToDirectory"/> is specified, the resource file will
  2357. be created next to the input file.
  2358. </note>
  2359. </remarks>
  2360. <example>
  2361. <para>
  2362. Convert a resource file from the <c>.resx</c> to the <c>.resources</c>
  2363. format.
  2364. </para>
  2365. <code>
  2366. <![CDATA[
  2367. <resgen input="translations.resx" output="translations.resources" />
  2368. ]]>
  2369. </code>
  2370. </example>
  2371. <example>
  2372. <para>
  2373. Convert a set of <c>.resx</c> files to the <c>.resources</c> format.
  2374. </para>
  2375. <code>
  2376. <![CDATA[
  2377. <resgen todir=".">
  2378. <resources>
  2379. <include name="*.resx" />
  2380. </resources>
  2381. </resgen>
  2382. ]]>
  2383. </code>
  2384. </example>
  2385. </member>
  2386. <member name="M:NAnt.DotNet.Tasks.ResGenTask.PrepareProcess(System.Diagnostics.Process)">
  2387. <summary>
  2388. Updates the <see cref="T:System.Diagnostics.ProcessStartInfo"/> of the specified
  2389. <see cref="T:System.Diagnostics.Process"/>.
  2390. </summary>
  2391. <param name="process">The <see cref="T:System.Diagnostics.Process"/> of which the <see cref="T:System.Diagnostics.ProcessStartInfo"/> should be updated.</param>
  2392. </member>
  2393. <member name="M:NAnt.DotNet.Tasks.ResGenTask.ExecuteTask">
  2394. <summary>
  2395. Converts a single file or group of files.
  2396. </summary>
  2397. </member>
  2398. <member name="M:NAnt.DotNet.Tasks.ResGenTask.RemoveOutputs">
  2399. <summary>
  2400. Cleans up generated files.
  2401. </summary>
  2402. </member>
  2403. <member name="M:NAnt.DotNet.Tasks.ResGenTask.NeedsCompiling(System.IO.FileInfo,System.IO.FileInfo)">
  2404. <summary>
  2405. Determines whether the specified input file needs to be compiled.
  2406. </summary>
  2407. <param name="inputFile">The input file.</param>
  2408. <param name="outputFile">The output file.</param>
  2409. <returns>
  2410. <see langword="true" /> if the input file need to be compiled;
  2411. otherwise <see langword="false" />.
  2412. </returns>
  2413. </member>
  2414. <member name="M:NAnt.DotNet.Tasks.ResGenTask.GetOutputFile(System.IO.FileInfo)">
  2415. <summary>
  2416. Determines the full path and extension for the output file.
  2417. </summary>
  2418. <param name="file">The output file for which the full path and extension should be determined.</param>
  2419. <returns>
  2420. The full path (with extensions) for the specified file.
  2421. </returns>
  2422. </member>
  2423. <member name="M:NAnt.DotNet.Tasks.ResGenTask.ReferencesThirdPartyAssemblies(System.String)">
  2424. <summary>
  2425. Determines whether the specified resource file references third
  2426. party assemblies by checking whether a &lt;data&gt; element exists
  2427. with a &quot;type&quot; attribute that does not start with
  2428. &quot;System.&quot;.
  2429. </summary>
  2430. <param name="resourceFile">The resource file to check.</param>
  2431. <returns>
  2432. <see langword="true" /> if the resource file references third party
  2433. assemblies, or an error occurred; otherwise, <see langword="false" />.
  2434. </returns>
  2435. <remarks>
  2436. This check will only be accurate for 1.0 resource file, but the
  2437. 2.0 resx files can only be compiled with a resgen tool that supports
  2438. assembly references, so this method will not be used anyway.
  2439. </remarks>
  2440. </member>
  2441. <member name="M:NAnt.DotNet.Tasks.ResGenTask.GetExternalFileReferences(System.IO.FileInfo)">
  2442. <summary>
  2443. Returns a list of external file references for the specified file.
  2444. </summary>
  2445. <param name="resxFile">The resx file for which a list of external file references should be returned.</param>
  2446. <returns>
  2447. A list of external file references for the specified file, or
  2448. <see langword="null" /> if <paramref name="resxFile" /> does not
  2449. exist or does not support external file references.
  2450. </returns>
  2451. </member>
  2452. <member name="P:NAnt.DotNet.Tasks.ResGenTask.InputFile">
  2453. <summary>
  2454. Input file to process.
  2455. </summary>
  2456. <value>
  2457. The full path to the input file.
  2458. </value>
  2459. </member>
  2460. <member name="P:NAnt.DotNet.Tasks.ResGenTask.OutputFile">
  2461. <summary>
  2462. The resource file to output.
  2463. </summary>
  2464. </member>
  2465. <member name="P:NAnt.DotNet.Tasks.ResGenTask.TargetExt">
  2466. <summary>
  2467. The target type. The default is <c>resources</c>.
  2468. </summary>
  2469. </member>
  2470. <member name="P:NAnt.DotNet.Tasks.ResGenTask.ToDirectory">
  2471. <summary>
  2472. The directory to which outputs will be stored.
  2473. </summary>
  2474. </member>
  2475. <member name="P:NAnt.DotNet.Tasks.ResGenTask.UseSourcePath">
  2476. <summary>
  2477. Use each source file's directory as the current directory for
  2478. resolving relative file paths. The default is <see langword="false" />.
  2479. Only supported when targeting .NET 2.0 (or higher).
  2480. </summary>
  2481. </member>
  2482. <member name="P:NAnt.DotNet.Tasks.ResGenTask.Resources">
  2483. <summary>
  2484. Takes a list of <c>.resx</c> or <c>.txt</c> files to convert to <c>.resources</c> files.
  2485. </summary>
  2486. </member>
  2487. <member name="P:NAnt.DotNet.Tasks.ResGenTask.Assemblies">
  2488. <summary>
  2489. Reference metadata from the specified assembly files.
  2490. </summary>
  2491. </member>
  2492. <member name="P:NAnt.DotNet.Tasks.ResGenTask.SupportsAssemblyReferences">
  2493. <summary>
  2494. Indicates whether assembly references are supported by the
  2495. <c>resgen</c> tool for the current target framework. The default
  2496. is <see langword="false" />.
  2497. </summary>
  2498. </member>
  2499. <member name="P:NAnt.DotNet.Tasks.ResGenTask.SupportsExternalFileReferences">
  2500. <summary>
  2501. Indicates whether external file references are supported by the
  2502. <c>resgen</c> tool for the current target framework. The default
  2503. is <see langword="false" />.
  2504. </summary>
  2505. </member>
  2506. <member name="P:NAnt.DotNet.Tasks.ResGenTask.QualifiedResources">
  2507. <summary>
  2508. For internal use only !
  2509. </summary>
  2510. </member>
  2511. <member name="P:NAnt.DotNet.Tasks.ResGenTask.BaseDirectory">
  2512. <summary>
  2513. Gets the working directory for the application.
  2514. </summary>
  2515. <value>
  2516. The working directory for the application.
  2517. </value>
  2518. </member>
  2519. <member name="P:NAnt.DotNet.Tasks.ResGenTask.ProgramArguments">
  2520. <summary>
  2521. Gets the command line arguments for the external program.
  2522. </summary>
  2523. <value>
  2524. The command line arguments for the external program.
  2525. </value>
  2526. </member>
  2527. <member name="P:NAnt.DotNet.Tasks.ResGenTask.ProgramFileName">
  2528. <summary>
  2529. Gets the filename of the external program to start.
  2530. </summary>
  2531. <value>
  2532. The filename of the external program.
  2533. </value>
  2534. <remarks>
  2535. Override in derived classes to explicitly set the location of the
  2536. external tool.
  2537. </remarks>
  2538. </member>
  2539. <member name="T:NAnt.DotNet.Tasks.QualifiedResource">
  2540. <summary>
  2541. For internal use only !
  2542. </summary>
  2543. </member>
  2544. <member name="M:NAnt.DotNet.Tasks.QualifiedResource.#ctor(System.IO.FileInfo,System.IO.FileInfo)">
  2545. <summary>
  2546. Initializes a new instance of the <see cref="T:NAnt.DotNet.Tasks.QualifiedResource"/>
  2547. class for a given input and output file.
  2548. </summary>
  2549. <param name="input">The resource to compile.</param>
  2550. <param name="output">The compiled resource.</param>
  2551. </member>
  2552. <member name="P:NAnt.DotNet.Tasks.QualifiedResource.Input">
  2553. <summary>
  2554. Gets the resource file to compile.
  2555. </summary>
  2556. <value>
  2557. The resource file to compile.
  2558. </value>
  2559. </member>
  2560. <member name="P:NAnt.DotNet.Tasks.QualifiedResource.Output">
  2561. <summary>
  2562. Gets the compiled resource file.
  2563. </summary>
  2564. <value>
  2565. The compiled resource file.
  2566. </value>
  2567. </member>
  2568. <member name="T:NAnt.DotNet.Tasks.ScriptTask">
  2569. <summary>
  2570. Executes the code contained within the task.
  2571. </summary>
  2572. <remarks>
  2573. <h5>Code</h5>
  2574. <para>
  2575. The <see cref="T:NAnt.DotNet.Tasks.ScriptTask"/> must contain a single <c>code</c>
  2576. element, which in turn contains the script code.
  2577. </para>
  2578. <para>
  2579. This code can include extensions such as functions, or tasks. Once
  2580. the script task has executed those extensions will be available for
  2581. use in the buildfile.
  2582. </para>
  2583. <para>
  2584. If no extensions have been defined, a static entry point named
  2585. <c>ScriptMain</c> - which must have a single <see cref="T:NAnt.Core.Project"/>
  2586. argument - is required.
  2587. </para>
  2588. <h5>Namespaces</h5>
  2589. <para>
  2590. The following namespaces are imported by default:
  2591. </para>
  2592. <list type="bullet">
  2593. <item>
  2594. <description>System</description>
  2595. </item>
  2596. <item>
  2597. <description>System.Collections</description>
  2598. </item>
  2599. <item>
  2600. <description>System.IO</description>
  2601. </item>
  2602. <item>
  2603. <description>System.Text</description>
  2604. </item>
  2605. <item>
  2606. <description>NAnt.Core</description>
  2607. </item>
  2608. <item>
  2609. <description>NAnt.Core.Attributes</description>
  2610. </item>
  2611. </list>
  2612. <h5>Assembly References</h5>
  2613. <para>
  2614. The assembly references that are specified will be used to compile
  2615. the script, and will be loaded into the NAnt appdomain.
  2616. </para>
  2617. <para>
  2618. By default, only the <c>NAnt.Core</c> and <c>mscorlib</c> assemblies
  2619. are referenced.
  2620. </para>
  2621. </remarks>
  2622. <example>
  2623. <para>Run C# code that writes a message to the build log.</para>
  2624. <code>
  2625. &lt;script language="C#"&gt;
  2626. &lt;code&gt;
  2627. &lt;![CDATA[
  2628. public static void ScriptMain(Project project) {
  2629. project.Log(Level.Info, "Hello World from a script task using C#");
  2630. }
  2631. ]]&gt;
  2632. &lt;/code&gt;
  2633. &lt;/script&gt;
  2634. </code>
  2635. </example>
  2636. <example>
  2637. <para>Define a custom function and call it using C#.</para>
  2638. <code>
  2639. &lt;script language="C#" prefix="test" &gt;
  2640. &lt;code&gt;
  2641. &lt;![CDATA[
  2642. [Function("test-func")]
  2643. public static string Testfunc( ) {
  2644. return "some result !!!!!!!!";
  2645. }
  2646. ]]&gt;
  2647. &lt;/code&gt;
  2648. &lt;/script&gt;
  2649. &lt;echo message='${test::test-func()}'/&gt;
  2650. </code>
  2651. </example>
  2652. <example>
  2653. <para>Use a custom namespace in C# to create a database</para>
  2654. <code>
  2655. &lt;script language="C#" &gt;
  2656. &lt;references&gt;
  2657. &lt;include name="System.Data.dll" /&gt;
  2658. &lt;/references&gt;
  2659. &lt;imports&gt;
  2660. &lt;import namespace="System.Data.SqlClient" /&gt;
  2661. &lt;/imports&gt;
  2662. &lt;code&gt;
  2663. &lt;![CDATA[
  2664. public static void ScriptMain(Project project) {
  2665. string dbUserName = "nant";
  2666. string dbPassword = "nant";
  2667. string dbServer = "(local)";
  2668. string dbDatabaseName = "NAntSample";
  2669. string connectionString = String.Format("Server={0};uid={1};pwd={2};", dbServer, dbUserName, dbPassword);
  2670. SqlConnection connection = new SqlConnection(connectionString);
  2671. string createDbQuery = "CREATE DATABASE " + dbDatabaseName;
  2672. SqlCommand createDatabaseCommand = new SqlCommand(createDbQuery);
  2673. createDatabaseCommand.Connection = connection;
  2674. connection.Open();
  2675. try {
  2676. createDatabaseCommand.ExecuteNonQuery();
  2677. project.Log(Level.Info, "Database added successfully: " + dbDatabaseName);
  2678. } catch (Exception e) {
  2679. project.Log(Level.Error, e.ToString());
  2680. } finally {
  2681. connection.Close();
  2682. }
  2683. }
  2684. ]]&gt;
  2685. &lt;/code&gt;
  2686. &lt;/script&gt;
  2687. </code>
  2688. </example>
  2689. <example>
  2690. <para>
  2691. Run Visual Basic.NET code that writes a message to the build log.
  2692. </para>
  2693. <code>
  2694. &lt;script language="VB"&gt;
  2695. &lt;code&gt;
  2696. &lt;![CDATA[
  2697. Public Shared Sub ScriptMain(project As Project)
  2698. project.Log(Level.Info, "Hello World from a script task using Visual Basic.NET")
  2699. End Sub
  2700. ]]&gt;
  2701. &lt;/code&gt;
  2702. &lt;/script&gt;
  2703. </code>
  2704. </example>
  2705. <example>
  2706. <para>Define a custom task and call it using C#.</para>
  2707. <code>
  2708. &lt;script language="C#" prefix="test" &gt;
  2709. &lt;code&gt;
  2710. &lt;![CDATA[
  2711. [TaskName("usertask")]
  2712. public class TestTask : Task {
  2713. #region Private Instance Fields
  2714. private string _message;
  2715. #endregion Private Instance Fields
  2716. #region Public Instance Properties
  2717. [TaskAttribute("message", Required=true)]
  2718. public string FileName {
  2719. get { return _message; }
  2720. set { _message = value; }
  2721. }
  2722. #endregion Public Instance Properties
  2723. #region Override implementation of Task
  2724. protected override void ExecuteTask() {
  2725. Log(Level.Info, _message.ToUpper());
  2726. }
  2727. #endregion Override implementation of Task
  2728. }
  2729. ]]&gt;
  2730. &lt;/code&gt;
  2731. &lt;/script&gt;
  2732. &lt;usertask message='Hello from UserTask'/&gt;
  2733. </code>
  2734. </example>
  2735. <example>
  2736. <para>
  2737. Define a custom function and call it using <see href="http://boo.codehaus.org/">Boo</see>.
  2738. </para>
  2739. <code>
  2740. &lt;script language="Boo.CodeDom.BooCodeProvider, Boo.CodeDom, Version=1.0.0.0, Culture=neutral, PublicKeyToken=32c39770e9a21a67"
  2741. failonerror="true"&gt;
  2742. &lt;code&gt;
  2743. &lt;![CDATA[
  2744. [Function("test-func")]
  2745. def MyFunc():
  2746. return "Hello from Boo !!!!!!"
  2747. ]]&gt;
  2748. &lt;/code&gt;
  2749. &lt;/script&gt;
  2750. &lt;echo message='${script::test-func()}'/&gt;
  2751. </code>
  2752. </example>
  2753. </member>
  2754. <member name="M:NAnt.DotNet.Tasks.ScriptTask.Initialize">
  2755. <summary>
  2756. Initializes the task.
  2757. </summary>
  2758. </member>
  2759. <member name="M:NAnt.DotNet.Tasks.ScriptTask.ExecuteTask">
  2760. <summary>
  2761. Executes the script block.
  2762. </summary>
  2763. </member>
  2764. <member name="P:NAnt.DotNet.Tasks.ScriptTask.Language">
  2765. <summary>
  2766. The language of the script block. Possible values are "VB", "vb", "VISUALBASIC", "C#", "c#", "CSHARP".
  2767. "JS", "js", "JSCRIPT" "VJS", "vjs", "JSHARP" or a fully-qualified name for a class implementing
  2768. <see cref="T:System.CodeDom.Compiler.CodeDomProvider"/>.
  2769. </summary>
  2770. </member>
  2771. <member name="P:NAnt.DotNet.Tasks.ScriptTask.References">
  2772. <summary>
  2773. Any required references.
  2774. </summary>
  2775. </member>
  2776. <member name="P:NAnt.DotNet.Tasks.ScriptTask.MainClass">
  2777. <summary>
  2778. The name of the main class containing the static <c>ScriptMain</c>
  2779. entry point.
  2780. </summary>
  2781. </member>
  2782. <member name="P:NAnt.DotNet.Tasks.ScriptTask.Prefix">
  2783. <summary>
  2784. The namespace prefix for any custom functions defined in the script.
  2785. If ommitted the prefix will default to 'script'
  2786. </summary>
  2787. </member>
  2788. <member name="P:NAnt.DotNet.Tasks.ScriptTask.Imports">
  2789. <summary>
  2790. The namespaces to import.
  2791. </summary>
  2792. </member>
  2793. <member name="P:NAnt.DotNet.Tasks.ScriptTask.Code">
  2794. <summary>
  2795. The code to execute.
  2796. </summary>
  2797. </member>
  2798. <member name="T:NAnt.DotNet.Tasks.VbcTask">
  2799. <summary>
  2800. Compiles Visual Basic.NET programs.
  2801. </summary>
  2802. <remarks>
  2803. <note>
  2804. In order to have <see cref="T:NAnt.DotNet.Tasks.VbcTask"/> generate manifest resource names
  2805. that match those generated by Microsoft Visual Studio.NET, the value of
  2806. the <see cref="P:NAnt.DotNet.Types.ResourceFileSet.Prefix"/> attribute of the &lt;<see cref="P:NAnt.DotNet.Tasks.CompilerBase.ResourcesList"/>&gt;
  2807. element should match the "Root namespace" of the VB.NET project, and the
  2808. value of the <see cref="P:NAnt.DotNet.Types.ResourceFileSet.DynamicPrefix"/> attribute
  2809. should be set to "<see langword="false"/>".
  2810. </note>
  2811. </remarks>
  2812. <example>
  2813. <para>Example build file using this task.</para>
  2814. <code>
  2815. <![CDATA[
  2816. <project name="Hello World" default="build" basedir=".">
  2817. <property name="basename" value="HelloWorld" />
  2818. <target name="clean">
  2819. <delete file="${basename}-vb.exe" failonerror="false" />
  2820. <delete file="${basename}-vb.pdb" failonerror="false" />
  2821. </target>
  2822. <target name="build">
  2823. <vbc target="exe" output="${basename}-vb.exe" rootnamespace="${basename}">
  2824. <imports>
  2825. <import namespace="System" />
  2826. <import namespace="System.Data" />
  2827. </imports>
  2828. <sources>
  2829. <include name="${basename}.vb" />
  2830. </sources>
  2831. <resources prefix="${basename}" dynamicprefix="true">
  2832. <include name="**/*.resx" />
  2833. </resources>
  2834. <references>
  2835. <include name="System.dll" />
  2836. <include name="System.Data.dll" />
  2837. </references>
  2838. </vbc>
  2839. </target>
  2840. <target name="rebuild" depends="clean, build" />
  2841. </project>
  2842. ]]>
  2843. </code>
  2844. </example>
  2845. </member>
  2846. <member name="M:NAnt.DotNet.Tasks.VbcTask.GetResourceLinkage(System.String,System.Globalization.CultureInfo)">
  2847. <summary>
  2848. Finds the correct namespace/classname for a resource file from the
  2849. given dependent source file, and ensure the <see cref="P:NAnt.DotNet.Tasks.VbcTask.RootNamespace"/>
  2850. is prefixed.
  2851. </summary>
  2852. <param name="dependentFile">The file from which the resource linkage of the resource file should be determined.</param>
  2853. <param name="resourceCulture">The culture of the resource file for which the resource linkage should be determined.</param>
  2854. <returns>
  2855. The namespace/classname of the source file matching the resource or
  2856. <see langword="null"/> if the dependent source file does not exist.
  2857. </returns>
  2858. </member>
  2859. <member name="M:NAnt.DotNet.Tasks.VbcTask.WriteConditionalCompilationConstants(System.IO.TextWriter)">
  2860. <summary>
  2861. Writes conditional compilation constants to the specified
  2862. <see cref="T:System.IO.TextWriter"/>.
  2863. </summary>
  2864. <param name="writer">The <see cref="T:System.IO.TextWriter"/> to which the conditional compilation constants should be written.</param>
  2865. </member>
  2866. <member name="M:NAnt.DotNet.Tasks.VbcTask.WriteOptions(System.IO.TextWriter)">
  2867. <summary>
  2868. Writes the compiler options to the specified <see cref="T:System.IO.TextWriter"/>.
  2869. </summary>
  2870. <param name="writer"><see cref="T:System.IO.TextWriter"/> to which the compiler options should be written.</param>
  2871. </member>
  2872. <member name="M:NAnt.DotNet.Tasks.VbcTask.NeedsCompiling">
  2873. <summary>
  2874. Determines whether compilation is needed.
  2875. </summary>
  2876. </member>
  2877. <member name="P:NAnt.DotNet.Tasks.VbcTask.BaseAddress">
  2878. <summary>
  2879. The preferred base address at which to load a DLL. The default base
  2880. address for a DLL is set by the .NET Framework common language
  2881. runtime.
  2882. </summary>
  2883. <value>
  2884. The preferred base address at which to load a DLL.
  2885. </value>
  2886. <remarks>
  2887. This address must be specified as a hexadecimal number.
  2888. </remarks>
  2889. </member>
  2890. <member name="P:NAnt.DotNet.Tasks.VbcTask.DebugOutput">
  2891. <summary>
  2892. Specifies the type of debugging information generated by the
  2893. compiler. The default is <see cref="F:NAnt.DotNet.Types.DebugOutput.None"/>.
  2894. </summary>
  2895. </member>
  2896. <member name="P:NAnt.DotNet.Tasks.VbcTask.Debug">
  2897. <summary>
  2898. No longer expose this to build authors. Use <see cref="P:NAnt.DotNet.Tasks.VbcTask.DebugOutput"/>
  2899. instead.
  2900. </summary>
  2901. </member>
  2902. <member name="P:NAnt.DotNet.Tasks.VbcTask.DocFile">
  2903. <summary>
  2904. The name of the XML documentation file to generate. Only supported
  2905. when targeting .NET 2.0 (or higher).
  2906. </summary>
  2907. <remarks>
  2908. <para>
  2909. Corresponds with the <c>/doc:</c> flag.
  2910. </para>
  2911. </remarks>
  2912. </member>
  2913. <member name="P:NAnt.DotNet.Tasks.VbcTask.ImportsString">
  2914. <summary>
  2915. Specifies whether the <c>/imports</c> option gets passed to the
  2916. compiler.
  2917. </summary>
  2918. <value>
  2919. The value of this attribute is a string that contains one or more
  2920. namespaces separated by commas.
  2921. </value>
  2922. <remarks>
  2923. <a href="ms-help://MS.NETFrameworkSDK/vblr7net/html/valrfImportImportNamespaceFromSpecifiedAssembly.htm">See the Microsoft.NET Framework SDK documentation for details.</a>
  2924. </remarks>
  2925. <example>Example of an imports attribute
  2926. <code><![CDATA[imports="Microsoft.VisualBasic, System, System.Collections, System.Data, System.Diagnostics"]]></code>
  2927. </example>
  2928. </member>
  2929. <member name="P:NAnt.DotNet.Tasks.VbcTask.Imports">
  2930. <summary>
  2931. The namespaces to import.
  2932. </summary>
  2933. </member>
  2934. <member name="P:NAnt.DotNet.Tasks.VbcTask.NoStdLib">
  2935. <summary>
  2936. Instructs the compiler not to reference standard libraries
  2937. (system.dll and VBC.RSP). The default is <see langword="false" />.
  2938. Only supported when targeting .NET 2.0 (or higher).
  2939. </summary>
  2940. <remarks>
  2941. <para>
  2942. Corresponds with the <c>/nostdlib</c> flag.
  2943. </para>
  2944. </remarks>
  2945. </member>
  2946. <member name="P:NAnt.DotNet.Tasks.VbcTask.OptionCompare">
  2947. <summary>
  2948. Specifies whether <c>/optioncompare</c> option gets passed to the
  2949. compiler.
  2950. </summary>
  2951. <value>
  2952. <c>text</c>, <c>binary</c>, or an empty string. If the value is
  2953. <see langword="false" /> or an empty string, the option will not be
  2954. passed to the compiler.
  2955. </value>
  2956. <remarks><a href="ms-help://MS.NETFrameworkSDK/vblr7net/html/valrfOptioncompareSpecifyHowStringsAreCompared.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
  2957. </member>
  2958. <member name="P:NAnt.DotNet.Tasks.VbcTask.OptionExplicit">
  2959. <summary>
  2960. Specifies whether the <c>/optionexplicit</c> option gets passed to
  2961. the compiler. The default is <see langword="false" />.
  2962. </summary>
  2963. <value>
  2964. <see langword="true" /> if the option should be passed to the compiler;
  2965. otherwise, <see langword="false" />.
  2966. </value>
  2967. <remarks><a href="ms-help://MS.NETFrameworkSDK/vblr7net/html/valrfOptionexplicitRequireExplicitDeclarationOfVariables.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
  2968. </member>
  2969. <member name="P:NAnt.DotNet.Tasks.VbcTask.OptionOptimize">
  2970. <summary>
  2971. Specifies whether the <c>/optimize</c> option gets passed to the
  2972. compiler. The default is <see langword="false" />.
  2973. </summary>
  2974. <value>
  2975. <see langword="true" /> if the option should be passed to the compiler;
  2976. otherwise, <see langword="false" />.
  2977. </value>
  2978. <remarks><a href="ms-help://MS.NETFrameworkSDK/vblr7net/html/valrfoptimizeenabledisableoptimizations.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
  2979. </member>
  2980. <member name="P:NAnt.DotNet.Tasks.VbcTask.OptionStrict">
  2981. <summary>
  2982. Specifies whether the <c>/optionstrict</c> option gets passed to
  2983. the compiler. The default is <see langword="false" />.
  2984. </summary>
  2985. <value>
  2986. <see langword="true" /> if the option should be passed to the compiler;
  2987. otherwise, <see langword="false" />.
  2988. </value>
  2989. <remarks><a href="ms-help://MS.NETFrameworkSDK/vblr7net/html/valrfOptionstrictEnforceStrictTypeSemantics.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
  2990. </member>
  2991. <member name="P:NAnt.DotNet.Tasks.VbcTask.Platform">
  2992. <summary>
  2993. Specifies which platform version of common language runtime (CLR)
  2994. can run the output file.
  2995. </summary>
  2996. <value>
  2997. The platform version of common language runtime (CLR) that can run
  2998. the output file.
  2999. </value>
  3000. <remarks>
  3001. <para>
  3002. Corresponds with the <c>/platform</c> flag.
  3003. </para>
  3004. </remarks>
  3005. </member>
  3006. <member name="P:NAnt.DotNet.Tasks.VbcTask.RemoveIntChecks">
  3007. <summary>
  3008. Specifies whether the <c>/removeintchecks</c> option gets passed to
  3009. the compiler. The default is <see langword="false" />.
  3010. </summary>
  3011. <value>
  3012. <see langword="true" /> if the option should be passed to the compiler;
  3013. otherwise, <see langword="false" />.
  3014. </value>
  3015. <remarks><a href="ms-help://MS.NETFrameworkSDK/vblr7net/html/valrfRemoveintchecksRemoveInteger-OverflowChecks.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
  3016. </member>
  3017. <member name="P:NAnt.DotNet.Tasks.VbcTask.RootNamespace">
  3018. <summary>
  3019. Specifies whether the <c>/rootnamespace</c> option gets passed to
  3020. the compiler.
  3021. </summary>
  3022. <value>
  3023. The value of this attribute is a string that contains the root
  3024. namespace of the project.
  3025. </value>
  3026. <remarks><a href="ms-help://MS.NETFrameworkSDK/vblr7net/html/valrfRootnamespace.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
  3027. </member>
  3028. <member name="P:NAnt.DotNet.Tasks.VbcTask.SupportsDocGeneration">
  3029. <summary>
  3030. Specifies whether the compiler for the active target framework
  3031. supports generation of XML Documentation file. The default is
  3032. <see langword="false" />.
  3033. </summary>
  3034. </member>
  3035. <member name="P:NAnt.DotNet.Tasks.VbcTask.SupportsNoStdLib">
  3036. <summary>
  3037. Specifies whether the compiler for the active target framework
  3038. supports NOT referencing standard libraries (system.dll and VBC.RSP).
  3039. The default is <see langword="false" />.
  3040. </summary>
  3041. </member>
  3042. <member name="P:NAnt.DotNet.Tasks.VbcTask.SupportsPlatform">
  3043. <summary>
  3044. Specifies whether the compiler for the active target framework
  3045. supports limiting the platform on which the compiled code can run.
  3046. The default is <see langword="false" />.
  3047. </summary>
  3048. </member>
  3049. <member name="P:NAnt.DotNet.Tasks.VbcTask.Extension">
  3050. <summary>
  3051. Gets the file extension required by the current compiler.
  3052. </summary>
  3053. <value>
  3054. For the VB.NET compiler, the file extension is always <c>vb</c>.
  3055. </value>
  3056. </member>
  3057. <member name="P:NAnt.DotNet.Tasks.VbcTask.ClassNameRegex">
  3058. <summary>
  3059. Gets the class name regular expression for the language of the
  3060. current compiler.
  3061. </summary>
  3062. <value>
  3063. Class name regular expression for the language of the current
  3064. compiler.
  3065. </value>
  3066. </member>
  3067. <member name="P:NAnt.DotNet.Tasks.VbcTask.NamespaceRegex">
  3068. <summary>
  3069. Gets the namespace regular expression for the language of the
  3070. current compiler.
  3071. </summary>
  3072. <value>
  3073. Namespace regular expression for the language of the current
  3074. compiler.
  3075. </value>
  3076. </member>
  3077. <member name="T:NAnt.DotNet.Tasks.VjcTask">
  3078. <summary>
  3079. Compiles Visual J# programs using vjc, Microsoft's J# compiler.
  3080. </summary>
  3081. <remarks>
  3082. <note>
  3083. In order to have <see cref="T:NAnt.DotNet.Tasks.VjcTask"/> generate manifest resource names
  3084. that match those generated by Microsoft Visual Studio.NET, the value of
  3085. the <see cref="P:NAnt.DotNet.Types.ResourceFileSet.Prefix"/> attribute of the &lt;<see cref="P:NAnt.DotNet.Tasks.CompilerBase.ResourcesList"/>&gt;
  3086. element should match the "Default Package" of the J#.NET project, and
  3087. the value of the <see cref="P:NAnt.DotNet.Types.ResourceFileSet.DynamicPrefix"/> attribute
  3088. should be set to "<see langword="true"/>".
  3089. </note>
  3090. </remarks>
  3091. <example>
  3092. <para>Compile a "HelloWorld" application, including embedded resources.</para>
  3093. <code>
  3094. <![CDATA[
  3095. <vjc target="exe" output="helloworld.exe" debug="true">
  3096. <sources>
  3097. <include name="helloworld.jsl" />
  3098. </sources>
  3099. <resources prefix="HelloWorld" dynamicprefix="true">
  3100. <include name="**/*.resx" />
  3101. </resources>
  3102. <references>
  3103. <include name="System.dll" />
  3104. <include name="System.Data.dll" />
  3105. <include name="System.Drawing.dll" />
  3106. <include name="System.Windows.Forms.dll" />
  3107. <include name="System.Xml.dll" />
  3108. </references>
  3109. </vjc>
  3110. ]]>
  3111. </code>
  3112. </example>
  3113. </member>
  3114. <member name="M:NAnt.DotNet.Tasks.VjcTask.WriteModuleReferences(System.IO.TextWriter)">
  3115. <summary>
  3116. Writes module references to the specified <see cref="T:System.IO.TextWriter"/>.
  3117. </summary>
  3118. <param name="writer">The <see cref="T:System.IO.TextWriter"/> to which the module references should be written.</param>
  3119. </member>
  3120. <member name="M:NAnt.DotNet.Tasks.VjcTask.WriteOptions(System.IO.TextWriter)">
  3121. <summary>
  3122. Writes the compiler options to the specified <see cref="T:System.IO.TextWriter"/>.
  3123. </summary>
  3124. <param name="writer"><see cref="T:System.IO.TextWriter"/> to which the compiler options should be written.</param>
  3125. </member>
  3126. <member name="P:NAnt.DotNet.Tasks.VjcTask.BaseAddress">
  3127. <summary>
  3128. The preferred base address at which to load a DLL. The default base
  3129. address for a DLL is set by the .NET Framework common language
  3130. runtime.
  3131. </summary>
  3132. <value>
  3133. The preferred base address at which to load a DLL.
  3134. </value>
  3135. <remarks>
  3136. This address can be specified as a decimal, hexadecimal, or octal
  3137. number.
  3138. </remarks>
  3139. </member>
  3140. <member name="P:NAnt.DotNet.Tasks.VjcTask.DebugOutput">
  3141. <summary>
  3142. Specifies the type of debugging information generated by the
  3143. compiler. The default is <see cref="F:NAnt.DotNet.Types.DebugOutput.None"/>.
  3144. </summary>
  3145. </member>
  3146. <member name="P:NAnt.DotNet.Tasks.VjcTask.Debug">
  3147. <summary>
  3148. No longer expose this to build authors. Use <see cref="P:NAnt.DotNet.Tasks.VjcTask.DebugOutput"/>
  3149. instead.
  3150. </summary>
  3151. </member>
  3152. <member name="P:NAnt.DotNet.Tasks.VjcTask.SecureScoping">
  3153. <summary>
  3154. Specifies whether package-scoped members are accessible outside of
  3155. the assembly. In other words, package scope is treated as assembly
  3156. scope when emitting metadata. The default is <see langword="false" />.
  3157. </summary>
  3158. <value>
  3159. <see langword="true" /> if the option should be passed to the compiler;
  3160. otherwise, <see langword="false" />.
  3161. </value>
  3162. <remarks>
  3163. <para>
  3164. Corresponds to the <c>/securescoping</c> flag.
  3165. </para>
  3166. <para>
  3167. <a href="ms-help://MS.VSCC/MS.VJSharp/dv_vjsharp/html/vjgrfsecurescopingmakepackage-scopedmembersinaccessibleoutsideassembly.htm">See the Visual J# Reference for details.</a>
  3168. </para>
  3169. </remarks>
  3170. <example>
  3171. <code><![CDATA[<vjc securescoping='true'/>]]></code>
  3172. </example>
  3173. </member>
  3174. <member name="P:NAnt.DotNet.Tasks.VjcTask.X">
  3175. <summary>
  3176. Specifies whether to disable language extensions.
  3177. </summary>
  3178. <value>
  3179. The value of this property must be either <c>all</c>, <c>net</c>,
  3180. or an empty string.
  3181. </value>
  3182. <remarks>
  3183. <para>
  3184. Corresponds to the <c>/x</c> flag.
  3185. </para>
  3186. <para>
  3187. <a href="ms-help://MS.VSCC/MS.VJSharp/dv_vjsharp/html/vjgrfxdisablelanguageextensions.htm">See the Visual J# Reference for details.</a>
  3188. </para>
  3189. </remarks>
  3190. <example>
  3191. <para>To disable only the .NET Framework extensions:<c><![CDATA[
  3192. <vjc x='net'/>
  3193. ]]></c></para>
  3194. <para>To disable the .NET Framework extensions and the VJ++ 6.0 extensions:<c><![CDATA[
  3195. <vjc x='all'/>
  3196. ]]></c></para>
  3197. </example>
  3198. </member>
  3199. <member name="P:NAnt.DotNet.Tasks.VjcTask.LibPath">
  3200. <summary>
  3201. Specifies the location of assemblies referenced by way of the <c>/reference</c> flag.
  3202. </summary>
  3203. <remarks>
  3204. <para>
  3205. Corresponds to the <c>/libpath:dir[;dir2]</c> flag.
  3206. </para>
  3207. <para>
  3208. <a href="ms-help://MS.VSCC/MS.VJSharp/dv_vjsharp/html/vjgrflibpathspecifyassemblyreferencelocations.htm">See the Visual J# Reference for details.</a>
  3209. </para>
  3210. </remarks>
  3211. </member>
  3212. <member name="P:NAnt.DotNet.Tasks.VjcTask.Jcpa">
  3213. <summary>
  3214. Associate Java-language/COM package names.
  3215. </summary>
  3216. <value>
  3217. The value of this propery. must be <c>package=namespace</c>, <c>@filename</c>,
  3218. or an empty string.
  3219. </value>
  3220. <remarks>
  3221. <para>
  3222. Corresponds to the <c>/jcpa:package=namespace</c> and <c>/jcpa:@filename</c> flags.
  3223. </para>
  3224. <para>
  3225. <a href="ms-help://MS.VSCC/MS.VJSharp/dv_vjsharp/html/vjgrfjcpaassociatejava-compackages.htm">See the Visual J# Reference for details.</a>
  3226. </para>
  3227. </remarks>
  3228. <example>
  3229. <para>Map package 'x' to namespace 'y':<c><![CDATA[
  3230. <vjc jcpa='x=y'/>
  3231. ]]></c></para>
  3232. </example>
  3233. </member>
  3234. <member name="P:NAnt.DotNet.Tasks.VjcTask.Codepage">
  3235. <summary>
  3236. Specifies the code page to use for all source code files in the
  3237. compilation.
  3238. </summary>
  3239. <remarks>
  3240. <para>
  3241. Corresponds with the <c>/codepage</c> flag.
  3242. </para>
  3243. <para>
  3244. <a href="ms-help://MS.VSCC/MS.VJSharp/dv_vjsharp/html/vjlrfcodepagespecifycodepageforsourcecodefiles.htm">See the Visual J# Reference for details.</a>
  3245. </para>
  3246. </remarks>
  3247. </member>
  3248. <member name="P:NAnt.DotNet.Tasks.VjcTask.WarningLevel">
  3249. <summary>
  3250. Specifies the warning level for the compiler to display. Valid values
  3251. are <c>0</c>-<c>4</c>. The default is <c>4</c>.
  3252. </summary>
  3253. <value>
  3254. The warning level for the compiler to display.
  3255. </value>
  3256. <remarks>
  3257. <para>
  3258. Corresponds with the <c>/warn</c> option.
  3259. </para>
  3260. </remarks>
  3261. </member>
  3262. <member name="P:NAnt.DotNet.Tasks.VjcTask.WarningAsError">
  3263. <summary>
  3264. Controls which warnings should be reported as errors.
  3265. </summary>
  3266. <remarks>
  3267. Override to avoid exposing this to build authors, as the Visual J#
  3268. compiler does not allow control over which warnings should be
  3269. reported as errors.
  3270. </remarks>
  3271. </member>
  3272. <member name="P:NAnt.DotNet.Tasks.VjcTask.Packages">
  3273. <summary>
  3274. Reference packages
  3275. </summary>
  3276. <remarks>
  3277. Override to avoid exposing this to build authors, as the Visual J#
  3278. compiler does not support package references.
  3279. </remarks>
  3280. </member>
  3281. <member name="P:NAnt.DotNet.Tasks.VjcTask.Modules">
  3282. <summary>
  3283. Link the specified modules into this assembly.
  3284. </summary>
  3285. <remarks>
  3286. Override to avoid exposing this to build authors, as the Visual J#
  3287. compiler does not support linking modules.
  3288. </remarks>
  3289. </member>
  3290. <member name="P:NAnt.DotNet.Tasks.VjcTask.Extension">
  3291. <summary>
  3292. Gets the file extension required by the current compiler.
  3293. </summary>
  3294. <value>
  3295. For the J# compiler, the file extension is always <c>jsl</c>.
  3296. </value>
  3297. </member>
  3298. <member name="P:NAnt.DotNet.Tasks.VjcTask.ClassNameRegex">
  3299. <summary>
  3300. Gets the class name regular expression for the language of the
  3301. current compiler.
  3302. </summary>
  3303. <value>
  3304. Class name regular expression for the language of the current
  3305. compiler.
  3306. </value>
  3307. </member>
  3308. <member name="P:NAnt.DotNet.Tasks.VjcTask.NamespaceRegex">
  3309. <summary>
  3310. Gets the namespace regular expression for the language of the
  3311. current compiler.
  3312. </summary>
  3313. <value>
  3314. Namespace regular expression for the language of the current
  3315. compiler.
  3316. </value>
  3317. </member>
  3318. <member name="P:NAnt.DotNet.Tasks.VjcTask.SupportsPackageReferences">
  3319. <summary>
  3320. Override to avoid exposing the configuration setting for this
  3321. task as Visual J# will never support package references.
  3322. </summary>
  3323. <value>
  3324. <see langword="false" />, as the Visual J# compiler will never
  3325. support package references.
  3326. </value>
  3327. </member>
  3328. <member name="T:NAnt.DotNet.Types.AssemblyAttribute">
  3329. <summary>
  3330. Represents an assembly-level attribute.
  3331. </summary>
  3332. </member>
  3333. <member name="M:NAnt.DotNet.Types.AssemblyAttribute.#ctor">
  3334. <summary>
  3335. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/>
  3336. class.
  3337. </summary>
  3338. </member>
  3339. <member name="P:NAnt.DotNet.Types.AssemblyAttribute.TypeName">
  3340. <summary>
  3341. Typename of the assembly-level attribute.
  3342. </summary>
  3343. </member>
  3344. <member name="P:NAnt.DotNet.Types.AssemblyAttribute.Value">
  3345. <summary>
  3346. Value of the attribute.
  3347. </summary>
  3348. </member>
  3349. <member name="P:NAnt.DotNet.Types.AssemblyAttribute.AsIs">
  3350. <summary>
  3351. If <see langword="true" /> then the value of the attribute will be
  3352. set as is, without actually looking for a matching constructor or
  3353. named properties. The default is <see langword="false" />.
  3354. </summary>
  3355. <value>
  3356. <see langword="true" /> if the value of the attribute should be set
  3357. as is; otherwise, <see langword="false" />.
  3358. </value>
  3359. </member>
  3360. <member name="P:NAnt.DotNet.Types.AssemblyAttribute.IfDefined">
  3361. <summary>
  3362. Indicates if the attribute should be generated.
  3363. </summary>
  3364. <value>
  3365. <see langword="true" /> if the attribute should be generated;
  3366. otherwise, <see langword="false" />.
  3367. </value>
  3368. </member>
  3369. <member name="P:NAnt.DotNet.Types.AssemblyAttribute.UnlessDefined">
  3370. <summary>
  3371. Indicates if the attribute should be not generated.
  3372. </summary>
  3373. <value>
  3374. <see langword="true" /> if the attribute should be not generated;
  3375. otherwise, <see langword="false" />.
  3376. </value>
  3377. </member>
  3378. <member name="T:NAnt.DotNet.Types.AssemblyAttributeCollection">
  3379. <summary>
  3380. Contains a strongly typed collection of <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/>
  3381. objects.
  3382. </summary>
  3383. </member>
  3384. <member name="M:NAnt.DotNet.Types.AssemblyAttributeCollection.#ctor">
  3385. <summary>
  3386. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.AssemblyAttributeCollection"/> class.
  3387. </summary>
  3388. </member>
  3389. <member name="M:NAnt.DotNet.Types.AssemblyAttributeCollection.#ctor(NAnt.DotNet.Types.AssemblyAttributeCollection)">
  3390. <summary>
  3391. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.AssemblyAttributeCollection"/> class
  3392. with the specified <see cref="T:NAnt.DotNet.Types.AssemblyAttributeCollection"/> instance.
  3393. </summary>
  3394. </member>
  3395. <member name="M:NAnt.DotNet.Types.AssemblyAttributeCollection.#ctor(NAnt.DotNet.Types.AssemblyAttribute[])">
  3396. <summary>
  3397. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.AssemblyAttributeCollection"/> class
  3398. with the specified array of <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> instances.
  3399. </summary>
  3400. </member>
  3401. <member name="M:NAnt.DotNet.Types.AssemblyAttributeCollection.Add(NAnt.DotNet.Types.AssemblyAttribute)">
  3402. <summary>
  3403. Adds a <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> to the end of the collection.
  3404. </summary>
  3405. <param name="item">The <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> to be added to the end of the collection.</param>
  3406. <returns>The position into which the new element was inserted.</returns>
  3407. </member>
  3408. <member name="M:NAnt.DotNet.Types.AssemblyAttributeCollection.AddRange(NAnt.DotNet.Types.AssemblyAttribute[])">
  3409. <summary>
  3410. Adds the elements of a <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> array to the end of the collection.
  3411. </summary>
  3412. <param name="items">The array of <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> elements to be added to the end of the collection.</param>
  3413. </member>
  3414. <member name="M:NAnt.DotNet.Types.AssemblyAttributeCollection.AddRange(NAnt.DotNet.Types.AssemblyAttributeCollection)">
  3415. <summary>
  3416. Adds the elements of a <see cref="T:NAnt.DotNet.Types.AssemblyAttributeCollection"/> to the end of the collection.
  3417. </summary>
  3418. <param name="items">The <see cref="T:NAnt.DotNet.Types.AssemblyAttributeCollection"/> to be added to the end of the collection.</param>
  3419. </member>
  3420. <member name="M:NAnt.DotNet.Types.AssemblyAttributeCollection.Contains(NAnt.DotNet.Types.AssemblyAttribute)">
  3421. <summary>
  3422. Determines whether a <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> is in the collection.
  3423. </summary>
  3424. <param name="item">The <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> to locate in the collection.</param>
  3425. <returns>
  3426. <see langword="true"/> if <paramref name="item"/> is found in the
  3427. collection; otherwise, <see langword="false"/>.
  3428. </returns>
  3429. </member>
  3430. <member name="M:NAnt.DotNet.Types.AssemblyAttributeCollection.Contains(System.String)">
  3431. <summary>
  3432. Determines whether a <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> with the specified
  3433. value is in the collection.
  3434. </summary>
  3435. <param name="value">The argument value to locate in the collection.</param>
  3436. <returns>
  3437. <see langword="true"/> if a <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> with
  3438. value <paramref name="value"/> is found in the collection; otherwise,
  3439. <see langword="false"/>.
  3440. </returns>
  3441. </member>
  3442. <member name="M:NAnt.DotNet.Types.AssemblyAttributeCollection.CopyTo(NAnt.DotNet.Types.AssemblyAttribute[],System.Int32)">
  3443. <summary>
  3444. Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
  3445. </summary>
  3446. <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
  3447. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  3448. </member>
  3449. <member name="M:NAnt.DotNet.Types.AssemblyAttributeCollection.IndexOf(NAnt.DotNet.Types.AssemblyAttribute)">
  3450. <summary>
  3451. Retrieves the index of a specified <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> object in the collection.
  3452. </summary>
  3453. <param name="item">The <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> object for which the index is returned.</param>
  3454. <returns>
  3455. The index of the specified <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/>. If the <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> is not currently a member of the collection, it returns -1.
  3456. </returns>
  3457. </member>
  3458. <member name="M:NAnt.DotNet.Types.AssemblyAttributeCollection.Insert(System.Int32,NAnt.DotNet.Types.AssemblyAttribute)">
  3459. <summary>
  3460. Inserts a <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> into the collection at the specified index.
  3461. </summary>
  3462. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  3463. <param name="item">The <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> to insert.</param>
  3464. </member>
  3465. <member name="M:NAnt.DotNet.Types.AssemblyAttributeCollection.GetEnumerator">
  3466. <summary>
  3467. Returns an enumerator that can iterate through the collection.
  3468. </summary>
  3469. <returns>
  3470. A <see cref="T:NAnt.DotNet.Types.AssemblyAttributeEnumerator"/> for the entire collection.
  3471. </returns>
  3472. </member>
  3473. <member name="M:NAnt.DotNet.Types.AssemblyAttributeCollection.Remove(NAnt.DotNet.Types.AssemblyAttribute)">
  3474. <summary>
  3475. Removes a member from the collection.
  3476. </summary>
  3477. <param name="item">The <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> to remove from the collection.</param>
  3478. </member>
  3479. <member name="P:NAnt.DotNet.Types.AssemblyAttributeCollection.Item(System.Int32)">
  3480. <summary>
  3481. Gets or sets the element at the specified index.
  3482. </summary>
  3483. <param name="index">The zero-based index of the element to get or set.</param>
  3484. </member>
  3485. <member name="P:NAnt.DotNet.Types.AssemblyAttributeCollection.Item(System.String)">
  3486. <summary>
  3487. Gets the <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> with the specified value.
  3488. </summary>
  3489. <param name="value">The value of the <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> to get.</param>
  3490. </member>
  3491. <member name="T:NAnt.DotNet.Types.AssemblyAttributeEnumerator">
  3492. <summary>
  3493. Enumerates the <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> elements of a <see cref="T:NAnt.DotNet.Types.AssemblyAttributeCollection"/>.
  3494. </summary>
  3495. </member>
  3496. <member name="M:NAnt.DotNet.Types.AssemblyAttributeEnumerator.#ctor(NAnt.DotNet.Types.AssemblyAttributeCollection)">
  3497. <summary>
  3498. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.AssemblyAttributeEnumerator"/> class
  3499. with the specified <see cref="T:NAnt.DotNet.Types.AssemblyAttributeCollection"/>.
  3500. </summary>
  3501. <param name="arguments">The collection that should be enumerated.</param>
  3502. </member>
  3503. <member name="M:NAnt.DotNet.Types.AssemblyAttributeEnumerator.MoveNext">
  3504. <summary>
  3505. Advances the enumerator to the next element of the collection.
  3506. </summary>
  3507. <returns>
  3508. <see langword="true" /> if the enumerator was successfully advanced
  3509. to the next element; <see langword="false" /> if the enumerator has
  3510. passed the end of the collection.
  3511. </returns>
  3512. </member>
  3513. <member name="M:NAnt.DotNet.Types.AssemblyAttributeEnumerator.Reset">
  3514. <summary>
  3515. Sets the enumerator to its initial position, which is before the
  3516. first element in the collection.
  3517. </summary>
  3518. </member>
  3519. <member name="P:NAnt.DotNet.Types.AssemblyAttributeEnumerator.Current">
  3520. <summary>
  3521. Gets the current element in the collection.
  3522. </summary>
  3523. <returns>
  3524. The current element in the collection.
  3525. </returns>
  3526. </member>
  3527. <member name="T:NAnt.DotNet.Types.LibDirectorySet">
  3528. <summary>
  3529. A specialized <see cref="T:NAnt.Core.Types.FileSet"/> used for setting the lib directories.
  3530. </summary>
  3531. <remarks>
  3532. The primary reason for this class is to allow the <see cref="P:NAnt.DotNet.Types.LibDirectorySet.BaseDirectory"/>
  3533. to always be the same value as the parent <see cref="T:NAnt.DotNet.Types.AssemblyFileSet"/>
  3534. </remarks>
  3535. <seealso cref="T:NAnt.Core.Types.FileSet"/>
  3536. </member>
  3537. <member name="M:NAnt.DotNet.Types.LibDirectorySet.#ctor(NAnt.DotNet.Types.AssemblyFileSet)">
  3538. <summary>
  3539. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.LibDirectorySet"/> class.
  3540. </summary>
  3541. <param name="parent"></param>
  3542. </member>
  3543. <member name="P:NAnt.DotNet.Types.LibDirectorySet.BaseDirectory">
  3544. <summary>
  3545. override this. We will always use the base directory of the parent.
  3546. overriding without the TaskAttribute attribute prevents it being set
  3547. in the source xml
  3548. </summary>
  3549. </member>
  3550. <member name="T:NAnt.DotNet.Types.AssemblyFileSet">
  3551. <summary>
  3552. Specialized <see cref="T:NAnt.Core.Types.FileSet"/> class for managing assembly files.
  3553. </summary>
  3554. <remarks>
  3555. <para>
  3556. If an include pattern does not contain any wildcard characters then
  3557. the assembly will be searched for in following locations (in the order listed):
  3558. </para>
  3559. <list type="bullet">
  3560. <item>
  3561. <description>
  3562. The base directory of the fileset.
  3563. </description>
  3564. </item>
  3565. <item>
  3566. <description>
  3567. The directories specified using the nested &lt;lib&gt; element.
  3568. </description>
  3569. </item>
  3570. <item>
  3571. <description>
  3572. The list of reference assemblies of the current target framework.
  3573. </description>
  3574. </item>
  3575. </list>
  3576. <para>
  3577. The reference assemblies of a given target framework are defined using
  3578. &lt;reference-assemblies&gt; filesets in the &lt;framework&gt; node
  3579. of the NAnt configuration file.
  3580. </para>
  3581. </remarks>
  3582. <example>
  3583. <para>
  3584. Define a reference with name "sys.assemblies", holding
  3585. a set of system assemblies.
  3586. </para>
  3587. <code>
  3588. <![CDATA[
  3589. <assemblyfileset id="sys.assemblies">
  3590. <include name="System.dll" />
  3591. <include name="System.Data.dll" />
  3592. <include name="System.Xml.dll" />
  3593. </assemblyfileset>
  3594. ]]>
  3595. </code>
  3596. <para>
  3597. Use the predefined set of assemblies to compile a C# assembly.
  3598. </para>
  3599. <code>
  3600. <![CDATA[
  3601. <csc target="exe" output="HelloWorld.exe">
  3602. <sources>
  3603. <include name="**/*.cs" />
  3604. </sources>
  3605. <references refid="sys.assemblies" />
  3606. </csc>
  3607. ]]>
  3608. </code>
  3609. </example>
  3610. <example>
  3611. <para>
  3612. Compile a C# assembly using assembly references that are searched for
  3613. in the "Third Party Assemblies" and "Company Assemblies"
  3614. directories.
  3615. </para>
  3616. <code>
  3617. <![CDATA[
  3618. <csc target="exe" output="HelloWorld.exe">
  3619. <sources>
  3620. <include name="**/*.cs" />
  3621. </sources>
  3622. <references>
  3623. <lib>
  3624. <include name="Third Party Assemblies" />
  3625. <include name="Company Assemblies" />
  3626. </lib>
  3627. <include name="log4net.dll" />
  3628. <include name="Company.Business.dll" />
  3629. </references>
  3630. </csc>
  3631. ]]>
  3632. </code>
  3633. </example>
  3634. <seealso cref="T:NAnt.Core.Types.FileSet"/>
  3635. </member>
  3636. <member name="M:NAnt.DotNet.Types.AssemblyFileSet.#ctor">
  3637. <summary>
  3638. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.AssemblyFileSet"/> class.
  3639. </summary>
  3640. </member>
  3641. <member name="M:NAnt.DotNet.Types.AssemblyFileSet.#ctor(NAnt.Core.Types.FileSet)">
  3642. <summary>
  3643. copy constructor for FileSet. Required in order to
  3644. assign references of FileSet type where
  3645. AssemblyFileSets are used
  3646. </summary>
  3647. <param name="fs"></param>
  3648. </member>
  3649. <member name="M:NAnt.DotNet.Types.AssemblyFileSet.Scan">
  3650. <summary>
  3651. Do a normal scan and then resolve assemblies.
  3652. </summary>
  3653. </member>
  3654. <member name="M:NAnt.DotNet.Types.AssemblyFileSet.ResolveReferences">
  3655. <summary>
  3656. Resolves references to system assemblies and assemblies that can be
  3657. resolved using directories specified in <see cref="P:NAnt.DotNet.Types.AssemblyFileSet.Lib"/>.
  3658. </summary>
  3659. </member>
  3660. <member name="P:NAnt.DotNet.Types.AssemblyFileSet.Lib">
  3661. <summary>
  3662. Additional directories to search in for assembly references.
  3663. </summary>
  3664. <remarks>
  3665. <para>
  3666. loosely Corresponds with the <c>/lib[path]:</c> flag of the various compiler tasks.
  3667. </para>
  3668. </remarks>
  3669. </member>
  3670. <member name="T:NAnt.DotNet.Types.CompilerWarning">
  3671. <summary>
  3672. Represents a compiler warning.
  3673. </summary>
  3674. </member>
  3675. <member name="P:NAnt.DotNet.Types.CompilerWarning.Number">
  3676. <summary>
  3677. A warning number, or comma-separated list of warnings, that you want
  3678. the compiler to suppress or report.
  3679. </summary>
  3680. </member>
  3681. <member name="P:NAnt.DotNet.Types.CompilerWarning.IfDefined">
  3682. <summary>
  3683. If <see langword="true" /> then the element will be processed;
  3684. otherwise, skipped. The default is <see langword="true" />.
  3685. </summary>
  3686. </member>
  3687. <member name="P:NAnt.DotNet.Types.CompilerWarning.UnlessDefined">
  3688. <summary>
  3689. If <see langword="true" /> then the element will be skipped;
  3690. otherwise, processed. The default is <see langword="false" />.
  3691. </summary>
  3692. </member>
  3693. <member name="T:NAnt.DotNet.Types.CompilerWarningCollection">
  3694. <summary>
  3695. Contains a collection of <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> elements.
  3696. </summary>
  3697. </member>
  3698. <member name="M:NAnt.DotNet.Types.CompilerWarningCollection.#ctor">
  3699. <summary>
  3700. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.CompilerWarningCollection"/> class.
  3701. </summary>
  3702. </member>
  3703. <member name="M:NAnt.DotNet.Types.CompilerWarningCollection.#ctor(NAnt.DotNet.Types.CompilerWarningCollection)">
  3704. <summary>
  3705. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.CompilerWarningCollection"/> class
  3706. with the specified <see cref="T:NAnt.DotNet.Types.CompilerWarningCollection"/> instance.
  3707. </summary>
  3708. </member>
  3709. <member name="M:NAnt.DotNet.Types.CompilerWarningCollection.#ctor(NAnt.DotNet.Types.CompilerWarning[])">
  3710. <summary>
  3711. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.CompilerWarningCollection"/> class
  3712. with the specified array of <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> instances.
  3713. </summary>
  3714. </member>
  3715. <member name="M:NAnt.DotNet.Types.CompilerWarningCollection.Add(NAnt.DotNet.Types.CompilerWarning)">
  3716. <summary>
  3717. Adds a <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> to the end of the collection.
  3718. </summary>
  3719. <param name="item">The <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> to be added to the end of the collection.</param>
  3720. <returns>The position into which the new element was inserted.</returns>
  3721. </member>
  3722. <member name="M:NAnt.DotNet.Types.CompilerWarningCollection.AddRange(NAnt.DotNet.Types.CompilerWarning[])">
  3723. <summary>
  3724. Adds the elements of a <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> array to the end of the collection.
  3725. </summary>
  3726. <param name="items">The array of <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> elements to be added to the end of the collection.</param>
  3727. </member>
  3728. <member name="M:NAnt.DotNet.Types.CompilerWarningCollection.AddRange(NAnt.DotNet.Types.CompilerWarningCollection)">
  3729. <summary>
  3730. Adds the elements of a <see cref="T:NAnt.DotNet.Types.CompilerWarningCollection"/> to the end of the collection.
  3731. </summary>
  3732. <param name="items">The <see cref="T:NAnt.DotNet.Types.CompilerWarningCollection"/> to be added to the end of the collection.</param>
  3733. </member>
  3734. <member name="M:NAnt.DotNet.Types.CompilerWarningCollection.Contains(NAnt.DotNet.Types.CompilerWarning)">
  3735. <summary>
  3736. Determines whether a <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> is in the collection.
  3737. </summary>
  3738. <param name="item">The <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> to locate in the collection.</param>
  3739. <returns>
  3740. <see langword="true"/> if <paramref name="item"/> is found in the
  3741. collection; otherwise, <see langword="false"/>.
  3742. </returns>
  3743. </member>
  3744. <member name="M:NAnt.DotNet.Types.CompilerWarningCollection.CopyTo(NAnt.DotNet.Types.CompilerWarning[],System.Int32)">
  3745. <summary>
  3746. Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
  3747. </summary>
  3748. <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
  3749. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  3750. </member>
  3751. <member name="M:NAnt.DotNet.Types.CompilerWarningCollection.IndexOf(NAnt.DotNet.Types.CompilerWarning)">
  3752. <summary>
  3753. Retrieves the index of a specified <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> object in the collection.
  3754. </summary>
  3755. <param name="item">The <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> object for which the index is returned.</param>
  3756. <returns>
  3757. The index of the specified <see cref="T:NAnt.DotNet.Types.CompilerWarning"/>. If the <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> is not currently a member of the collection, it returns -1.
  3758. </returns>
  3759. </member>
  3760. <member name="M:NAnt.DotNet.Types.CompilerWarningCollection.Insert(System.Int32,NAnt.DotNet.Types.CompilerWarning)">
  3761. <summary>
  3762. Inserts a <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> into the collection at the specified index.
  3763. </summary>
  3764. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  3765. <param name="item">The <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> to insert.</param>
  3766. </member>
  3767. <member name="M:NAnt.DotNet.Types.CompilerWarningCollection.GetEnumerator">
  3768. <summary>
  3769. Returns an enumerator that can iterate through the collection.
  3770. </summary>
  3771. <returns>
  3772. A <see cref="T:NAnt.DotNet.Types.CompilerWarningEnumerator"/> for the entire collection.
  3773. </returns>
  3774. </member>
  3775. <member name="M:NAnt.DotNet.Types.CompilerWarningCollection.Remove(NAnt.DotNet.Types.CompilerWarning)">
  3776. <summary>
  3777. Removes a member from the collection.
  3778. </summary>
  3779. <param name="item">The <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> to remove from the collection.</param>
  3780. </member>
  3781. <member name="P:NAnt.DotNet.Types.CompilerWarningCollection.Item(System.Int32)">
  3782. <summary>
  3783. Gets or sets the element at the specified index.
  3784. </summary>
  3785. <param name="index">The zero-based index of the element to get or set.</param>
  3786. </member>
  3787. <member name="T:NAnt.DotNet.Types.CompilerWarningEnumerator">
  3788. <summary>
  3789. Enumerates the <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> elements of a <see cref="T:NAnt.DotNet.Types.CompilerWarningCollection"/>.
  3790. </summary>
  3791. </member>
  3792. <member name="M:NAnt.DotNet.Types.CompilerWarningEnumerator.#ctor(NAnt.DotNet.Types.CompilerWarningCollection)">
  3793. <summary>
  3794. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.CompilerWarningEnumerator"/> class
  3795. with the specified <see cref="T:NAnt.DotNet.Types.CompilerWarningCollection"/>.
  3796. </summary>
  3797. <param name="arguments">The collection that should be enumerated.</param>
  3798. </member>
  3799. <member name="M:NAnt.DotNet.Types.CompilerWarningEnumerator.MoveNext">
  3800. <summary>
  3801. Advances the enumerator to the next element of the collection.
  3802. </summary>
  3803. <returns>
  3804. <see langword="true" /> if the enumerator was successfully advanced
  3805. to the next element; <see langword="false" /> if the enumerator has
  3806. passed the end of the collection.
  3807. </returns>
  3808. </member>
  3809. <member name="M:NAnt.DotNet.Types.CompilerWarningEnumerator.Reset">
  3810. <summary>
  3811. Sets the enumerator to its initial position, which is before the
  3812. first element in the collection.
  3813. </summary>
  3814. </member>
  3815. <member name="P:NAnt.DotNet.Types.CompilerWarningEnumerator.Current">
  3816. <summary>
  3817. Gets the current element in the collection.
  3818. </summary>
  3819. <returns>
  3820. The current element in the collection.
  3821. </returns>
  3822. </member>
  3823. <member name="T:NAnt.DotNet.Types.DebugOutput">
  3824. <summary>
  3825. Specifies the type of debugging information generated by the compiler.
  3826. </summary>
  3827. <remarks>
  3828. <para>
  3829. For backward compatibility, the following string values can also be
  3830. used in build files:
  3831. </para>
  3832. <list type="table">
  3833. <listheader>
  3834. <term>Value</term>
  3835. <description>Corresponding field</description>
  3836. </listheader>
  3837. <item>
  3838. <term>"true"</term>
  3839. <description><see cref="F:NAnt.DotNet.Types.DebugOutput.Enable"/></description>
  3840. </item>
  3841. <item>
  3842. <term>"false"</term>
  3843. <description><see cref="F:NAnt.DotNet.Types.DebugOutput.None"/></description>
  3844. </item>
  3845. </list>
  3846. <para>
  3847. When set to <see langword="Enabled"/> then the following conditional
  3848. compilation symbols will also be defined:
  3849. </para>
  3850. <list type="bullet">
  3851. <item>
  3852. <description>DEBUG</description>
  3853. </item>
  3854. <item>
  3855. <description>TRACE</description>
  3856. </item>
  3857. </list>
  3858. </remarks>
  3859. </member>
  3860. <member name="F:NAnt.DotNet.Types.DebugOutput.None">
  3861. <summary>
  3862. Create no debug information.
  3863. </summary>
  3864. </member>
  3865. <member name="F:NAnt.DotNet.Types.DebugOutput.Enable">
  3866. <summary>
  3867. Enable attaching a debugger to the running program.
  3868. </summary>
  3869. </member>
  3870. <member name="F:NAnt.DotNet.Types.DebugOutput.Full">
  3871. <summary>
  3872. Enable attaching a debugger to the running program.
  3873. </summary>
  3874. </member>
  3875. <member name="F:NAnt.DotNet.Types.DebugOutput.PdbOnly">
  3876. <summary>
  3877. Only display assembler when the running program is attached to the
  3878. debugger.
  3879. </summary>
  3880. </member>
  3881. <member name="T:NAnt.DotNet.Types.DebugOutputConverter">
  3882. <summary>
  3883. Specialized <see cref="T:System.ComponentModel.EnumConverter"/> that also supports
  3884. case-insensitive conversion of "true" to
  3885. <see cref="F:NAnt.DotNet.Types.DebugOutput.Enable"/> and "false" to
  3886. <see cref="F:NAnt.DotNet.Types.DebugOutput.None"/>.
  3887. </summary>
  3888. </member>
  3889. <member name="M:NAnt.DotNet.Types.DebugOutputConverter.#ctor">
  3890. <summary>
  3891. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.DebugOutputConverter"/>
  3892. class.
  3893. </summary>
  3894. </member>
  3895. <member name="M:NAnt.DotNet.Types.DebugOutputConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
  3896. <summary>
  3897. Converts the given object to the type of this converter, using the
  3898. specified context and culture information.
  3899. </summary>
  3900. <param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext"/> that provides a format context.</param>
  3901. <param name="culture">A <see cref="T:System.Globalization.CultureInfo"/> object. If a <see langword="null"/> is passed, the current culture is assumed.</param>
  3902. <param name="value">The <see cref="T:System.Object"/> to convert.</param>
  3903. <returns>
  3904. An <see cref="T:System.Object"/> that represents the converted value.
  3905. </returns>
  3906. </member>
  3907. <member name="T:NAnt.DotNet.Types.DelaySign">
  3908. <summary>
  3909. Specifies whether the generated assembly is strongly named and will
  3910. be signed later.
  3911. </summary>
  3912. <remarks>
  3913. <para>
  3914. For backward compatibility, the following string values can also be
  3915. used in build files:
  3916. </para>
  3917. <list type="table">
  3918. <listheader>
  3919. <term>Value</term>
  3920. <description>Corresponding field</description>
  3921. </listheader>
  3922. <item>
  3923. <term>"true"</term>
  3924. <description><see cref="F:NAnt.DotNet.Types.DelaySign.Yes"/></description>
  3925. </item>
  3926. <item>
  3927. <term>"false"</term>
  3928. <description><see cref="F:NAnt.DotNet.Types.DelaySign.No"/></description>
  3929. </item>
  3930. </list>
  3931. </remarks>
  3932. </member>
  3933. <member name="F:NAnt.DotNet.Types.DelaySign.NotSet">
  3934. <summary>
  3935. Not specified.
  3936. </summary>
  3937. </member>
  3938. <member name="F:NAnt.DotNet.Types.DelaySign.No">
  3939. <summary>
  3940. Fully sign the assembly.
  3941. </summary>
  3942. </member>
  3943. <member name="F:NAnt.DotNet.Types.DelaySign.Yes">
  3944. <summary>
  3945. Only place the public key in the assembly, allowing the signature
  3946. to be added later.
  3947. </summary>
  3948. </member>
  3949. <member name="T:NAnt.DotNet.Types.DelaySignConverter">
  3950. <summary>
  3951. Specialized <see cref="T:System.ComponentModel.EnumConverter"/> that also supports
  3952. case-insensitive conversion of "true" to
  3953. <see cref="F:NAnt.DotNet.Types.DelaySign.Yes"/> and "false" to
  3954. <see cref="F:NAnt.DotNet.Types.DelaySign.No"/>.
  3955. </summary>
  3956. </member>
  3957. <member name="M:NAnt.DotNet.Types.DelaySignConverter.#ctor">
  3958. <summary>
  3959. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.DelaySignConverter"/>
  3960. class.
  3961. </summary>
  3962. </member>
  3963. <member name="M:NAnt.DotNet.Types.DelaySignConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
  3964. <summary>
  3965. Converts the given object to the type of this converter, using the
  3966. specified context and culture information.
  3967. </summary>
  3968. <param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext"/> that provides a format context.</param>
  3969. <param name="culture">A <see cref="T:System.Globalization.CultureInfo"/> object. If a <see langword="null"/> is passed, the current culture is assumed.</param>
  3970. <param name="value">The <see cref="T:System.Object"/> to convert.</param>
  3971. <returns>
  3972. An <see cref="T:System.Object"/> that represents the converted value.
  3973. </returns>
  3974. </member>
  3975. <member name="T:NAnt.DotNet.Types.EmbeddedResource">
  3976. <summary>
  3977. Represents an embedded resource.
  3978. </summary>
  3979. <remarks>
  3980. Do not yet expose this to build authors.
  3981. </remarks>
  3982. </member>
  3983. <member name="M:NAnt.DotNet.Types.EmbeddedResource.#ctor(System.String,System.String)">
  3984. <summary>
  3985. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/>
  3986. with the specified file name and manifest resource name.
  3987. </summary>
  3988. <param name="file">The path of the compiled resource.</param>
  3989. <param name="manifestResourceName">The manifest resource name of the embedded resource.</param>
  3990. </member>
  3991. <member name="P:NAnt.DotNet.Types.EmbeddedResource.File">
  3992. <summary>
  3993. Gets the physical location of the resource to embed.
  3994. </summary>
  3995. <value>
  3996. The physical location of the resource to embed.
  3997. </value>
  3998. </member>
  3999. <member name="P:NAnt.DotNet.Types.EmbeddedResource.ManifestResourceName">
  4000. <summary>
  4001. Gets the manifest resource name to use when embedding the resource.
  4002. </summary>
  4003. <value>
  4004. The manifest resource name to use when embedding the resource.
  4005. </value>
  4006. </member>
  4007. <member name="T:NAnt.DotNet.Types.EmbeddedResourceCollection">
  4008. <summary>
  4009. Contains a collection of <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> items.
  4010. </summary>
  4011. <remarks>
  4012. Do not yet expose this to build authors.
  4013. </remarks>
  4014. </member>
  4015. <member name="T:NAnt.DotNet.Types.DataTypeCollectionBase">
  4016. <summary>
  4017. Base class for collections that needs to be globally referencable.
  4018. </summary>
  4019. </member>
  4020. <member name="M:NAnt.DotNet.Types.DataTypeCollectionBase.#ctor">
  4021. <summary>
  4022. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.DataTypeCollectionBase"/>
  4023. class.
  4024. </summary>
  4025. </member>
  4026. <member name="M:NAnt.DotNet.Types.DataTypeCollectionBase.CopyTo(System.Array,System.Int32)">
  4027. <summary>
  4028. Copies the items of the collection to an <see cref="T:System.Array"/>,
  4029. starting at a particular index.
  4030. </summary>
  4031. <param name="array">The one-dimensional <see cref="T:System.Array"/> that is the destination of the items copied from the collection. The <see cref="T:System.Array"/> must have zero-based indexing.</param>
  4032. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  4033. </member>
  4034. <member name="M:NAnt.DotNet.Types.DataTypeCollectionBase.System#Collections#IEnumerable#GetEnumerator">
  4035. <summary>
  4036. Returns an enumerator that can iterate through a collection.
  4037. </summary>
  4038. <returns>
  4039. An <see cref="T:System.Collections.IEnumerator"/> that can be used to iterate through
  4040. the collection.
  4041. </returns>
  4042. </member>
  4043. <member name="M:NAnt.DotNet.Types.DataTypeCollectionBase.RemoveAt(System.Int32)">
  4044. <summary>
  4045. Removes an item at a specific index.
  4046. </summary>
  4047. <param name="index">The zero-based index of the item to remove.</param>
  4048. </member>
  4049. <member name="M:NAnt.DotNet.Types.DataTypeCollectionBase.Clear">
  4050. <summary>
  4051. Removes all items from the collection.
  4052. </summary>
  4053. </member>
  4054. <member name="M:NAnt.DotNet.Types.DataTypeCollectionBase.ValidateType(System.Object)">
  4055. <summary>
  4056. Used by methods that take <see cref="T:System.Object"/> instances as argument
  4057. to verify whether the instance is valid for the collection class.
  4058. </summary>
  4059. <param name="value">The instance to verify.</param>
  4060. </member>
  4061. <member name="M:NAnt.DotNet.Types.DataTypeCollectionBase.RangeCheck(System.Int32)">
  4062. <summary>
  4063. Checks whether the specified index is within the range of this
  4064. collection.
  4065. </summary>
  4066. <param name="index">The index to check.</param>
  4067. </member>
  4068. <member name="P:NAnt.DotNet.Types.DataTypeCollectionBase.System#Collections#ICollection#IsSynchronized">
  4069. <summary>
  4070. Gets a value indicating whether access to the collection is
  4071. synchronized (thread-safe).
  4072. </summary>
  4073. <value>
  4074. <see langword="false" />.
  4075. </value>
  4076. </member>
  4077. <member name="P:NAnt.DotNet.Types.DataTypeCollectionBase.Count">
  4078. <summary>
  4079. Gets the number of items in the collection.
  4080. </summary>
  4081. <value>
  4082. The number of items in the collection.
  4083. </value>
  4084. </member>
  4085. <member name="P:NAnt.DotNet.Types.DataTypeCollectionBase.System#Collections#ICollection#SyncRoot">
  4086. <summary>
  4087. Gets an object that can be used to synchronize access to the
  4088. collection.
  4089. </summary>
  4090. <value>
  4091. An object that can be used to synchronize access to the collection.
  4092. </value>
  4093. </member>
  4094. <member name="P:NAnt.DotNet.Types.DataTypeCollectionBase.IsFixedSize">
  4095. <summary>
  4096. Gets a value indicating whether the collection has a fixed size.
  4097. </summary>
  4098. <value>
  4099. <see langword="false" />.
  4100. </value>
  4101. </member>
  4102. <member name="P:NAnt.DotNet.Types.DataTypeCollectionBase.IsReadOnly">
  4103. <summary>
  4104. Gets a value indicating whether the collection has a fixed size.
  4105. </summary>
  4106. <value>
  4107. <see langword="false" />.
  4108. </value>
  4109. </member>
  4110. <member name="P:NAnt.DotNet.Types.DataTypeCollectionBase.List">
  4111. <summary>
  4112. Gets the list of elements contained in the
  4113. <see cref="T:NAnt.DotNet.Types.DataTypeCollectionBase"/> instance.
  4114. </summary>
  4115. <value>
  4116. An <see cref="T:System.Collections.ArrayList"/> containing the elements of the
  4117. collection.
  4118. </value>
  4119. </member>
  4120. <member name="P:NAnt.DotNet.Types.DataTypeCollectionBase.ItemType">
  4121. <summary>
  4122. Gets the <see cref="T:System.Type"/> of the items in this collection.
  4123. </summary>
  4124. <value>
  4125. The <see cref="T:System.Type"/> of the items in this collection.
  4126. </value>
  4127. </member>
  4128. <member name="M:NAnt.DotNet.Types.EmbeddedResourceCollection.GetEnumerator">
  4129. <summary>
  4130. Returns an enumerator that can iterate through the collection.
  4131. </summary>
  4132. <returns>
  4133. A <see cref="T:NAnt.DotNet.Types.EmbeddedResourceEnumerator"/> for the entire collection.
  4134. </returns>
  4135. </member>
  4136. <member name="M:NAnt.DotNet.Types.EmbeddedResourceCollection.System#Collections#IList#Insert(System.Int32,System.Object)">
  4137. <summary>
  4138. Inserts a <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> into the collection at the
  4139. specified index.
  4140. </summary>
  4141. <param name="index">The zero-based index at which <paramref name="value"/> should be inserted.</param>
  4142. <param name="value">The <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> to insert.</param>
  4143. </member>
  4144. <member name="M:NAnt.DotNet.Types.EmbeddedResourceCollection.System#Collections#IList#Remove(System.Object)">
  4145. <summary>
  4146. Removes the specified <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> from the
  4147. collection.
  4148. </summary>
  4149. <param name="value">The <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> to remove from the collection.</param>
  4150. </member>
  4151. <member name="M:NAnt.DotNet.Types.EmbeddedResourceCollection.System#Collections#IList#Contains(System.Object)">
  4152. <summary>
  4153. Determines whether a <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> is in the collection.
  4154. </summary>
  4155. <param name="value">The <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> to locate in the collection.</param>
  4156. <returns>
  4157. <see langword="true"/> if <paramref name="value"/> is found in the
  4158. collection; otherwise, <see langword="false"/>.
  4159. </returns>
  4160. </member>
  4161. <member name="M:NAnt.DotNet.Types.EmbeddedResourceCollection.System#Collections#IList#IndexOf(System.Object)">
  4162. <summary>
  4163. Gets the location of a <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> in the collection.
  4164. </summary>
  4165. <param name="value">The <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> object to locate.</param>
  4166. <returns>
  4167. The zero-based location of the <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> in the
  4168. collection.
  4169. </returns>
  4170. <remarks>
  4171. If the <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> is not currently a member of
  4172. the collection, -1 is returned.
  4173. </remarks>
  4174. </member>
  4175. <member name="M:NAnt.DotNet.Types.EmbeddedResourceCollection.System#Collections#IList#Add(System.Object)">
  4176. <summary>
  4177. Adds a <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> to the end of the collection.
  4178. </summary>
  4179. <param name="value">The <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> to be added to the end of the collection.</param>
  4180. <returns>
  4181. The position into which the new item was inserted.
  4182. </returns>
  4183. </member>
  4184. <member name="M:NAnt.DotNet.Types.EmbeddedResourceCollection.AddRange(NAnt.DotNet.Types.EmbeddedResourceCollection)">
  4185. <summary>
  4186. Adds the items of a <see cref="T:NAnt.DotNet.Types.EmbeddedResourceCollection"/> to the end of the collection.
  4187. </summary>
  4188. <param name="items">The <see cref="T:NAnt.DotNet.Types.EmbeddedResourceCollection"/> to be added to the end of the collection.</param>
  4189. </member>
  4190. <member name="M:NAnt.DotNet.Types.EmbeddedResourceCollection.Add(NAnt.DotNet.Types.EmbeddedResource)">
  4191. <summary>
  4192. Adds a <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> to the end of the collection.
  4193. </summary>
  4194. <param name="value">The <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> to be added to the end of the collection.</param>
  4195. <returns>
  4196. The position into which the new item was inserted.
  4197. </returns>
  4198. </member>
  4199. <member name="M:NAnt.DotNet.Types.EmbeddedResourceCollection.Insert(System.Int32,NAnt.DotNet.Types.EmbeddedResource)">
  4200. <summary>
  4201. Inserts a <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> into the collection at the
  4202. specified index.
  4203. </summary>
  4204. <param name="index">The zero-based index at which <paramref name="value"/> should be inserted.</param>
  4205. <param name="value">The <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> to insert.</param>
  4206. </member>
  4207. <member name="M:NAnt.DotNet.Types.EmbeddedResourceCollection.Remove(NAnt.DotNet.Types.EmbeddedResource)">
  4208. <summary>
  4209. Removes the specified <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> from the
  4210. collection.
  4211. </summary>
  4212. <param name="value">The <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> to remove from the collection.</param>
  4213. </member>
  4214. <member name="M:NAnt.DotNet.Types.EmbeddedResourceCollection.Contains(NAnt.DotNet.Types.EmbeddedResource)">
  4215. <summary>
  4216. Determines whether a <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> is in the collection.
  4217. </summary>
  4218. <param name="value">The <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> to locate in the collection.</param>
  4219. <returns>
  4220. <see langword="true"/> if <paramref name="value"/> is found in the
  4221. collection; otherwise, <see langword="false"/>.
  4222. </returns>
  4223. </member>
  4224. <member name="M:NAnt.DotNet.Types.EmbeddedResourceCollection.IndexOf(NAnt.DotNet.Types.EmbeddedResource)">
  4225. <summary>
  4226. Gets the location of a <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> in the collection.
  4227. </summary>
  4228. <param name="value">The <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> object to locate.</param>
  4229. <returns>
  4230. The zero-based location of the <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> in the
  4231. collection.
  4232. </returns>
  4233. <remarks>
  4234. If the <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> is not currently a member of
  4235. the collection, -1 is returned.
  4236. </remarks>
  4237. </member>
  4238. <member name="P:NAnt.DotNet.Types.EmbeddedResourceCollection.Item(System.Int32)">
  4239. <summary>
  4240. Gets or sets the item at the specified index.
  4241. </summary>
  4242. <param name="index">The zero-based index of the item to get or set.</param>
  4243. </member>
  4244. <member name="P:NAnt.DotNet.Types.EmbeddedResourceCollection.Item(System.String)">
  4245. <summary>
  4246. Gets the <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> with the specified manifest
  4247. resource name.
  4248. </summary>
  4249. <param name="value">The manifest resource name of the <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> to get.</param>
  4250. </member>
  4251. <member name="P:NAnt.DotNet.Types.EmbeddedResourceCollection.ItemType">
  4252. <summary>
  4253. Gets the <see cref="T:System.Type"/> of the items in this collection.
  4254. </summary>
  4255. <value>
  4256. The <see cref="T:System.Type"/> of the items in this collection.
  4257. </value>
  4258. </member>
  4259. <member name="P:NAnt.DotNet.Types.EmbeddedResourceCollection.System#Collections#IList#$Item$(System.Int32)">
  4260. <summary>
  4261. Gets or sets the item at the specified index.
  4262. </summary>
  4263. <param name="index">The zero-based index of the item to get or set.</param>
  4264. </member>
  4265. <member name="T:NAnt.DotNet.Types.EmbeddedResourceEnumerator">
  4266. <summary>
  4267. Enumerates the <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> items of a <see cref="T:NAnt.DotNet.Types.EmbeddedResourceCollection"/>.
  4268. </summary>
  4269. </member>
  4270. <member name="M:NAnt.DotNet.Types.EmbeddedResourceEnumerator.#ctor(NAnt.DotNet.Types.EmbeddedResourceCollection)">
  4271. <summary>
  4272. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.EmbeddedResourceEnumerator"/> class
  4273. with the specified <see cref="T:NAnt.DotNet.Types.EmbeddedResourceCollection"/>.
  4274. </summary>
  4275. <param name="arguments">The collection that should be enumerated.</param>
  4276. </member>
  4277. <member name="M:NAnt.DotNet.Types.EmbeddedResourceEnumerator.MoveNext">
  4278. <summary>
  4279. Advances the enumerator to the next item of the collection.
  4280. </summary>
  4281. <returns>
  4282. <see langword="true" /> if the enumerator was successfully advanced
  4283. to the next item; <see langword="false" /> if the enumerator has
  4284. passed the end of the collection.
  4285. </returns>
  4286. </member>
  4287. <member name="M:NAnt.DotNet.Types.EmbeddedResourceEnumerator.Reset">
  4288. <summary>
  4289. Sets the enumerator to its initial position, which is before the
  4290. first item in the collection.
  4291. </summary>
  4292. </member>
  4293. <member name="P:NAnt.DotNet.Types.EmbeddedResourceEnumerator.Current">
  4294. <summary>
  4295. Gets the current item in the collection.
  4296. </summary>
  4297. <returns>
  4298. The current item in the collection.
  4299. </returns>
  4300. </member>
  4301. <member name="P:NAnt.DotNet.Types.EmbeddedResourceEnumerator.System#Collections#IEnumerator#Current">
  4302. <summary>
  4303. Gets the current item in the collection.
  4304. </summary>
  4305. <returns>
  4306. The current item in the collection.
  4307. </returns>
  4308. </member>
  4309. <member name="T:NAnt.DotNet.Types.Module">
  4310. <summary>
  4311. Represents a metadata file without assembly manifest.
  4312. </summary>
  4313. </member>
  4314. <member name="M:NAnt.DotNet.Types.Module.ToString">
  4315. <summary>
  4316. Returns a textual representation of the module, which can be used as
  4317. argument for command-line tools.
  4318. </summary>
  4319. <returns>
  4320. A textual representation of the path, file[,target].
  4321. </returns>
  4322. </member>
  4323. <member name="P:NAnt.DotNet.Types.Module.File">
  4324. <summary>
  4325. The path of the module.
  4326. </summary>
  4327. </member>
  4328. <member name="P:NAnt.DotNet.Types.Module.Target">
  4329. <summary>
  4330. File name where the module should be copied to before it is compiled
  4331. into an assembly.
  4332. </summary>
  4333. </member>
  4334. <member name="P:NAnt.DotNet.Types.Module.ModuleSet">
  4335. <summary>
  4336. Gets or sets the <see cref="P:NAnt.DotNet.Types.Module.ModuleSet"/> that contains the module.
  4337. </summary>
  4338. </member>
  4339. <member name="T:NAnt.DotNet.Types.ModuleCollection">
  4340. <summary>
  4341. Contains a collection of <see cref="T:NAnt.DotNet.Types.Module"/> items.
  4342. </summary>
  4343. <remarks>
  4344. Do not yet expose this to build authors.
  4345. </remarks>
  4346. </member>
  4347. <member name="M:NAnt.DotNet.Types.ModuleCollection.#ctor(NAnt.DotNet.Types.ModuleSet)">
  4348. <summary>
  4349. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.ModuleCollection"/>
  4350. for the specified <see cref="T:NAnt.DotNet.Types.ModuleSet"/>.
  4351. </summary>
  4352. <param name="moduleSet">The <see cref="T:NAnt.DotNet.Types.ModuleSet"/> containing the collection.</param>
  4353. <exception cref="T:System.ArgumentNullException"><paramref name="moduleSet"/> is <see langword="true"/>.</exception>
  4354. </member>
  4355. <member name="M:NAnt.DotNet.Types.ModuleCollection.System#Collections#IEnumerable#GetEnumerator">
  4356. <summary>
  4357. Returns an enumerator that can iterate through the collection.
  4358. </summary>
  4359. <returns>
  4360. A <see cref="T:NAnt.DotNet.Types.ModuleEnumerator"/> for the entire collection.
  4361. </returns>
  4362. </member>
  4363. <member name="M:NAnt.DotNet.Types.ModuleCollection.CopyTo(System.Array,System.Int32)">
  4364. <summary>
  4365. Copies the items of the collection to an <see cref="T:System.Array"/>,
  4366. starting at a particular index.
  4367. </summary>
  4368. <param name="array">The one-dimensional <see cref="T:System.Array"/> that is the destination of the items copied from the collection. The <see cref="T:System.Array"/> must have zero-based indexing.</param>
  4369. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  4370. </member>
  4371. <member name="M:NAnt.DotNet.Types.ModuleCollection.Clear">
  4372. <summary>
  4373. Removes all items from the collection.
  4374. </summary>
  4375. </member>
  4376. <member name="M:NAnt.DotNet.Types.ModuleCollection.System#Collections#IList#Insert(System.Int32,System.Object)">
  4377. <summary>
  4378. Inserts a <see cref="T:NAnt.DotNet.Types.Module"/> into the collection at the
  4379. specified index.
  4380. </summary>
  4381. <param name="index">The zero-based index at which <paramref name="value"/> should be inserted.</param>
  4382. <param name="value">The <see cref="T:NAnt.DotNet.Types.Module"/> to insert.</param>
  4383. </member>
  4384. <member name="M:NAnt.DotNet.Types.ModuleCollection.System#Collections#IList#Remove(System.Object)">
  4385. <summary>
  4386. Removes the specified <see cref="T:NAnt.DotNet.Types.Module"/> from the
  4387. collection.
  4388. </summary>
  4389. <param name="value">The <see cref="T:NAnt.DotNet.Types.Module"/> to remove from the collection.</param>
  4390. </member>
  4391. <member name="M:NAnt.DotNet.Types.ModuleCollection.RemoveAt(System.Int32)">
  4392. <summary>
  4393. Removes an item at a specific index.
  4394. </summary>
  4395. <param name="index">The zero-based index of the item to remove.</param>
  4396. <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="index"/> parameter is less than 0 or greater than or equal to the value of the <see cref="P:NAnt.DotNet.Types.ModuleCollection.Count"/> property of the <see cref="T:NAnt.DotNet.Types.ModuleCollection"/>.</exception>
  4397. </member>
  4398. <member name="M:NAnt.DotNet.Types.ModuleCollection.System#Collections#IList#Contains(System.Object)">
  4399. <summary>
  4400. Determines whether a <see cref="T:NAnt.DotNet.Types.Module"/> is in the collection.
  4401. </summary>
  4402. <param name="value">The <see cref="T:NAnt.DotNet.Types.Module"/> to locate in the collection.</param>
  4403. <returns>
  4404. <see langword="true"/> if <paramref name="value"/> is found in the
  4405. collection; otherwise, <see langword="false"/>.
  4406. </returns>
  4407. </member>
  4408. <member name="M:NAnt.DotNet.Types.ModuleCollection.System#Collections#IList#IndexOf(System.Object)">
  4409. <summary>
  4410. Gets the location of a <see cref="T:NAnt.DotNet.Types.Module"/> in the collection.
  4411. </summary>
  4412. <param name="value">The <see cref="T:NAnt.DotNet.Types.Module"/> object to locate.</param>
  4413. <returns>
  4414. The zero-based location of the <see cref="T:NAnt.DotNet.Types.Module"/> in the
  4415. collection.
  4416. </returns>
  4417. <remarks>
  4418. If the <see cref="T:NAnt.DotNet.Types.Module"/> is not currently a member of
  4419. the collection, -1 is returned.
  4420. </remarks>
  4421. </member>
  4422. <member name="M:NAnt.DotNet.Types.ModuleCollection.System#Collections#IList#Add(System.Object)">
  4423. <summary>
  4424. Adds a <see cref="T:NAnt.DotNet.Types.Module"/> to the end of the collection.
  4425. </summary>
  4426. <param name="value">The <see cref="T:NAnt.DotNet.Types.Module"/> to be added to the end of the collection.</param>
  4427. <returns>
  4428. The position into which the new item was inserted.
  4429. </returns>
  4430. </member>
  4431. <member name="M:NAnt.DotNet.Types.ModuleCollection.AddRange(NAnt.DotNet.Types.ModuleCollection)">
  4432. <summary>
  4433. Adds the items of a <see cref="T:NAnt.DotNet.Types.ModuleCollection"/> to the end of the collection.
  4434. </summary>
  4435. <param name="items">The <see cref="T:NAnt.DotNet.Types.ModuleCollection"/> to be added to the end of the collection.</param>
  4436. </member>
  4437. <member name="M:NAnt.DotNet.Types.ModuleCollection.Add(NAnt.DotNet.Types.Module)">
  4438. <summary>
  4439. Adds a <see cref="T:NAnt.DotNet.Types.Module"/> to the end of the collection.
  4440. </summary>
  4441. <param name="value">The <see cref="T:NAnt.DotNet.Types.Module"/> to be added to the end of the collection.</param>
  4442. <returns>
  4443. The position into which the new item was inserted.
  4444. </returns>
  4445. </member>
  4446. <member name="M:NAnt.DotNet.Types.ModuleCollection.GetEnumerator">
  4447. <summary>
  4448. Returns an enumerator that can iterate through the collection.
  4449. </summary>
  4450. <returns>
  4451. A <see cref="T:NAnt.DotNet.Types.ModuleEnumerator"/> for the entire collection.
  4452. </returns>
  4453. </member>
  4454. <member name="M:NAnt.DotNet.Types.ModuleCollection.Insert(System.Int32,NAnt.DotNet.Types.Module)">
  4455. <summary>
  4456. Inserts a <see cref="T:NAnt.DotNet.Types.Module"/> into the collection at the
  4457. specified index.
  4458. </summary>
  4459. <param name="index">The zero-based index at which <paramref name="value"/> should be inserted.</param>
  4460. <param name="value">The <see cref="T:NAnt.DotNet.Types.Module"/> to insert.</param>
  4461. </member>
  4462. <member name="M:NAnt.DotNet.Types.ModuleCollection.Remove(NAnt.DotNet.Types.Module)">
  4463. <summary>
  4464. Removes the specified <see cref="T:NAnt.DotNet.Types.Module"/> from the
  4465. collection.
  4466. </summary>
  4467. <param name="value">The <see cref="T:NAnt.DotNet.Types.Module"/> to remove from the collection.</param>
  4468. </member>
  4469. <member name="M:NAnt.DotNet.Types.ModuleCollection.Contains(NAnt.DotNet.Types.Module)">
  4470. <summary>
  4471. Determines whether a <see cref="T:NAnt.DotNet.Types.Module"/> is in the collection.
  4472. </summary>
  4473. <param name="value">The <see cref="T:NAnt.DotNet.Types.Module"/> to locate in the collection.</param>
  4474. <returns>
  4475. <see langword="true"/> if <paramref name="value"/> is found in the
  4476. collection; otherwise, <see langword="false"/>.
  4477. </returns>
  4478. </member>
  4479. <member name="M:NAnt.DotNet.Types.ModuleCollection.IndexOf(NAnt.DotNet.Types.Module)">
  4480. <summary>
  4481. Gets the location of a <see cref="T:NAnt.DotNet.Types.Module"/> in the collection.
  4482. </summary>
  4483. <param name="value">The <see cref="T:NAnt.DotNet.Types.Module"/> object to locate.</param>
  4484. <returns>
  4485. The zero-based location of the <see cref="T:NAnt.DotNet.Types.Module"/> in the
  4486. collection.
  4487. </returns>
  4488. <remarks>
  4489. If the <see cref="T:NAnt.DotNet.Types.Module"/> is not currently a member of
  4490. the collection, -1 is returned.
  4491. </remarks>
  4492. </member>
  4493. <member name="P:NAnt.DotNet.Types.ModuleCollection.Item(System.Int32)">
  4494. <summary>
  4495. Gets or sets the item at the specified index.
  4496. </summary>
  4497. <param name="index">The zero-based index of the item to get or set.</param>
  4498. <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="index"/> parameter is less than 0 or greater than or equal to the value of the <see cref="P:NAnt.DotNet.Types.ModuleCollection.Count"/> property of the <see cref="T:NAnt.DotNet.Types.ModuleCollection"/>.</exception>
  4499. </member>
  4500. <member name="P:NAnt.DotNet.Types.ModuleCollection.List">
  4501. <summary>
  4502. Gets the list of elements contained in the
  4503. <see cref="T:NAnt.DotNet.Types.ModuleCollection"/> instance.
  4504. </summary>
  4505. <value>
  4506. An <see cref="T:System.Collections.ArrayList"/> containing the elements of the
  4507. collection.
  4508. </value>
  4509. </member>
  4510. <member name="P:NAnt.DotNet.Types.ModuleCollection.System#Collections#ICollection#IsSynchronized">
  4511. <summary>
  4512. Gets a value indicating whether access to the collection is
  4513. synchronized (thread-safe).
  4514. </summary>
  4515. <value>
  4516. <see langword="false" />.
  4517. </value>
  4518. </member>
  4519. <member name="P:NAnt.DotNet.Types.ModuleCollection.Count">
  4520. <summary>
  4521. Gets the number of items in the collection.
  4522. </summary>
  4523. <value>
  4524. The number of items in the collection.
  4525. </value>
  4526. </member>
  4527. <member name="P:NAnt.DotNet.Types.ModuleCollection.System#Collections#ICollection#SyncRoot">
  4528. <summary>
  4529. Gets an object that can be used to synchronize access to the
  4530. collection.
  4531. </summary>
  4532. <value>
  4533. An object that can be used to synchronize access to the collection.
  4534. </value>
  4535. </member>
  4536. <member name="P:NAnt.DotNet.Types.ModuleCollection.IsFixedSize">
  4537. <summary>
  4538. Gets a value indicating whether the collection has a fixed size.
  4539. </summary>
  4540. <value>
  4541. <see langword="false" />.
  4542. </value>
  4543. </member>
  4544. <member name="P:NAnt.DotNet.Types.ModuleCollection.IsReadOnly">
  4545. <summary>
  4546. Gets a value indicating whether the collection has a fixed size.
  4547. </summary>
  4548. <value>
  4549. <see langword="false" />.
  4550. </value>
  4551. </member>
  4552. <member name="P:NAnt.DotNet.Types.ModuleCollection.System#Collections#IList#$Item$(System.Int32)">
  4553. <summary>
  4554. Gets or sets the item at the specified index.
  4555. </summary>
  4556. <param name="index">The zero-based index of the item to get or set.</param>
  4557. <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="index"/> parameter is less than 0 or greater than or equal to the value of the <see cref="P:NAnt.DotNet.Types.ModuleCollection.Count"/> property of the <see cref="T:NAnt.DotNet.Types.ModuleCollection"/>.</exception>
  4558. </member>
  4559. <member name="T:NAnt.DotNet.Types.ModuleEnumerator">
  4560. <summary>
  4561. Enumerates the <see cref="T:NAnt.DotNet.Types.Module"/> items of a <see cref="T:NAnt.DotNet.Types.ModuleCollection"/>.
  4562. </summary>
  4563. </member>
  4564. <member name="M:NAnt.DotNet.Types.ModuleEnumerator.#ctor(NAnt.DotNet.Types.ModuleCollection)">
  4565. <summary>
  4566. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.ModuleEnumerator"/> class
  4567. with the specified <see cref="T:NAnt.DotNet.Types.ModuleCollection"/>.
  4568. </summary>
  4569. <param name="arguments">The collection that should be enumerated.</param>
  4570. </member>
  4571. <member name="M:NAnt.DotNet.Types.ModuleEnumerator.MoveNext">
  4572. <summary>
  4573. Advances the enumerator to the next item of the collection.
  4574. </summary>
  4575. <returns>
  4576. <see langword="true" /> if the enumerator was successfully advanced
  4577. to the next item; <see langword="false" /> if the enumerator has
  4578. passed the end of the collection.
  4579. </returns>
  4580. </member>
  4581. <member name="M:NAnt.DotNet.Types.ModuleEnumerator.Reset">
  4582. <summary>
  4583. Sets the enumerator to its initial position, which is before the
  4584. first item in the collection.
  4585. </summary>
  4586. </member>
  4587. <member name="P:NAnt.DotNet.Types.ModuleEnumerator.Current">
  4588. <summary>
  4589. Gets the current item in the collection.
  4590. </summary>
  4591. <returns>
  4592. The current item in the collection.
  4593. </returns>
  4594. </member>
  4595. <member name="P:NAnt.DotNet.Types.ModuleEnumerator.System#Collections#IEnumerator#Current">
  4596. <summary>
  4597. Gets the current item in the collection.
  4598. </summary>
  4599. <returns>
  4600. The current item in the collection.
  4601. </returns>
  4602. </member>
  4603. <member name="T:NAnt.DotNet.Types.ModuleSet">
  4604. <summary>
  4605. <para>
  4606. One or more modules to compile into an assembly.
  4607. </para>
  4608. </summary>
  4609. <example>
  4610. <para>
  4611. Define a global <c>&lt;moduleset&gt;</c> that can be referenced by
  4612. other tasks or types.
  4613. </para>
  4614. <code>
  4615. <![CDATA[
  4616. <moduleset id="client-modules" dir="${build}">
  4617. <module file="Client.netmodule" />
  4618. <module file="Common.netmodule" />
  4619. </moduleset>
  4620. ]]>
  4621. </code>
  4622. </example>
  4623. </member>
  4624. <member name="M:NAnt.DotNet.Types.ModuleSet.#ctor">
  4625. <summary>
  4626. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.ModuleSet"/> class.
  4627. </summary>
  4628. </member>
  4629. <member name="P:NAnt.DotNet.Types.ModuleSet.Dir">
  4630. <summary>
  4631. The base of the directory of this <see cref="T:NAnt.DotNet.Types.ModuleSet"/>.
  4632. The default is the project base directory.
  4633. </summary>
  4634. </member>
  4635. <member name="P:NAnt.DotNet.Types.ModuleSet.Modules">
  4636. <summary>
  4637. The modules to add to this <see cref="T:NAnt.DotNet.Types.ModuleSet"/>.
  4638. </summary>
  4639. </member>
  4640. <member name="T:NAnt.DotNet.Types.NamespaceImport">
  4641. <summary>
  4642. Represents a namespace to import.
  4643. </summary>
  4644. </member>
  4645. <member name="M:NAnt.DotNet.Types.NamespaceImport.#ctor">
  4646. <summary>
  4647. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.NamespaceImport"/>
  4648. class.
  4649. </summary>
  4650. </member>
  4651. <member name="M:NAnt.DotNet.Types.NamespaceImport.#ctor(System.String)">
  4652. <summary>
  4653. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.NamespaceImport"/>
  4654. class for the specified namespace.
  4655. </summary>
  4656. <param name="nameSpace">The namespace.</param>
  4657. <exception cref="T:System.ArgumentNullException"><paramref name="nameSpace"/> is <see langword="null"/>.</exception>
  4658. </member>
  4659. <member name="P:NAnt.DotNet.Types.NamespaceImport.TempName">
  4660. <summary>
  4661. The name of the namespace to import.
  4662. </summary>
  4663. <value>
  4664. The name of the namespace to import.
  4665. </value>
  4666. </member>
  4667. <member name="P:NAnt.DotNet.Types.NamespaceImport.Namespace">
  4668. <summary>
  4669. The name of the namespace to import.
  4670. </summary>
  4671. <value>
  4672. The name of the namespace to import.
  4673. </value>
  4674. </member>
  4675. <member name="P:NAnt.DotNet.Types.NamespaceImport.IfDefined">
  4676. <summary>
  4677. Indicates if the import should be generated.
  4678. </summary>
  4679. <value>
  4680. <see langword="true" /> if the import should be generated; otherwise,
  4681. <see langword="false" />.
  4682. </value>
  4683. </member>
  4684. <member name="P:NAnt.DotNet.Types.NamespaceImport.UnlessDefined">
  4685. <summary>
  4686. Indicates if the import should be not generated.
  4687. </summary>
  4688. <value>
  4689. <see langword="true" /> if the import should be not generated;
  4690. otherwise, <see langword="false" />.
  4691. </value>
  4692. </member>
  4693. <member name="T:NAnt.DotNet.Types.NamespaceImportCollection">
  4694. <summary>
  4695. Contains a collection of <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> items.
  4696. </summary>
  4697. <example>
  4698. <para>Define a reference with name "system.imports".</para>
  4699. <code>
  4700. <![CDATA[
  4701. <namespaceimports id="system.imports">
  4702. <import namespace="System" />
  4703. <import namespace="System.Data" />
  4704. </namespaceimports>
  4705. ]]>
  4706. </code>
  4707. <para>Use the predefined set of imports to compile a VB.NET assembly.</para>
  4708. <code>
  4709. <![CDATA[
  4710. <vbc target="exe" output="HelloWorld.exe" rootnamespace="HelloWorld">
  4711. <imports refid="system.imports" />
  4712. <sources>
  4713. <include name="**/*.vb" />
  4714. </sources>
  4715. <references>
  4716. <include name="System.dll" />
  4717. <include name="System.Data.dll" />
  4718. </references>
  4719. </vbc>
  4720. ]]>
  4721. </code>
  4722. </example>
  4723. </member>
  4724. <member name="M:NAnt.DotNet.Types.NamespaceImportCollection.GetEnumerator">
  4725. <summary>
  4726. Returns an enumerator that can iterate through the collection.
  4727. </summary>
  4728. <returns>
  4729. A <see cref="T:NAnt.DotNet.Types.NamespaceImportEnumerator"/> for the entire collection.
  4730. </returns>
  4731. </member>
  4732. <member name="M:NAnt.DotNet.Types.NamespaceImportCollection.ToString">
  4733. <summary>
  4734. Returns a comma-delimited list of namespace imports.
  4735. </summary>
  4736. <returns>
  4737. A comma-delimited list of namespace imports, or an empty
  4738. <see cref="T:System.String"/> if there are no namespace imports.
  4739. </returns>
  4740. <remarks>
  4741. Each namespace import is quoted individually.
  4742. </remarks>
  4743. </member>
  4744. <member name="M:NAnt.DotNet.Types.NamespaceImportCollection.System#Collections#IList#Insert(System.Int32,System.Object)">
  4745. <summary>
  4746. Inserts a <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> into the collection at the
  4747. specified index.
  4748. </summary>
  4749. <param name="index">The zero-based index at which <paramref name="value"/> should be inserted.</param>
  4750. <param name="value">The <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> to insert.</param>
  4751. </member>
  4752. <member name="M:NAnt.DotNet.Types.NamespaceImportCollection.System#Collections#IList#Remove(System.Object)">
  4753. <summary>
  4754. Removes the specified <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> from the
  4755. collection.
  4756. </summary>
  4757. <param name="value">The <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> to remove from the collection.</param>
  4758. </member>
  4759. <member name="M:NAnt.DotNet.Types.NamespaceImportCollection.System#Collections#IList#Contains(System.Object)">
  4760. <summary>
  4761. Determines whether a <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> is in the collection.
  4762. </summary>
  4763. <param name="value">The <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> to locate in the collection.</param>
  4764. <returns>
  4765. <see langword="true"/> if <paramref name="value"/> is found in the
  4766. collection; otherwise, <see langword="false"/>.
  4767. </returns>
  4768. </member>
  4769. <member name="M:NAnt.DotNet.Types.NamespaceImportCollection.System#Collections#IList#IndexOf(System.Object)">
  4770. <summary>
  4771. Gets the location of a <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> in the collection.
  4772. </summary>
  4773. <param name="value">The <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> object to locate.</param>
  4774. <returns>
  4775. The zero-based location of the <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> in the
  4776. collection.
  4777. </returns>
  4778. <remarks>
  4779. If the <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> is not currently a member of
  4780. the collection, -1 is returned.
  4781. </remarks>
  4782. </member>
  4783. <member name="M:NAnt.DotNet.Types.NamespaceImportCollection.System#Collections#IList#Add(System.Object)">
  4784. <summary>
  4785. Adds a <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> to the end of the collection.
  4786. </summary>
  4787. <param name="value">The <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> to be added to the end of the collection.</param>
  4788. <returns>
  4789. The position into which the new item was inserted.
  4790. </returns>
  4791. </member>
  4792. <member name="M:NAnt.DotNet.Types.NamespaceImportCollection.AddRange(NAnt.DotNet.Types.NamespaceImportCollection)">
  4793. <summary>
  4794. Adds the items of a <see cref="T:NAnt.DotNet.Types.NamespaceImportCollection"/> to the end of the collection.
  4795. </summary>
  4796. <param name="items">The <see cref="T:NAnt.DotNet.Types.NamespaceImportCollection"/> to be added to the end of the collection.</param>
  4797. </member>
  4798. <member name="M:NAnt.DotNet.Types.NamespaceImportCollection.Add(NAnt.DotNet.Types.NamespaceImport)">
  4799. <summary>
  4800. Adds a <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> to the end of the collection.
  4801. </summary>
  4802. <param name="value">The <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> to be added to the end of the collection.</param>
  4803. <returns>
  4804. The position into which the new item was inserted.
  4805. </returns>
  4806. </member>
  4807. <member name="M:NAnt.DotNet.Types.NamespaceImportCollection.Insert(System.Int32,NAnt.DotNet.Types.NamespaceImport)">
  4808. <summary>
  4809. Inserts a <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> into the collection at the
  4810. specified index.
  4811. </summary>
  4812. <param name="index">The zero-based index at which <paramref name="value"/> should be inserted.</param>
  4813. <param name="value">The <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> to insert.</param>
  4814. </member>
  4815. <member name="M:NAnt.DotNet.Types.NamespaceImportCollection.Remove(NAnt.DotNet.Types.NamespaceImport)">
  4816. <summary>
  4817. Removes the specified <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> from the
  4818. collection.
  4819. </summary>
  4820. <param name="value">The <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> to remove from the collection.</param>
  4821. </member>
  4822. <member name="M:NAnt.DotNet.Types.NamespaceImportCollection.Contains(NAnt.DotNet.Types.NamespaceImport)">
  4823. <summary>
  4824. Determines whether a <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> is in the collection.
  4825. </summary>
  4826. <param name="value">The <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> to locate in the collection.</param>
  4827. <returns>
  4828. <see langword="true"/> if <paramref name="value"/> is found in the
  4829. collection; otherwise, <see langword="false"/>.
  4830. </returns>
  4831. </member>
  4832. <member name="M:NAnt.DotNet.Types.NamespaceImportCollection.IndexOf(NAnt.DotNet.Types.NamespaceImport)">
  4833. <summary>
  4834. Gets the location of a <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> in the collection.
  4835. </summary>
  4836. <param name="value">The <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> object to locate.</param>
  4837. <returns>
  4838. The zero-based location of the <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> in the
  4839. collection.
  4840. </returns>
  4841. <remarks>
  4842. If the <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> is not currently a member of
  4843. the collection, -1 is returned.
  4844. </remarks>
  4845. </member>
  4846. <member name="P:NAnt.DotNet.Types.NamespaceImportCollection.Item(System.Int32)">
  4847. <summary>
  4848. Gets or sets the item at the specified index.
  4849. </summary>
  4850. <param name="index">The zero-based index of the item to get or set.</param>
  4851. </member>
  4852. <member name="P:NAnt.DotNet.Types.NamespaceImportCollection.Item(System.String)">
  4853. <summary>
  4854. Gets the <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> with the specified namespace.
  4855. </summary>
  4856. <param name="value">The namespace of the <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> to get.</param>
  4857. </member>
  4858. <member name="P:NAnt.DotNet.Types.NamespaceImportCollection.ItemType">
  4859. <summary>
  4860. Gets the <see cref="T:System.Type"/> of the items in this collection.
  4861. </summary>
  4862. <value>
  4863. The <see cref="T:System.Type"/> of the items in this collection.
  4864. </value>
  4865. </member>
  4866. <member name="P:NAnt.DotNet.Types.NamespaceImportCollection.System#Collections#IList#$Item$(System.Int32)">
  4867. <summary>
  4868. Gets or sets the item at the specified index.
  4869. </summary>
  4870. <param name="index">The zero-based index of the item to get or set.</param>
  4871. </member>
  4872. <member name="T:NAnt.DotNet.Types.NamespaceImportEnumerator">
  4873. <summary>
  4874. Enumerates the <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> items of a <see cref="T:NAnt.DotNet.Types.NamespaceImportCollection"/>.
  4875. </summary>
  4876. </member>
  4877. <member name="M:NAnt.DotNet.Types.NamespaceImportEnumerator.#ctor(NAnt.DotNet.Types.NamespaceImportCollection)">
  4878. <summary>
  4879. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.NamespaceImportEnumerator"/> class
  4880. with the specified <see cref="T:NAnt.DotNet.Types.NamespaceImportCollection"/>.
  4881. </summary>
  4882. <param name="arguments">The collection that should be enumerated.</param>
  4883. </member>
  4884. <member name="M:NAnt.DotNet.Types.NamespaceImportEnumerator.MoveNext">
  4885. <summary>
  4886. Advances the enumerator to the next item of the collection.
  4887. </summary>
  4888. <returns>
  4889. <see langword="true" /> if the enumerator was successfully advanced
  4890. to the next item; <see langword="false" /> if the enumerator has
  4891. passed the end of the collection.
  4892. </returns>
  4893. </member>
  4894. <member name="M:NAnt.DotNet.Types.NamespaceImportEnumerator.Reset">
  4895. <summary>
  4896. Sets the enumerator to its initial position, which is before the
  4897. first item in the collection.
  4898. </summary>
  4899. </member>
  4900. <member name="P:NAnt.DotNet.Types.NamespaceImportEnumerator.Current">
  4901. <summary>
  4902. Gets the current item in the collection.
  4903. </summary>
  4904. <returns>
  4905. The current item in the collection.
  4906. </returns>
  4907. </member>
  4908. <member name="P:NAnt.DotNet.Types.NamespaceImportEnumerator.System#Collections#IEnumerator#Current">
  4909. <summary>
  4910. Gets the current item in the collection.
  4911. </summary>
  4912. <returns>
  4913. The current item in the collection.
  4914. </returns>
  4915. </member>
  4916. <member name="T:NAnt.DotNet.Types.Package">
  4917. <summary>
  4918. Represents a package.
  4919. </summary>
  4920. </member>
  4921. <member name="P:NAnt.DotNet.Types.Package.PackageName">
  4922. <summary>
  4923. Name of the package to reference. Multiple package can be specified
  4924. with a single element as a semi-colon separated list of
  4925. package names.
  4926. </summary>
  4927. </member>
  4928. <member name="P:NAnt.DotNet.Types.Package.IfDefined">
  4929. <summary>
  4930. Indicates if the package should be passed to the task.
  4931. If <see langword="true" /> then the package will be passed;
  4932. otherwise, skipped. The default is <see langword="true" />.
  4933. </summary>
  4934. </member>
  4935. <member name="P:NAnt.DotNet.Types.Package.UnlessDefined">
  4936. <summary>
  4937. Indicates if the package should not be passed to the task.
  4938. If <see langword="false" /> then the package will be passed;
  4939. otherwise, skipped. The default is <see langword="false" />.
  4940. </summary>
  4941. </member>
  4942. <member name="T:NAnt.DotNet.Types.PackageCollection">
  4943. <summary>
  4944. Contains a strongly typed collection of <see cref="T:NAnt.DotNet.Types.Package"/>
  4945. objects.
  4946. </summary>
  4947. </member>
  4948. <member name="M:NAnt.DotNet.Types.PackageCollection.#ctor">
  4949. <summary>
  4950. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.PackageCollection"/> class.
  4951. </summary>
  4952. </member>
  4953. <member name="M:NAnt.DotNet.Types.PackageCollection.#ctor(NAnt.DotNet.Types.PackageCollection)">
  4954. <summary>
  4955. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.PackageCollection"/> class
  4956. with the specified <see cref="T:NAnt.DotNet.Types.PackageCollection"/> instance.
  4957. </summary>
  4958. </member>
  4959. <member name="M:NAnt.DotNet.Types.PackageCollection.#ctor(NAnt.DotNet.Types.Package[])">
  4960. <summary>
  4961. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.PackageCollection"/> class
  4962. with the specified array of <see cref="T:NAnt.DotNet.Types.Package"/> instances.
  4963. </summary>
  4964. </member>
  4965. <member name="M:NAnt.DotNet.Types.PackageCollection.Add(NAnt.DotNet.Types.Package)">
  4966. <summary>
  4967. Adds a <see cref="T:NAnt.DotNet.Types.Package"/> to the end of the collection.
  4968. </summary>
  4969. <param name="item">The <see cref="T:NAnt.DotNet.Types.Package"/> to be added to the end of the collection.</param>
  4970. <returns>The position into which the new element was inserted.</returns>
  4971. </member>
  4972. <member name="M:NAnt.DotNet.Types.PackageCollection.AddRange(NAnt.DotNet.Types.Package[])">
  4973. <summary>
  4974. Adds the elements of a <see cref="T:NAnt.DotNet.Types.Package"/> array to the end of the collection.
  4975. </summary>
  4976. <param name="items">The array of <see cref="T:NAnt.DotNet.Types.Package"/> elements to be added to the end of the collection.</param>
  4977. </member>
  4978. <member name="M:NAnt.DotNet.Types.PackageCollection.AddRange(NAnt.DotNet.Types.PackageCollection)">
  4979. <summary>
  4980. Adds the elements of a <see cref="T:NAnt.DotNet.Types.PackageCollection"/> to the end of the collection.
  4981. </summary>
  4982. <param name="items">The <see cref="T:NAnt.DotNet.Types.PackageCollection"/> to be added to the end of the collection.</param>
  4983. </member>
  4984. <member name="M:NAnt.DotNet.Types.PackageCollection.Contains(NAnt.DotNet.Types.Package)">
  4985. <summary>
  4986. Determines whether a <see cref="T:NAnt.DotNet.Types.Package"/> is in the collection.
  4987. </summary>
  4988. <param name="item">The <see cref="T:NAnt.DotNet.Types.Package"/> to locate in the collection.</param>
  4989. <returns>
  4990. <see langword="true"/> if <paramref name="item"/> is found in the
  4991. collection; otherwise, <see langword="false"/>.
  4992. </returns>
  4993. </member>
  4994. <member name="M:NAnt.DotNet.Types.PackageCollection.CopyTo(NAnt.DotNet.Types.Package[],System.Int32)">
  4995. <summary>
  4996. Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
  4997. </summary>
  4998. <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
  4999. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  5000. </member>
  5001. <member name="M:NAnt.DotNet.Types.PackageCollection.IndexOf(NAnt.DotNet.Types.Package)">
  5002. <summary>
  5003. Retrieves the index of a specified <see cref="T:NAnt.DotNet.Types.Package"/> object in the collection.
  5004. </summary>
  5005. <param name="item">The <see cref="T:NAnt.DotNet.Types.Package"/> object for which the index is returned.</param>
  5006. <returns>
  5007. The index of the specified <see cref="T:NAnt.DotNet.Types.Package"/>. If the <see cref="T:NAnt.DotNet.Types.Package"/> is not currently a member of the collection, it returns -1.
  5008. </returns>
  5009. </member>
  5010. <member name="M:NAnt.DotNet.Types.PackageCollection.Insert(System.Int32,NAnt.DotNet.Types.Package)">
  5011. <summary>
  5012. Inserts a <see cref="T:NAnt.DotNet.Types.Package"/> into the collection at the specified index.
  5013. </summary>
  5014. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  5015. <param name="item">The <see cref="T:NAnt.DotNet.Types.Package"/> to insert.</param>
  5016. </member>
  5017. <member name="M:NAnt.DotNet.Types.PackageCollection.GetEnumerator">
  5018. <summary>
  5019. Returns an enumerator that can iterate through the collection.
  5020. </summary>
  5021. <returns>
  5022. A <see cref="T:NAnt.DotNet.Types.PackageEnumerator"/> for the entire collection.
  5023. </returns>
  5024. </member>
  5025. <member name="M:NAnt.DotNet.Types.PackageCollection.Remove(NAnt.DotNet.Types.Package)">
  5026. <summary>
  5027. Removes a member from the collection.
  5028. </summary>
  5029. <param name="item">The <see cref="T:NAnt.DotNet.Types.Package"/> to remove from the collection.</param>
  5030. </member>
  5031. <member name="P:NAnt.DotNet.Types.PackageCollection.Item(System.Int32)">
  5032. <summary>
  5033. Gets or sets the element at the specified index.
  5034. </summary>
  5035. <param name="index">The zero-based index of the element to get or set.</param>
  5036. </member>
  5037. <member name="T:NAnt.DotNet.Types.PackageEnumerator">
  5038. <summary>
  5039. Enumerates the <see cref="T:NAnt.DotNet.Types.Package"/> elements of a <see cref="T:NAnt.DotNet.Types.PackageCollection"/>.
  5040. </summary>
  5041. </member>
  5042. <member name="M:NAnt.DotNet.Types.PackageEnumerator.#ctor(NAnt.DotNet.Types.PackageCollection)">
  5043. <summary>
  5044. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.PackageEnumerator"/> class
  5045. with the specified <see cref="T:NAnt.DotNet.Types.PackageCollection"/>.
  5046. </summary>
  5047. <param name="arguments">The collection that should be enumerated.</param>
  5048. </member>
  5049. <member name="M:NAnt.DotNet.Types.PackageEnumerator.MoveNext">
  5050. <summary>
  5051. Advances the enumerator to the next element of the collection.
  5052. </summary>
  5053. <returns>
  5054. <see langword="true" /> if the enumerator was successfully advanced
  5055. to the next element; <see langword="false" /> if the enumerator has
  5056. passed the end of the collection.
  5057. </returns>
  5058. </member>
  5059. <member name="M:NAnt.DotNet.Types.PackageEnumerator.Reset">
  5060. <summary>
  5061. Sets the enumerator to its initial position, which is before the
  5062. first element in the collection.
  5063. </summary>
  5064. </member>
  5065. <member name="P:NAnt.DotNet.Types.PackageEnumerator.Current">
  5066. <summary>
  5067. Gets the current element in the collection.
  5068. </summary>
  5069. <returns>
  5070. The current element in the collection.
  5071. </returns>
  5072. </member>
  5073. <member name="T:NAnt.DotNet.Types.ResourceFileSet">
  5074. <summary>
  5075. Specialized <see cref="T:NAnt.Core.Types.FileSet"/> class for managing resource files.
  5076. </summary>
  5077. </member>
  5078. <member name="M:NAnt.DotNet.Types.ResourceFileSet.#ctor">
  5079. <summary>
  5080. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> class.
  5081. </summary>
  5082. </member>
  5083. <member name="M:NAnt.DotNet.Types.ResourceFileSet.#ctor(NAnt.Core.Types.FileSet)">
  5084. <summary>
  5085. copy constructor for FileSet. Required in order to
  5086. assign references of FileSet type where
  5087. ResourceFileSet are used
  5088. </summary>
  5089. <param name="fs"></param>
  5090. </member>
  5091. <member name="M:NAnt.DotNet.Types.ResourceFileSet.Clone">
  5092. <summary>
  5093. Creates a shallow copy of the <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/>.
  5094. </summary>
  5095. <returns>
  5096. A shallow copy of the <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/>.
  5097. </returns>
  5098. </member>
  5099. <member name="M:NAnt.DotNet.Types.ResourceFileSet.GetManifestResourceName(System.String)">
  5100. <summary>
  5101. Gets the manifest resource name for the specified resource file.
  5102. </summary>
  5103. <param name="resourceFile">The physical path of the resource file.</param>
  5104. <returns>
  5105. The manifest resource name to be sent to the compiler.
  5106. </returns>
  5107. </member>
  5108. <member name="M:NAnt.DotNet.Types.ResourceFileSet.GetManifestResourceName(System.String,System.String)">
  5109. <summary>
  5110. Gets the manifest resource name for the file using both its physical
  5111. and logical path.
  5112. </summary>
  5113. <param name="physicalPath">The physical path of the resource file.</param>
  5114. <param name="logicalPath">The logical location of the resource file.</param>
  5115. <returns>
  5116. The manifest resource name to be sent to the compiler.
  5117. </returns>
  5118. <remarks>
  5119. We use the relative path of the logical path, but the filename and
  5120. and the extension of the physical path to match VS.NET
  5121. </remarks>
  5122. </member>
  5123. <member name="P:NAnt.DotNet.Types.ResourceFileSet.Prefix">
  5124. <summary>
  5125. Indicates the prefix to prepend to the actual resource.
  5126. This is usually the default namspace of the assembly.
  5127. </summary>
  5128. </member>
  5129. <member name="P:NAnt.DotNet.Types.ResourceFileSet.DynamicPrefix">
  5130. <summary>
  5131. Indicates whether prefixes should be dynamically generated by taking
  5132. the path of the resource relative to the basedir and appending it
  5133. to the specified prefix. The default is <see langword="false" />.
  5134. </summary>
  5135. </member>
  5136. <member name="P:NAnt.DotNet.Types.ResourceFileSet.ResxFiles">
  5137. <summary>
  5138. Gets a <see cref="T:NAnt.Core.Types.FileSet"/> containing all matching resx files.
  5139. </summary>
  5140. <value>
  5141. A <see cref="T:NAnt.Core.Types.FileSet"/> containing all matching resx files.
  5142. </value>
  5143. </member>
  5144. <member name="P:NAnt.DotNet.Types.ResourceFileSet.NonResxFiles">
  5145. <summary>
  5146. Gets a <see cref="T:NAnt.Core.Types.FileSet"/> containing all matching non-resx
  5147. files.
  5148. </summary>
  5149. <value>
  5150. A <see cref="T:NAnt.Core.Types.FileSet"/> containing all matching non-resx files.
  5151. </value>
  5152. </member>
  5153. <member name="T:NAnt.DotNet.Types.ResourceFileSetCollection">
  5154. <summary>
  5155. Contains a strongly typed collection of <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> objects.
  5156. </summary>
  5157. </member>
  5158. <member name="M:NAnt.DotNet.Types.ResourceFileSetCollection.#ctor">
  5159. <summary>
  5160. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.ResourceFileSetCollection"/> class.
  5161. </summary>
  5162. </member>
  5163. <member name="M:NAnt.DotNet.Types.ResourceFileSetCollection.#ctor(NAnt.DotNet.Types.ResourceFileSetCollection)">
  5164. <summary>
  5165. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.ResourceFileSetCollection"/> class
  5166. with the specified <see cref="T:NAnt.DotNet.Types.ResourceFileSetCollection"/> instance.
  5167. </summary>
  5168. </member>
  5169. <member name="M:NAnt.DotNet.Types.ResourceFileSetCollection.#ctor(NAnt.DotNet.Types.ResourceFileSet[])">
  5170. <summary>
  5171. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.ResourceFileSetCollection"/> class
  5172. with the specified array of <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> instances.
  5173. </summary>
  5174. </member>
  5175. <member name="M:NAnt.DotNet.Types.ResourceFileSetCollection.Add(NAnt.DotNet.Types.ResourceFileSet)">
  5176. <summary>
  5177. Adds a <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> to the end of the collection.
  5178. </summary>
  5179. <param name="item">The <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> to be added to the end of the collection.</param>
  5180. <returns>The position into which the new element was inserted.</returns>
  5181. </member>
  5182. <member name="M:NAnt.DotNet.Types.ResourceFileSetCollection.AddRange(NAnt.DotNet.Types.ResourceFileSet[])">
  5183. <summary>
  5184. Adds the elements of a <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> array to the end of the collection.
  5185. </summary>
  5186. <param name="items">The array of <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> elements to be added to the end of the collection.</param>
  5187. </member>
  5188. <member name="M:NAnt.DotNet.Types.ResourceFileSetCollection.AddRange(NAnt.DotNet.Types.ResourceFileSetCollection)">
  5189. <summary>
  5190. Adds the elements of a <see cref="T:NAnt.DotNet.Types.ResourceFileSetCollection"/> to the end of the collection.
  5191. </summary>
  5192. <param name="items">The <see cref="T:NAnt.DotNet.Types.ResourceFileSetCollection"/> to be added to the end of the collection.</param>
  5193. </member>
  5194. <member name="M:NAnt.DotNet.Types.ResourceFileSetCollection.Contains(NAnt.DotNet.Types.ResourceFileSet)">
  5195. <summary>
  5196. Determines whether a <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> is in the collection.
  5197. </summary>
  5198. <param name="item">The <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> to locate in the collection.</param>
  5199. <returns>
  5200. <see langword="true"/> if <paramref name="item"/> is found in the
  5201. collection; otherwise, <see langword="false"/>.
  5202. </returns>
  5203. </member>
  5204. <member name="M:NAnt.DotNet.Types.ResourceFileSetCollection.CopyTo(NAnt.DotNet.Types.ResourceFileSet[],System.Int32)">
  5205. <summary>
  5206. Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
  5207. </summary>
  5208. <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
  5209. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  5210. </member>
  5211. <member name="M:NAnt.DotNet.Types.ResourceFileSetCollection.IndexOf(NAnt.DotNet.Types.ResourceFileSet)">
  5212. <summary>
  5213. Retrieves the index of a specified <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> object in the collection.
  5214. </summary>
  5215. <param name="item">The <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> object for which the index is returned.</param>
  5216. <returns>
  5217. The index of the specified <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/>. If the <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> is not currently a member of the collection, it returns -1.
  5218. </returns>
  5219. </member>
  5220. <member name="M:NAnt.DotNet.Types.ResourceFileSetCollection.Insert(System.Int32,NAnt.DotNet.Types.ResourceFileSet)">
  5221. <summary>
  5222. Inserts a <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> into the collection at the specified index.
  5223. </summary>
  5224. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  5225. <param name="item">The <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> to insert.</param>
  5226. </member>
  5227. <member name="M:NAnt.DotNet.Types.ResourceFileSetCollection.GetEnumerator">
  5228. <summary>
  5229. Returns an enumerator that can iterate through the collection.
  5230. </summary>
  5231. <returns>
  5232. A <see cref="T:NAnt.DotNet.Types.ResourceFileSetEnumerator"/> for the entire collection.
  5233. </returns>
  5234. </member>
  5235. <member name="M:NAnt.DotNet.Types.ResourceFileSetCollection.Remove(NAnt.DotNet.Types.ResourceFileSet)">
  5236. <summary>
  5237. Removes a member from the collection.
  5238. </summary>
  5239. <param name="item">The <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> to remove from the collection.</param>
  5240. </member>
  5241. <member name="P:NAnt.DotNet.Types.ResourceFileSetCollection.Item(System.Int32)">
  5242. <summary>
  5243. Gets or sets the element at the specified index.
  5244. </summary>
  5245. <param name="index">The zero-based index of the element to get or set.</param>
  5246. </member>
  5247. <member name="T:NAnt.DotNet.Types.ResourceFileSetEnumerator">
  5248. <summary>
  5249. Enumerates the <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> elements of a <see cref="T:NAnt.DotNet.Types.ResourceFileSetCollection"/>.
  5250. </summary>
  5251. </member>
  5252. <member name="M:NAnt.DotNet.Types.ResourceFileSetEnumerator.#ctor(NAnt.DotNet.Types.ResourceFileSetCollection)">
  5253. <summary>
  5254. Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.ResourceFileSetEnumerator"/> class
  5255. with the specified <see cref="T:NAnt.DotNet.Types.ResourceFileSetCollection"/>.
  5256. </summary>
  5257. <param name="arguments">The collection that should be enumerated.</param>
  5258. </member>
  5259. <member name="M:NAnt.DotNet.Types.ResourceFileSetEnumerator.MoveNext">
  5260. <summary>
  5261. Advances the enumerator to the next element of the collection.
  5262. </summary>
  5263. <returns>
  5264. <see langword="true" /> if the enumerator was successfully advanced
  5265. to the next element; <see langword="false" /> if the enumerator has
  5266. passed the end of the collection.
  5267. </returns>
  5268. </member>
  5269. <member name="M:NAnt.DotNet.Types.ResourceFileSetEnumerator.Reset">
  5270. <summary>
  5271. Sets the enumerator to its initial position, which is before the
  5272. first element in the collection.
  5273. </summary>
  5274. </member>
  5275. <member name="P:NAnt.DotNet.Types.ResourceFileSetEnumerator.Current">
  5276. <summary>
  5277. Gets the current element in the collection.
  5278. </summary>
  5279. <returns>
  5280. The current element in the collection.
  5281. </returns>
  5282. </member>
  5283. <member name="T:NAnt.DotNet.Types.WarningAsError">
  5284. <summary>
  5285. Controls the behaviour of a compiler with regards to the reporting of
  5286. warnings.
  5287. </summary>
  5288. <example>
  5289. <para>
  5290. Instruct a compiler to report warning 0519 as an error.
  5291. </para>
  5292. <code>
  5293. <![CDATA[
  5294. <warnaserror>
  5295. <include number="0519" />
  5296. </warnaserror>
  5297. ]]>
  5298. </code>
  5299. </example>
  5300. <example>
  5301. <para>
  5302. Instruct a compiler not to report warning 0519 as an error, if the
  5303. <c>release</c> property is <see langword="true" />.
  5304. </para>
  5305. <code>
  5306. <![CDATA[
  5307. <warnaserror>
  5308. <exclude number="0519" if="${release}" />
  5309. </warnaserror>
  5310. ]]>
  5311. </code>
  5312. </example>
  5313. </member>
  5314. <member name="P:NAnt.DotNet.Types.WarningAsError.Includes">
  5315. <summary>
  5316. Specifies a list of warnings that the compiler should treat as
  5317. errors. This overrides the <see cref="P:NAnt.DotNet.Tasks.CompilerBase.WarnAsError"/>
  5318. attribute. Only supported when targeting .NET 2.0 or higher.
  5319. </summary>
  5320. </member>
  5321. <member name="P:NAnt.DotNet.Types.WarningAsError.Excludes">
  5322. <summary>
  5323. Specifies a list of warnings that the compiler should NOT treat as
  5324. errors. This is only useful if <see cref="P:NAnt.DotNet.Tasks.CompilerBase.WarnAsError"/>
  5325. is <see langword="true"/>. Only supported when targeting .NET 2.0
  5326. or higher.
  5327. </summary>
  5328. </member>
  5329. </members>
  5330. </doc>