NDoc 1.3.1 SDK

Project Members

Project overview

Public Instance Constructors

Project ConstructorInitializes a new instance of the Project class.

Public Instance Properties

AssemblySlashDocs Gets the collection of assemblies and documentation comment XML files in the project.
BaseDirectory Gets the base directory used for relative references.
Documenters Gets the list of available documenters.
IsDirtyGets or sets a value indicating whether the contents of this project have been modified.
Namespaces Gets the project namespace summaries collection.
ProjectFile Gets or sets the project file.
ReferencePathsGets a collection of directories that will be probed when attempting to load assemblies.
SuspendDirtyCheck Gets or sets a value indicating whether IsDirty is updated when a project property is modifed.

Public Instance Methods

AppendProbePath Appends the specified directory to the documenter probe path.
ClearClears the project.
Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
GetDocumenterRetrieves a documenter by name.
GetFullPath Combines the specified path with the BaseDirectory of the Project to form a full path to file or directory.
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.
GetRelativePath Gets the relative path of the passed path with respect to the BaseDirectory of the Project.
GetType (inherited from Object) Gets the Type of the current instance.
ReadReads an NDoc project file from disk.
ToString (inherited from Object) Returns a String that represents the current Object.
WriteWrites an NDoc project to a disk file.

Public Instance Events

ModifiedRaised when the project IsDirty 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