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