NDoc 1.3.1 SDK

IDocumenter Members

IDocumenter overview

Public Instance Properties

ConfigGets or sets the documenter's config object.
DevelopmentStatus The development status (alpha, beta, stable) of this documenter.
MainOutputFile Returns the documenter's main output file path.
NameGets the display name for the documenter.

Public Instance Methods

BuildBuilds the documentation.
CanBuildOverloaded. Checks if the documentation output file(s) exist.
ClearResets the documenter to a clean state.
ViewSpawns a new process to view the generated documentation.

Public Instance Events

DocBuildingProgress Raised to update the current step's percent complete value.
DocBuildingStep Raised to update the overall percent complete value and the current step name.

See Also

IDocumenter Interface | NDoc.Core Namespace