Project Members

NDoc Core

NDoc Documentation

Project Members

Project overview

Public Static Methods

FindDocumentersSearches the module directory for assemblies containing classes the implement IDocumenter.

Public Instance Constructors

Project Constructor Initializes a new instance of the Project class.

Public Instance Properties

AssemblySlashDocCountGets the number of assembly/doc pairs in the project.
DocumentersGets or sets the Documenters property.
IsDirtyGets the IsDirty property.
NamespaceCountThe number of namespaces in the project.

Public Instance Methods

AddAssemblySlashDocAdds an assembly/doc pair to the project.
ClearClears the project.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
FindAssemblySlashDocByNameReturns the index of the assembly/doc based on an assembly name.
GetAssemblySlashDocGets an assembly/doc pair.
GetAssemblySlashDocsGets an enumerable list of assembly/doc pairs.
GetDocumenterRetrieves a documenter by name.
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.
GetNamespacesGets an enumerable list of namespace names.
GetNamespaceSummaryGets the summary for a namespace.
GetType (inherited from Object)Gets the Type of the current instance.
ReadReads an NDoc project file.
ReadNamespaceSummaries Loads namespace summaries from an XML document.
RemoveAssemblySlashDocRemoves an assembly/doc pair from the project.
SetNamespaceSummarySets a namespace summary.
ToString (inherited from Object)Returns a String that represents the current Object.
WriteWrites an NDoc project file.

Public Instance Events

ModifiedRaised by projects when they're dirty state changes from false to true.

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.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

Project Class | NDoc.Core Namespace