NAntDocumenter Class

Summary

NDoc Documenter for building custom NAnt User documentation.
Assembly
NDoc.Documenter.NAnt.dll
Namespace
NDoc.Documenter.NAnt
Base Types
  • BaseReflectionDocumenter
graph BT Type-->Base0["BaseReflectionDocumenter"] Type["NAntDocumenter"] class Type type-node

Syntax

public class NAntDocumenter : BaseReflectionDocumenter

Constructors

Name Summary
NAntDocumenter() Initializes a new instance of the NDoc.Documenter.NAnt.NAntDocumenter class.

Properties

Name Value Summary
MainOutputFile string
Gets the documenter's main output file.
NamespaceFilter string
Gets or sets the root namespace to document.
OutputDirectory string
Gets the documenter's output directory.
ProductName string
Gets the name of the product for which documentation should be generated.
ProductUrl string
Gets the URL of the website of the product for which documentation should be generated.
ProductVersion string
Gets the version of the product for which documentation should be generated.

Methods

Name Value Summary
Build(Project) void
Builds the documentation.
Clear() void
Resets the documenter to a clean state.