BaseDocumenter Members

NDoc Core

NDoc Documentation

BaseDocumenter Members

BaseDocumenter overview

Public Static Methods

LoadAssemblyLoads an assembly.

Public Instance Properties

ConfigSee IDocumenter.
DevelopmentStatus The development status (alpha, beta, stable) of this documenter. Documenters should override this if they aren't stable.
MainOutputFileSee IDocumenter.
NameGets the display name for the documenter.

Public Instance Methods

BuildSee IDocumenter.
CanBuildOverloaded. See IDocumenter.
ClearSee IDocumenter.
CompareToCompares the currrent document to another documenter.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object)Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object)Gets the Type of the current instance.
ToString (inherited from Object)Returns a String that represents the current Object.
ViewSee IDocumenter.

Public Instance Events

Protected Instance Constructors

BaseDocumenter Constructor Initialized a new BaseDocumenter instance.

Protected Instance Properties

DocumentGets the XmlDocument containing the combined relected metadata and /doc comments.
XmlBuffer The XML string containing the combined relected metadata and /doc comments.

Protected Instance Methods

Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
GetXPathDocument Returns the XPathDocument to access the combined relected metadata and /doc comments.
MakeXmlBuilds an XmlDocument combining the reflected metadata with the /doc comments.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.
OnDocBuildingProgressRaises the DocBuildingProgress event.
OnDocBuildingStepRaises the DocBuildingStep event.
SetupAssemblyResolver Setup AssemblyResolver for case where system doesn't resolve an assembly automatically. This puts in the directories in ReferencesPath, and the directories to each assembly referenced in the project.

See Also

BaseDocumenter Class | NDoc.Core Namespace