C# Class NAnt.DotNet.Tasks.NDocTask

Inheritance: NAnt.Core.Task

显示文件 Open project: skolima/NAnt

Private Properties

Property	Type	Description
CheckAndGetDocumenter	IDocumenter
ExpandPropertiesInNodes	void
OnDocBuildingProgress	void
OnDocBuildingStep	void
ResolveHhcExe	string
SetHtmlHelpCompiler	void

Protected Methods

Method	Description
ExecuteTask ( ) : void	Generates an NDoc project and builds the documentation.
Initialize ( ) : void	Initializes the taks and verifies the parameters.

Private Methods

Method	Description
CheckAndGetDocumenter ( NDoc project, string documenterName ) : IDocumenter	Returns the documenter for the given project.
ExpandPropertiesInNodes ( XmlNodeList nodes ) : void	Performs macro expansion for the given nodes.
OnDocBuildingProgress ( object sender, NDoc.Core.ProgressArgs e ) : void	Represents the method that will be called to update the current step's precent complete value.
OnDocBuildingStep ( object sender, NDoc.Core.ProgressArgs e ) : void	Represents the method that will be called to update the overall percent complete value and the current step name.
ResolveHhcExe ( ) : string	Searches in %ProgramFiles(x86)%\HTML Help Workshop and %ProgramFiles%\HTML Help Workshop for hhc.exe. If not found let ndoc msdn documentor search itself
SetHtmlHelpCompiler ( object sender, string hhcexe ) : void	Use Reflection to set HtmplHelp._htmlHelpCompiler private field for MSDN Documentor. Ndoc could not handle 64bit installations and is not actively developed anymore.

Method Details

ExecuteTask() protected method

Generates an NDoc project and builds the documentation.

protected ExecuteTask ( ) : void
return	void

Initialize() protected method

Initializes the taks and verifies the parameters.

protected Initialize ( ) : void
return	void