/tools/nant/NAnt.Core.xml

http://github.com/philiplaureano/LinFu · XML · 16161 lines · 16136 code · 24 blank · 1 comment · 0 complexity · fbb84cdf29ffa44e9e2c7beaee9a47da MD5 · raw file

Large files are truncated click here to view the full file

  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>NAnt.Core</name>
  5. </assembly>
  6. <members>
  7. <member name="T:NAnt.Core.Attributes.BooleanValidatorAttribute">
  8. <summary>
  9. Used to indicate that a property should be able to be converted into a
  10. <see cref="T:System.Boolean"/>.
  11. </summary>
  12. </member>
  13. <member name="T:NAnt.Core.Attributes.ValidatorAttribute">
  14. <summary>
  15. Base class for all validator attributes.
  16. </summary>
  17. </member>
  18. <member name="M:NAnt.Core.Attributes.ValidatorAttribute.Validate(System.Object)">
  19. <summary>
  20. Validates the specified value.
  21. </summary>
  22. <param name="value">The value to be validated.</param>
  23. <exception cref="T:NAnt.Core.ValidationException">The validation fails.</exception>
  24. </member>
  25. <member name="M:NAnt.Core.Attributes.BooleanValidatorAttribute.#ctor">
  26. <summary>
  27. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BooleanValidatorAttribute"/>
  28. class.
  29. </summary>
  30. </member>
  31. <member name="M:NAnt.Core.Attributes.BooleanValidatorAttribute.Validate(System.Object)">
  32. <summary>
  33. Checks if the specified value can be converted to a <see cref="T:System.Boolean"/>.
  34. </summary>
  35. <param name="value">The value to be checked.</param>
  36. <exception cref="T:NAnt.Core.ValidationException"><paramref name="value"/> cannot be converted to a <see cref="T:System.Boolean"/>.</exception>
  37. </member>
  38. <member name="T:NAnt.Core.Attributes.BuildAttributeAttribute">
  39. <summary>
  40. Indicates that property should be treated as a XML attribute for the
  41. task.
  42. </summary>
  43. <example>
  44. Examples of how to specify task attributes
  45. <code>
  46. #region Public Instance Properties
  47. [BuildAttribute("out", Required=true)]
  48. public string Output {
  49. get { return _out; }
  50. set { _out = value; }
  51. }
  52. [BuildAttribute("optimize")]
  53. [BooleanValidator()]
  54. public bool Optimize {
  55. get { return _optimize; }
  56. set { _optimize = value; }
  57. }
  58. [BuildAttribute("warnlevel")]
  59. [Int32Validator(0,4)] // limit values to 0-4
  60. public int WarnLevel {
  61. get { return _warnLevel; }
  62. set { _warnLevel = value; }
  63. }
  64. [BuildElement("sources")]
  65. public FileSet Sources {
  66. get { return _sources; }
  67. set { _sources = value; }
  68. }
  69. #endregion Public Instance Properties
  70. #region Private Instance Fields
  71. private string _out = null;
  72. private bool _optimize = false;
  73. private int _warnLevel = 4;
  74. private FileSet _sources = new FileSet();
  75. #endregion Private Instance Fields
  76. </code>
  77. </example>
  78. </member>
  79. <member name="M:NAnt.Core.Attributes.BuildAttributeAttribute.#ctor(System.String)">
  80. <summary>
  81. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildAttributeAttribute"/> with the
  82. specified name.
  83. </summary>
  84. <param name="name">The name of the attribute.</param>
  85. <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
  86. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
  87. </member>
  88. <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.Name">
  89. <summary>
  90. Gets or sets the name of the XML attribute.
  91. </summary>
  92. <value>
  93. The name of the XML attribute.
  94. </value>
  95. </member>
  96. <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.Required">
  97. <summary>
  98. Gets or sets a value indicating whether the attribute is required.
  99. </summary>
  100. <value>
  101. <see langword="true" /> if the attribute is required; otherwise,
  102. <see langword="false" />. The default is <see langword="false" />.
  103. </value>
  104. </member>
  105. <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.ExpandProperties">
  106. <summary>
  107. Gets or sets a value indicating whether property references should
  108. be expanded.
  109. </summary>
  110. <value>
  111. <see langword="true" /> if properties should be expanded; otherwise
  112. <see langword="false" />. The default is <see langword="true" />.
  113. </value>
  114. </member>
  115. <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.ProcessXml">
  116. <summary>
  117. Used to specify how this attribute will be handled as the XML is
  118. parsed and given to the element.
  119. </summary>
  120. <value>
  121. <see langword="true" /> if XML should be processed; otherwise
  122. <see langword="false" />. The default is <see langword="true" />.
  123. </value>
  124. </member>
  125. <member name="T:NAnt.Core.Attributes.BuildElementArrayAttribute">
  126. <summary>
  127. Indicates that property should be treated as a XML arrayList
  128. </summary>
  129. <remarks>
  130. <para>
  131. Should only be applied to properties exposing strongly typed arrays or
  132. strongly typed collections.
  133. </para>
  134. <para>
  135. The XML format is like this:
  136. <code>
  137. <![CDATA[
  138. <task>
  139. <elementName ... />
  140. <elementName ... />
  141. <elementName ... />
  142. <elementName ... />
  143. </task>
  144. ]]>
  145. </code>
  146. </para>
  147. </remarks>
  148. </member>
  149. <member name="T:NAnt.Core.Attributes.BuildElementAttribute">
  150. <summary>
  151. Indicates that the property should be treated as an XML element and
  152. further processing should be done.
  153. </summary>
  154. <remarks>
  155. <para>
  156. The XML format is like this:
  157. <code>
  158. <![CDATA[
  159. <task>
  160. <elementName ...>
  161. <morestuff />
  162. </elementName>
  163. </task>
  164. ]]>
  165. </code>
  166. </para>
  167. </remarks>
  168. </member>
  169. <member name="M:NAnt.Core.Attributes.BuildElementAttribute.#ctor(System.String)">
  170. <summary>
  171. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildElementAttribute"/> with the
  172. specified name.
  173. </summary>
  174. <param name="name">The name of the attribute.</param>
  175. <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
  176. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
  177. </member>
  178. <member name="P:NAnt.Core.Attributes.BuildElementAttribute.Name">
  179. <summary>
  180. Gets or sets the name of the attribute.
  181. </summary>
  182. <value>
  183. The name of the attribute.
  184. </value>
  185. </member>
  186. <member name="P:NAnt.Core.Attributes.BuildElementAttribute.Required">
  187. <summary>
  188. Gets or sets a value indicating whether the attribute is required.
  189. </summary>
  190. <value>
  191. <see langword="true" /> if the attribute is required; otherwise,
  192. <see langword="false" />. The default is <see langword="false" />.
  193. </value>
  194. </member>
  195. <member name="P:NAnt.Core.Attributes.BuildElementAttribute.ProcessXml">
  196. <summary>
  197. Used to specify how this element will be handled as the XML is parsed
  198. and given to the element.
  199. </summary>
  200. <value>
  201. <see langword="true" /> if XML should be processed; otherwise
  202. <see langword="false" />. The default is <see langword="true" />.
  203. </value>
  204. </member>
  205. <member name="M:NAnt.Core.Attributes.BuildElementArrayAttribute.#ctor(System.String)">
  206. <summary>
  207. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildElementArrayAttribute"/>
  208. with the specified name.
  209. </summary>
  210. <param name="name">The name of the attribute.</param>
  211. <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
  212. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
  213. </member>
  214. <member name="P:NAnt.Core.Attributes.BuildElementArrayAttribute.ElementType">
  215. <summary>
  216. Gets or sets the type of objects that this container holds.
  217. </summary>
  218. <value>
  219. The type of the elements that this container holds.
  220. </value>
  221. <remarks>
  222. <para>
  223. This can be used for validation and schema generation.
  224. </para>
  225. <para>
  226. If not specified, the type of the elements will be determined using
  227. reflection.
  228. </para>
  229. </remarks>
  230. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <see langword="null"/>.</exception>
  231. </member>
  232. <member name="T:NAnt.Core.Attributes.BuildElementCollectionAttribute">
  233. <summary>
  234. Indicates that the property should be treated as a container for a
  235. collection of build elements.
  236. </summary>
  237. <remarks>
  238. <para>
  239. Should only be applied to properties exposing strongly typed arrays or
  240. strongly typed collections.
  241. </para>
  242. <para>
  243. The XML format is like this:
  244. <code>
  245. <![CDATA[
  246. <task>
  247. <collectionName>
  248. <elementName ... />
  249. <elementName ... />
  250. <elementName ... />
  251. <elementName ... />
  252. </collectionName>
  253. </task>
  254. ]]>
  255. </code>
  256. </para>
  257. </remarks>
  258. </member>
  259. <member name="M:NAnt.Core.Attributes.BuildElementCollectionAttribute.#ctor(System.String,System.String)">
  260. <summary>
  261. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildElementCollectionAttribute"/> with the
  262. specified name and child element name.
  263. </summary>
  264. <param name="collectionName">The name of the collection.</param>
  265. <param name="childName">The name of the child elements in the collection</param>
  266. <exception cref="T:System.ArgumentNullException"><paramref name="childName"/> is <see langword="null"/>.</exception>
  267. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="childName"/> is a zero-length <see cref="T:System.String"/>.</exception>
  268. </member>
  269. <member name="P:NAnt.Core.Attributes.BuildElementCollectionAttribute.ChildElementName">
  270. <summary>
  271. The name of the child element within the collection.
  272. </summary>
  273. <value>
  274. The name to check for in the XML of the elements in the collection.
  275. </value>
  276. <remarks>
  277. This can be used for validation and schema generation.
  278. </remarks>
  279. </member>
  280. <member name="T:NAnt.Core.Attributes.DateTimeValidatorAttribute">
  281. <summary>
  282. Used to indicate that a property should be able to be converted into a
  283. <see cref="T:System.DateTime"/>.
  284. </summary>
  285. </member>
  286. <member name="M:NAnt.Core.Attributes.DateTimeValidatorAttribute.#ctor">
  287. <summary>
  288. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.DateTimeValidatorAttribute"/>
  289. class.
  290. </summary>
  291. </member>
  292. <member name="M:NAnt.Core.Attributes.DateTimeValidatorAttribute.Validate(System.Object)">
  293. <summary>
  294. Checks if the specified value can be converted to a <see cref="T:System.DateTime"/>.
  295. </summary>
  296. <param name="value">The value to be checked.</param>
  297. <exception cref="T:NAnt.Core.ValidationException"><paramref name="value"/> cannot be converted to a <see cref="T:System.DateTime"/>.</exception>
  298. </member>
  299. <member name="T:NAnt.Core.Attributes.ElementNameAttribute">
  300. <summary>
  301. Indicates that class should be treated as a NAnt element.
  302. </summary>
  303. <remarks>
  304. Attach this attribute to a subclass of Element to have NAnt be able
  305. to recognize it. The name should be short but must not confict
  306. with any other element already in use.
  307. </remarks>
  308. </member>
  309. <member name="M:NAnt.Core.Attributes.ElementNameAttribute.#ctor(System.String)">
  310. <summary>
  311. Initializes a new instance of the <see cre="ElementNameAttribute"/>
  312. with the specified name.
  313. </summary>
  314. <param name="name">The name of the element.</param>
  315. <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
  316. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
  317. </member>
  318. <member name="P:NAnt.Core.Attributes.ElementNameAttribute.Name">
  319. <summary>
  320. Gets or sets the name of the element.
  321. </summary>
  322. <value>
  323. The name of the element.
  324. </value>
  325. </member>
  326. <member name="T:NAnt.Core.Attributes.FileSetAttribute">
  327. <summary>
  328. Indicates that a property should be treated as a XML file set for the
  329. task.
  330. </summary>
  331. </member>
  332. <member name="M:NAnt.Core.Attributes.FileSetAttribute.#ctor(System.String)">
  333. <summary>
  334. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FileSetAttribute"/> with the
  335. specified name.
  336. </summary>
  337. <param name="name">The name of the attribute.</param>
  338. <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
  339. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
  340. </member>
  341. <member name="T:NAnt.Core.Attributes.FrameworkConfigurableAttribute">
  342. <summary>
  343. Indicates that the value of the property to which the attribute is
  344. assigned, can be configured on the framework-level in the NAnt application
  345. configuration file.
  346. </summary>
  347. <example>
  348. <para>
  349. The following example shows a property of which the value can be
  350. configured for a specific framework in the NAnt configuration file.
  351. </para>
  352. <code lang="C#">
  353. [FrameworkConfigurable("exename", Required=true)]
  354. public virtual string ExeName {
  355. get { return _exeName; }
  356. set { _exeName = value; }
  357. }
  358. </code>
  359. </example>
  360. </member>
  361. <member name="M:NAnt.Core.Attributes.FrameworkConfigurableAttribute.#ctor(System.String)">
  362. <summary>
  363. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FrameworkConfigurableAttribute"/>
  364. with the specified attribute name.
  365. </summary>
  366. <param name="name">The name of the framework configuration attribute.</param>
  367. <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is a <see langword="null"/>.</exception>
  368. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
  369. </member>
  370. <member name="P:NAnt.Core.Attributes.FrameworkConfigurableAttribute.Name">
  371. <summary>
  372. Gets or sets the name of the framework configuration attribute.
  373. </summary>
  374. <value>The name of the framework configuration attribute.</value>
  375. </member>
  376. <member name="P:NAnt.Core.Attributes.FrameworkConfigurableAttribute.Required">
  377. <summary>
  378. Gets or sets a value indicating whether the configuration attribute
  379. is required.
  380. </summary>
  381. <value>
  382. <see langword="true" /> if the configuration attribute is required;
  383. otherwise, <see langword="true" />. The default is <see langword="false" />.
  384. </value>
  385. </member>
  386. <member name="P:NAnt.Core.Attributes.FrameworkConfigurableAttribute.ExpandProperties">
  387. <summary>
  388. Gets or sets a value indicating whether property references should
  389. be expanded.
  390. </summary>
  391. <value>
  392. <see langword="true" /> if properties should be expanded; otherwise
  393. <see langword="false" />. The default is <see langword="true" />.
  394. </value>
  395. </member>
  396. <member name="T:NAnt.Core.Attributes.FunctionAttribute">
  397. <summary>
  398. Indicates that the method should be exposed as a function in NAnt build
  399. files.
  400. </summary>
  401. <remarks>
  402. Attach this attribute to a method of a class that derives from
  403. <see cref="T:NAnt.Core.FunctionSetBase"/> to have NAnt be able to recognize it.
  404. </remarks>
  405. </member>
  406. <member name="M:NAnt.Core.Attributes.FunctionAttribute.#ctor(System.String)">
  407. <summary>
  408. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FunctionAttribute"/>
  409. class with the specified name.
  410. </summary>
  411. <param name="name">The name of the function.</param>
  412. <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
  413. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
  414. </member>
  415. <member name="P:NAnt.Core.Attributes.FunctionAttribute.Name">
  416. <summary>
  417. Gets or sets the name of the function.
  418. </summary>
  419. <value>
  420. The name of the function.
  421. </value>
  422. </member>
  423. <member name="T:NAnt.Core.Attributes.FunctionSetAttribute">
  424. <summary>
  425. Indicates that class should be treated as a set of functions.
  426. </summary>
  427. <remarks>
  428. Attach this attribute to a class that derives from <see cref="T:NAnt.Core.FunctionSetBase"/>
  429. to have NAnt be able to recognize it as containing custom functions.
  430. </remarks>
  431. </member>
  432. <member name="M:NAnt.Core.Attributes.FunctionSetAttribute.#ctor(System.String,System.String)">
  433. <summary>
  434. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FunctionSetAttribute"/>
  435. class with the specified name.
  436. </summary>
  437. <param name="prefix">The prefix used to distinguish the functions.</param>
  438. <param name="category">The category of the functions.</param>
  439. <exception cref="T:System.ArgumentNullException">
  440. <para><paramref name="prefix"/> is <see langword="null"/>.</para>
  441. <para>-or-</para>
  442. <para><paramref name="category"/> is <see langword="null"/>.</para>
  443. </exception>
  444. <exception cref="T:System.ArgumentOutOfRangeException">
  445. <para><paramref name="prefix"/> is a zero-length <see cref="T:System.String"/>.</para>
  446. <para>-or-</para>
  447. <para><paramref name="category"/> is a zero-length <see cref="T:System.String"/>.</para>
  448. </exception>
  449. </member>
  450. <member name="P:NAnt.Core.Attributes.FunctionSetAttribute.Category">
  451. <summary>
  452. Gets or sets the category of the function set.
  453. </summary>
  454. <value>
  455. The name of the category of the function set.
  456. </value>
  457. <remarks>
  458. This will be displayed in the user docs.
  459. </remarks>
  460. </member>
  461. <member name="P:NAnt.Core.Attributes.FunctionSetAttribute.Prefix">
  462. <summary>
  463. Gets or sets the prefix of all functions in this function set.
  464. </summary>
  465. <value>
  466. The prefix of the functions in this function set.
  467. </value>
  468. </member>
  469. <member name="T:NAnt.Core.Attributes.Int32ValidatorAttribute">
  470. <summary>
  471. Indicates that property should be able to be converted into a <see cref="T:System.Int32"/>
  472. within the given range.
  473. </summary>
  474. </member>
  475. <member name="M:NAnt.Core.Attributes.Int32ValidatorAttribute.#ctor">
  476. <summary>
  477. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.Int32ValidatorAttribute"/>
  478. class.
  479. </summary>
  480. </member>
  481. <member name="M:NAnt.Core.Attributes.Int32ValidatorAttribute.#ctor(System.Int32,System.Int32)">
  482. <summary>
  483. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.Int32ValidatorAttribute"/>
  484. class with the specied minimum and maximum values.
  485. </summary>
  486. <param name="minValue">The minimum value.</param>
  487. <param name="maxValue">The maximum value.</param>
  488. </member>
  489. <member name="M:NAnt.Core.Attributes.Int32ValidatorAttribute.Validate(System.Object)">
  490. <summary>
  491. Checks whether the specified value can be converted to an <see cref="T:System.Int32"/>
  492. and whether the value lies within the range defined by the <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MinValue"/>
  493. and <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MaxValue"/> properties.
  494. </summary>
  495. <param name="value">The value to be checked.</param>
  496. <exception cref="T:NAnt.Core.ValidationException">
  497. <para>
  498. <paramref name="value"/> cannot be converted to an <see cref="T:System.Int32"/>.
  499. </para>
  500. <para>-or-</para>
  501. <para>
  502. <paramref name="value"/> is not in the range defined by <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MinValue"/>
  503. and <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MaxValue"/>.
  504. </para>
  505. </exception>
  506. </member>
  507. <member name="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MinValue">
  508. <summary>
  509. Gets or sets the minimum value.
  510. </summary>
  511. <value>
  512. The minimum value. The default is <see cref="F:System.Int32.MinValue"/>.
  513. </value>
  514. </member>
  515. <member name="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MaxValue">
  516. <summary>
  517. Gets or sets the maximum value.
  518. </summary>
  519. <value>
  520. The maximum value. The default is <see cref="F:System.Int32.MaxValue"/>.
  521. </value>
  522. </member>
  523. <member name="P:NAnt.Core.Attributes.Int32ValidatorAttribute.Base">
  524. <summary>
  525. The base of the number to validate, which must be 2, 8, 10, or 16.
  526. </summary>
  527. <value>
  528. The base of the number to validate.
  529. </value>
  530. <remarks>
  531. The default is 10.
  532. </remarks>
  533. </member>
  534. <member name="T:NAnt.Core.Attributes.LocationType">
  535. <summary>
  536. Defines possible locations in which a task executable can be located.
  537. </summary>
  538. </member>
  539. <member name="F:NAnt.Core.Attributes.LocationType.FrameworkDir">
  540. <summary>
  541. Locates the task executable in the current Framework directory.
  542. </summary>
  543. </member>
  544. <member name="F:NAnt.Core.Attributes.LocationType.FrameworkSdkDir">
  545. <summary>
  546. Locates the task executable in the current Framework SDK directory.
  547. </summary>
  548. </member>
  549. <member name="T:NAnt.Core.Attributes.ProgramLocationAttribute">
  550. <summary>
  551. Indicates the location that a task executable can be located in.
  552. </summary>
  553. <remarks>
  554. <para>
  555. When applied to a task deriving from <see cref="T:NAnt.Core.Tasks.ExternalProgramBase"/>,
  556. the program to execute will first be searched for in the designated
  557. location.
  558. </para>
  559. <para>
  560. If the program does not exist in that location, and the file name is
  561. not an absolute path then the list of tool paths of the current
  562. target framework will be searched (in the order in which they are
  563. defined in the NAnt configuration file).
  564. </para>
  565. </remarks>
  566. </member>
  567. <member name="M:NAnt.Core.Attributes.ProgramLocationAttribute.#ctor(NAnt.Core.Attributes.LocationType)">
  568. <summary>
  569. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.ProgramLocationAttribute"/>
  570. with the specified location.
  571. </summary>
  572. <param type="type">The <see cref="P:NAnt.Core.Attributes.ProgramLocationAttribute.LocationType"/> of the attribute.</param>
  573. </member>
  574. <member name="P:NAnt.Core.Attributes.ProgramLocationAttribute.LocationType">
  575. <summary>
  576. Gets or sets the <see cref="P:NAnt.Core.Attributes.ProgramLocationAttribute.LocationType"/> of the task.
  577. </summary>
  578. <value>
  579. The location type of the task to which the attribute is assigned.
  580. </value>
  581. </member>
  582. <member name="T:NAnt.Core.Attributes.StringValidatorAttribute">
  583. <summary>
  584. Used to indicate whether a <see cref="T:System.String"/> property should allow
  585. an empty string value or not.
  586. </summary>
  587. </member>
  588. <member name="M:NAnt.Core.Attributes.StringValidatorAttribute.#ctor">
  589. <summary>
  590. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.StringValidatorAttribute"/>
  591. class.
  592. </summary>
  593. </member>
  594. <member name="M:NAnt.Core.Attributes.StringValidatorAttribute.Validate(System.Object)">
  595. <summary>
  596. Checks if the specified value adheres to the rules defined by the
  597. properties of the <see cref="T:NAnt.Core.Attributes.StringValidatorAttribute"/>.
  598. </summary>
  599. <param name="value">The value to be checked.</param>
  600. <exception cref="T:NAnt.Core.ValidationException"><paramref name="value"/> is an empty string value and <see cref="P:NAnt.Core.Attributes.StringValidatorAttribute.AllowEmpty"/> is set to <see langword="false"/>.</exception>
  601. </member>
  602. <member name="P:NAnt.Core.Attributes.StringValidatorAttribute.AllowEmpty">
  603. <summary>
  604. Gets or sets a value indicating whether an empty string or
  605. <see langword="null" /> should be a considered a valid value.
  606. </summary>
  607. <value>
  608. <see langword="true" /> if an empty string or <see langword="null" />
  609. should be considered a valid value; otherwise, <see langword="false" />.
  610. The default is <see langword="true" />.
  611. </value>
  612. </member>
  613. <member name="P:NAnt.Core.Attributes.StringValidatorAttribute.Expression">
  614. <summary>
  615. Gets or sets a regular expression. The string will be validated to
  616. determine if it matches the expression.
  617. </summary>
  618. <value>
  619. <see cref="N:System.Text.RegularExpressions"/>
  620. </value>
  621. </member>
  622. <member name="P:NAnt.Core.Attributes.StringValidatorAttribute.ExpressionErrorMessage">
  623. <summary>
  624. An optional error message that can be used to better describe the
  625. regular expression error.
  626. </summary>
  627. </member>
  628. <member name="T:NAnt.Core.Attributes.TaskAttributeAttribute">
  629. <summary>
  630. Indicates that property should be treated as a XML attribute for the
  631. task.
  632. </summary>
  633. <example>
  634. Examples of how to specify task attributes
  635. <code>
  636. // task XmlType default is string
  637. [TaskAttribute("out", Required=true)]
  638. string _out = null; // assign default value here
  639. [TaskAttribute("optimize")]
  640. [BooleanValidator()]
  641. // during ExecuteTask you can safely use Convert.ToBoolean(_optimize)
  642. string _optimize = Boolean.FalseString;
  643. [TaskAttribute("warnlevel")]
  644. [Int32Validator(0,4)] // limit values to 0-4
  645. // during ExecuteTask you can safely use Convert.ToInt32(_optimize)
  646. string _warnlevel = "0";
  647. [BuildElement("sources")]
  648. FileSet _sources = new FileSet();
  649. </code>
  650. NOTE: Attribute values must be of type of string if you want
  651. to be able to have macros. The field stores the exact value during
  652. Initialize. Just before ExecuteTask is called NAnt will expand
  653. all the macros with the current values.
  654. </example>
  655. </member>
  656. <member name="M:NAnt.Core.Attributes.TaskAttributeAttribute.#ctor(System.String)">
  657. <summary>
  658. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.TaskAttributeAttribute"/>
  659. with the specified attribute name.
  660. </summary>
  661. <param name="name">The name of the task attribute.</param>
  662. <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is a <see langword="null"/>.</exception>
  663. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
  664. </member>
  665. <member name="T:NAnt.Core.Attributes.TaskNameAttribute">
  666. <summary>
  667. Indicates that class should be treated as a task.
  668. </summary>
  669. <remarks>
  670. Attach this attribute to a subclass of Task to have NAnt be able
  671. to recognize it. The name should be short but must not confict
  672. with any other task already in use.
  673. </remarks>
  674. </member>
  675. <member name="M:NAnt.Core.Attributes.TaskNameAttribute.#ctor(System.String)">
  676. <summary>
  677. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.TaskNameAttribute"/>
  678. with the specified name.
  679. </summary>
  680. <param name="name">The name of the task.</param>
  681. <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
  682. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
  683. </member>
  684. <member name="T:NAnt.Core.Element">
  685. <summary>
  686. Models a NAnt XML element in the build file.
  687. </summary>
  688. <remarks>
  689. <para>
  690. Automatically validates attributes in the element based on attributes
  691. applied to members in derived classes.
  692. </para>
  693. </remarks>
  694. </member>
  695. <member name="M:NAnt.Core.Element.#ctor">
  696. <summary>
  697. Initializes a new instance of the <see cref="T:NAnt.Core.Element"/> class.
  698. </summary>
  699. </member>
  700. <member name="M:NAnt.Core.Element.#ctor(NAnt.Core.Element)">
  701. <summary>
  702. Initializes a new instance of the <see cref="T:NAnt.Core.Element"/> class
  703. from the specified element.
  704. </summary>
  705. <param name="e">The element that should be used to create a new instance of the <see cref="T:NAnt.Core.Element"/> class.</param>
  706. </member>
  707. <member name="M:NAnt.Core.Element.Initialize(System.Xml.XmlNode)">
  708. <summary>
  709. Performs default initialization.
  710. </summary>
  711. <remarks>
  712. Derived classes that wish to add custom initialization should override
  713. the <see cref="M:NAnt.Core.Element.Initialize"/> method.
  714. </remarks>
  715. </member>
  716. <member name="M:NAnt.Core.Element.Log(NAnt.Core.Level,System.String)">
  717. <summary>
  718. Logs a message with the given priority.
  719. </summary>
  720. <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
  721. <param name="message">The message to be logged.</param>
  722. <remarks>
  723. The actual logging is delegated to the project.
  724. </remarks>
  725. </member>
  726. <member name="M:NAnt.Core.Element.Log(NAnt.Core.Level,System.String,System.Object[])">
  727. <summary>
  728. Logs a message with the given priority.
  729. </summary>
  730. <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
  731. <param name="message">The message to log, containing zero or more format items.</param>
  732. <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
  733. <remarks>
  734. The actual logging is delegated to the project.
  735. </remarks>
  736. </member>
  737. <member name="M:NAnt.Core.Element.InitializeElement(System.Xml.XmlNode)">
  738. <summary>
  739. Derived classes should override to this method to provide extra
  740. initialization and validation not covered by the base class.
  741. </summary>
  742. <param name="elementNode">The XML node of the element to use for initialization.</param>
  743. </member>
  744. <member name="M:NAnt.Core.Element.Initialize">
  745. <summary>
  746. Derived classes should override to this method to provide extra
  747. initialization and validation not covered by the base class.
  748. </summary>
  749. <remarks>
  750. Access to the <see cref="P:NAnt.Core.Element.XmlNode"/> that was used to initialize
  751. this <see cref="T:NAnt.Core.Element"/> is available through <see cref="P:NAnt.Core.Element.XmlNode"/>.
  752. </remarks>
  753. </member>
  754. <member name="M:NAnt.Core.Element.CopyTo(NAnt.Core.Element)">
  755. <summary>
  756. Copies all instance data of the <see cref="T:NAnt.Core.Element"/> to a given
  757. <see cref="T:NAnt.Core.Element"/>.
  758. </summary>
  759. </member>
  760. <member name="M:NAnt.Core.Element.Initialize(System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
  761. <summary>
  762. Performs initialization using the given set of properties.
  763. </summary>
  764. </member>
  765. <member name="M:NAnt.Core.Element.InitializeXml(System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
  766. <summary>
  767. Initializes all build attributes and child elements.
  768. </summary>
  769. </member>
  770. <member name="M:NAnt.Core.Element.GetAttributeConfigurationNode(NAnt.Core.FrameworkInfo,System.String)">
  771. <summary>
  772. Locates the XML node for the specified attribute in the project
  773. configuration node.
  774. </summary>
  775. <param name="attributeName">The name of attribute for which the XML configuration node should be located.</param>
  776. <param name="framework">The framework to use to obtain framework specific information, or <see langword="null" /> if no framework specific information should be used.</param>
  777. <returns>
  778. The XML configuration node for the specified attribute, or
  779. <see langword="null" /> if no corresponding XML node could be
  780. located.
  781. </returns>
  782. <remarks>
  783. If there's a valid current framework, the configuration section for
  784. that framework will first be searched. If no corresponding
  785. configuration node can be located in that section, the framework-neutral
  786. section of the project configuration node will be searched.
  787. </remarks>
  788. </member>
  789. <member name="M:NAnt.Core.Element.GetElementNameFromType(System.Type)">
  790. <summary>
  791. Returns the <see cref="P:NAnt.Core.Attributes.ElementNameAttribute.Name"/> of the
  792. <see cref="T:NAnt.Core.Attributes.ElementNameAttribute"/> assigned to the specified
  793. <see cref="T:System.Type"/>.
  794. </summary>
  795. <param name="type">The <see cref="T:System.Type"/> of which the assigned <see cref="P:NAnt.Core.Attributes.ElementNameAttribute.Name"/> should be retrieved.</param>
  796. <returns>
  797. The <see cref="P:NAnt.Core.Attributes.ElementNameAttribute.Name"/> assigned to the specified
  798. <see cref="T:System.Type"/> or a null reference is no <see cref="P:NAnt.Core.Attributes.ElementNameAttribute.Name"/>
  799. is assigned to the <paramref name="type"/>.
  800. </returns>
  801. </member>
  802. <member name="P:NAnt.Core.Element.Parent">
  803. <summary>
  804. Gets or sets the parent of the element.
  805. </summary>
  806. <value>
  807. The parent of the element.
  808. </value>
  809. <remarks>
  810. This will be the parent <see cref="T:NAnt.Core.Task"/>, <see cref="T:NAnt.Core.Target"/>, or
  811. <see cref="P:NAnt.Core.Element.Project"/> depending on where the element is defined.
  812. </remarks>
  813. </member>
  814. <member name="P:NAnt.Core.Element.Name">
  815. <summary>
  816. Gets the name of the XML element used to initialize this element.
  817. </summary>
  818. <value>
  819. The name of the XML element used to initialize this element.
  820. </value>
  821. </member>
  822. <member name="P:NAnt.Core.Element.Project">
  823. <summary>
  824. Gets or sets the <see cref="P:NAnt.Core.Element.Project"/> to which this element belongs.
  825. </summary>
  826. <value>
  827. The <see cref="P:NAnt.Core.Element.Project"/> to which this element belongs.
  828. </value>
  829. </member>
  830. <member name="P:NAnt.Core.Element.Properties">
  831. <summary>
  832. Gets the properties local to this <see cref="T:NAnt.Core.Element"/> and the
  833. <see cref="P:NAnt.Core.Element.Project"/>.
  834. </summary>
  835. <value>
  836. The properties local to this <see cref="T:NAnt.Core.Element"/> and the <see cref="P:NAnt.Core.Element.Project"/>.
  837. </value>
  838. </member>
  839. <member name="P:NAnt.Core.Element.NamespaceManager">
  840. <summary>
  841. Gets or sets the <see cref="T:System.Xml.XmlNamespaceManager"/>.
  842. </summary>
  843. <value>
  844. The <see cref="T:System.Xml.XmlNamespaceManager"/>.
  845. </value>
  846. <remarks>
  847. The <see cref="P:NAnt.Core.Element.NamespaceManager"/> defines the current namespace
  848. scope and provides methods for looking up namespace information.
  849. </remarks>
  850. </member>
  851. <member name="P:NAnt.Core.Element.XmlNode">
  852. <summary>
  853. Gets or sets the XML node of the element.
  854. </summary>
  855. <value>
  856. The XML node of the element.
  857. </value>
  858. </member>
  859. <member name="P:NAnt.Core.Element.Location">
  860. <summary>
  861. Gets or sets the location in the build file where the element is
  862. defined.
  863. </summary>
  864. <value>
  865. The location in the build file where the element is defined.
  866. </value>
  867. </member>
  868. <member name="P:NAnt.Core.Element.CustomXmlProcessing">
  869. <summary>
  870. Gets a value indicating whether the element is performing additional
  871. processing using the <see cref="P:NAnt.Core.Element.XmlNode"/> that was used to
  872. initialize the element.
  873. </summary>
  874. <value>
  875. <see langword="false"/>.
  876. </value>
  877. <remarks>
  878. <para>
  879. Elements that need to perform additional processing of the
  880. <see cref="P:NAnt.Core.Element.XmlNode"/> that was used to initialize the element, should
  881. override this property and return <see langword="true"/>.
  882. </para>
  883. <para>
  884. When <see langword="true"/>, no build errors will be reported for
  885. unknown nested build elements.
  886. </para>
  887. </remarks>
  888. </member>
  889. <member name="T:NAnt.Core.Element.AttributeConfigurator">
  890. <summary>
  891. Configures an <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> using meta-data provided by
  892. assigned attributes.
  893. </summary>
  894. </member>
  895. <member name="M:NAnt.Core.Element.AttributeConfigurator.#ctor(NAnt.Core.Element,System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
  896. <summary>
  897. Initializes a new instance of the <see cref="T:NAnt.Core.Element.AttributeConfigurator"/>
  898. class for the given <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/>.
  899. </summary>
  900. <param name="element">The <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> for which an <see cref="T:NAnt.Core.Element.AttributeConfigurator"/> should be created.</param>
  901. <param name="elementNode">The <see cref="P:NAnt.Core.Element.XmlNode"/> to initialize the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> with.</param>
  902. <param name="properties">The <see cref="T:NAnt.Core.PropertyDictionary"/> to use for property expansion.</param>
  903. <param name="targetFramework">The framework that the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> should target.</param>
  904. <exception cref="T:System.ArgumentNullException">
  905. <para><paramref name="element"/> is <see langword="null"/>.</para>
  906. <para>-or-</para>
  907. <para><paramref name="elementNode"/> is <see langword="null"/>.</para>
  908. <para>-or-</para>
  909. <para><paramref name="properties"/> is <see langword="null"/>.</para>
  910. </exception>
  911. </member>
  912. <member name="M:NAnt.Core.Element.AttributeConfigurator.CreateChildBuildElement(System.Reflection.PropertyInfo,System.Reflection.MethodInfo,System.Reflection.MethodInfo,System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
  913. <summary>
  914. Creates a child <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> using property set/get methods.
  915. </summary>
  916. <param name="propInf">The <see cref="T:System.Reflection.PropertyInfo"/> instance that represents the property of the current class.</param>
  917. <param name="getter">A <see cref="T:System.Reflection.MethodInfo"/> representing the get accessor for the property.</param>
  918. <param name="setter">A <see cref="T:System.Reflection.MethodInfo"/> representing the set accessor for the property.</param>
  919. <param name="xml">The <see cref="P:NAnt.Core.Element.XmlNode"/> used to initialize the new <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> instance.</param>
  920. <param name="properties">The collection of property values to use for macro expansion.</param>
  921. <param name="framework">The <see cref="T:NAnt.Core.FrameworkInfo"/> from which to obtain framework-specific information.</param>
  922. <returns>The <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> child.</returns>
  923. </member>
  924. <member name="M:NAnt.Core.Element.AttributeConfigurator.CreateAttributeSetter(System.Type)">
  925. <summary>
  926. Creates an <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> for the given
  927. <see cref="T:System.Type"/>.
  928. </summary>
  929. <param name="attributeType">The <see cref="T:System.Type"/> for which an <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> should be created.</param>
  930. <returns>
  931. An <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> for the given <see cref="T:System.Type"/>.
  932. </returns>
  933. </member>
  934. <member name="F:NAnt.Core.Element.AttributeConfigurator._element">
  935. <summary>
  936. Holds the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> that should be initialized.
  937. </summary>
  938. </member>
  939. <member name="F:NAnt.Core.Element.AttributeConfigurator._elementXml">
  940. <summary>
  941. Holds the <see cref="P:NAnt.Core.Element.XmlNode"/> that should be used to initialize
  942. the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/>.
  943. </summary>
  944. </member>
  945. <member name="F:NAnt.Core.Element.AttributeConfigurator._properties">
  946. <summary>
  947. Holds the dictionary that should be used for property
  948. expansion.
  949. </summary>
  950. </member>
  951. <member name="F:NAnt.Core.Element.AttributeConfigurator._targetFramework">
  952. <summary>
  953. Holds the framework that should be targeted by the
  954. <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> that we're configuring, or
  955. <see langword="null"/> if there's no current target
  956. framework.
  957. </summary>
  958. </member>
  959. <member name="F:NAnt.Core.Element.AttributeConfigurator._unprocessedAttributes">
  960. <summary>
  961. Holds the names of the attributes that still need to be
  962. processed.
  963. </summary>
  964. </member>
  965. <member name="F:NAnt.Core.Element.AttributeConfigurator._unprocessedChildNodes">
  966. <summary>
  967. Holds the names of the child nodes that still need to be
  968. processed.
  969. </summary>
  970. </member>
  971. <member name="F:NAnt.Core.Element.AttributeConfigurator.logger">
  972. <summary>
  973. Holds the logger for the current class.
  974. </summary>
  975. </member>
  976. <member name="F:NAnt.Core.Element.AttributeConfigurator.AttributeSetters">
  977. <summary>
  978. Holds the cache of <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> instances.
  979. </summary>
  980. </member>
  981. <member name="P:NAnt.Core.Element.AttributeConfigurator.NamespaceManager">
  982. <summary>
  983. Gets the <see cref="T:System.Xml.XmlNamespaceManager"/>.
  984. </summary>
  985. <value>
  986. The <see cref="T:System.Xml.XmlNamespaceManager"/>.
  987. </value>
  988. <remarks>
  989. The <see cref="P:NAnt.Core.Element.AttributeConfigurator.NamespaceManager"/> defines the current namespace
  990. scope and provides methods for looking up namespace information.
  991. </remarks>
  992. </member>
  993. <member name="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter">
  994. <summary>
  995. Internal interface used for setting element attributes.
  996. </summary>
  997. </member>
  998. <member name="T:NAnt.Core.Configuration.DirList">
  999. <summary>
  1000. Represents an explicitly named list of directories.
  1001. </summary>
  1002. <remarks>
  1003. A <see cref="T:NAnt.Core.Configuration.DirList"/> is useful when you want to capture a list of
  1004. directories regardless whether they currently exist.
  1005. </remarks>
  1006. </member>
  1007. <member name="P:NAnt.Core.Configuration.DirList.Directory">
  1008. <summary>
  1009. The base of the directory of this dirlist. The default is the project
  1010. base directory.
  1011. </summary>
  1012. </member>
  1013. <member name="P:NAnt.Core.Configuration.ManagedExecutionMode…