BaseDocumenterConfig Members

NDoc Core

NDoc Documentation

BaseDocumenterConfig Members

BaseDocumenterConfig overview

Public Instance Constructors

BaseDocumenterConfig Constructor Initializes a new instance of the DocumenterConfig class.

Public Instance Properties

AutoDocumentConstructorsGets or sets the AutoDocumentConstructors property.
AutoPropertyBackerSummariesGets or sets the AutoPropertyBackerSummaries property.
CopyrightHrefGets or sets the CopyrightHref property.
CopyrightTextGets or sets the CopyrightText property.
DocumentAttributesGets or sets whether or not to document the attributes.
DocumentedAttributesGets or sets which attributes should be documented.
DocumentEmptyNamespacesGets or sets the DocumentPrivates property.
DocumentInternalsGets or sets the DocumentInternals property.
DocumentPrivatesGets or sets the DocumentPrivates property.
DocumentProtectedGets or sets the DocumentProtected property.
DocumentProtectedInternalAsProtectedGets or sets the DocumentProtectedInternalAsProtected property.
EditorBrowsableFilterSpecifies the level of filtering on the EditorBrowsable attribute.
GetExternalSummariesLoad external xml files?
IncludeAssemblyVersionGets or sets the IncludeAssemblyVersion property.
ReferencesPathGets or sets the base directory used to resolve directory and assembly references.
ShowMissingParamsGets or sets the ShowMissingParams property.
ShowMissingRemarksGets or sets the ShowMissingRemarks property.
ShowMissingReturnsGets or sets the ShowMissingReturns property.
ShowMissingSummariesGets or sets the ShowMissingSummaries property.
ShowMissingValuesGets or sets the ShowMissingValues property.
ShowTypeIdInAttributesGets or sets whether or not to show the TypeId property in attributes.
SkipNamespacesWithoutSummariesGets or sets the SkipNamespacesWithoutSummaries property.
UseNamespaceDocSummariesGets or sets the UseNamespaceDocSummaries property.
UseNDocXmlFileGets or sets the UseNDocXmlFile property.

Public Instance Methods

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.
GetPropertiesGets a list of property names.
GetType (inherited from Object)Gets the Type of the current instance.
ReadReads the previously serialized state of the documenter into memory.
SetProjectAssociates this documenter with a project;
SetValueSets the value of a property.
ToString (inherited from Object)Returns a String that represents the current Object.
WriteWrites the current state of the documenter to the specified XmlWrtier.

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.
SetDirtySets the IsDirty property on the project if any is set.

See Also

BaseDocumenterConfig Class | NDoc.Core Namespace