NAnt SDK Documentation - v0.85-nightly-2005-11-09

NDocTask Members

NDocTask overview

Public Instance Constructors

NDocTask Constructor Initializes a new instance of the NDocTask class.

Public Instance Properties

Assemblies The set of assemblies to document.
Documenters Specifies the formats in which the documentation should be generated.
FailOnError (inherited from Task) Determines if task failure stops the build, or is just reported. The default is true.
IfDefined (inherited from Task) If true then the task will be executed; otherwise, skipped. The default is true.
LogPrefix (inherited from Task)Obsolete. The prefix used when sending messages to the log.
Name (inherited from Task) The name of the task.
NamespaceManager (inherited from Element) Gets or sets the XmlNamespaceManager.
Parent (inherited from Element) Gets or sets the parent of the element.
Project (inherited from Element) Gets or sets the Project to which this element belongs.
Properties (inherited from Element) Gets the properties local to this Element and the Project.
ReferencePaths Collection of additional directories to search for referenced assemblies.
Summaries The set of namespace summary files.
Threshold (inherited from Task) Gets or sets the log threshold for this Task. By default the threshold of a task is Debug, causing no messages to be filtered in the task itself.
UnlessDefined (inherited from Task) Opposite of IfDefined. If false then the task will be executed; otherwise, skipped. The default is false.
Verbose (inherited from Task) Determines whether the task should report detailed build log messages. The default is false.

Public Instance Methods

Equals (inherited from Object) 
Execute (inherited from Task) Executes the task unless it is skipped.
GetHashCode (inherited from Object) 
GetType (inherited from Object) 
Initialize (inherited from Element) Performs default initialization.
InitializeTaskConfiguration (inherited from Task) Initializes the configuration of the task using configuration settings retrieved from the NAnt configuration file.
IsLogEnabledFor (inherited from Task) Determines whether build output is enabled for the given Level.
Log (inherited from Task)Overloaded. Logs a message with the given priority.
ToString (inherited from Object) 

Protected Instance Properties

CustomXmlProcessing (inherited from Element) Gets a value indicating whether the element is performing additional processing using the XmlNode that was used to initialize the element.
Location (inherited from Element) Gets or sets the location in the build file where the element is defined.
XmlNode (inherited from Element) Gets or sets the XML node of the element.

Protected Instance Methods

CopyTo (inherited from Element) Copies all instance data of the Element to a given Element.
ExecuteTask Generates an NDoc project and builds the documentation.
Finalize (inherited from Object) 
GetAttributeConfigurationNode (inherited from Element) Locates the XML node for the specified attribute in the project configuration node.
InitializeElement (inherited from Task)Obsolete.
Note   Deprecated (to be deleted).
InitializeTask Initializes the taks and verifies the parameters.
InitializeXml (inherited from Element) Initializes all build attributes and child elements.
MemberwiseClone (inherited from Object) 

See Also

NDocTask Class | NAnt.DotNet.Tasks Namespace