NDoc 1.3.1 SDK

BaseReflectionDocumenterConfig Members

BaseReflectionDocumenterConfig overview

Public Instance Properties

AssemblyVersionInfoGets or sets the AssemblyVersion property.
AutoDocumentConstructorsGets or sets the AutoDocumentConstructors property.
AutoPropertyBackerSummariesGets or sets the AutoPropertyBackerSummaries property.
CleanIntermediates (inherited from BaseDocumenterConfig)Gets or sets a value indicating whether to delete intermediate files after a successful build.
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.
DocumentExplicitInterfaceImplementationsGets or sets the DocumentInternals property.
DocumentInheritedAttributesGets or sets whether or not to document the attributes inherited from base types.
DocumentInheritedFrameworkMembersGets or sets the DocumentInheritedFrameworkMembers property.
DocumentInheritedMembersGets or sets the DocumentInheritedMembers 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.
DocumentSealedProtectedGets or sets the DocumentSealedProtected property.
EditorBrowsableFilterSpecifies the level of filtering on the EditorBrowsable attribute.
FeedbackEmailAddressGets or sets the FeedbackEmailAddress property.
IncludeDefaultThreadSafetyGets or sets the IncludeDefaultThreadSafety property.
InstanceMembersDefaultToSafeGets or sets the InstanceMembersDefaultToSafe property.
Name (inherited from BaseDocumenterConfig) Gets the display name of the documenter.
PreliminaryGet/set the Preliminary preoperty
ReferencePaths Gets or sets a collection of additional paths to search for reference assemblies.
SdkDocLanguageGets or sets the SdkDocLanguage property.
SdkDocVersionGets or sets the LinkToSdkDocVersion property.
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.
StaticMembersDefaultToSafeGets or sets the StaticMembersDefaultToSafe property.
UseNamespaceDocSummariesGets or sets the UseNamespaceDocSummaries property.
UseNDocXmlFile (inherited from BaseDocumenterConfig)Gets or sets a value indicating whether to use the specified XML file as input instead of reflecting the list of assemblies specified on the project.

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.
GetProperties (inherited from BaseDocumenterConfig)Gets an enumerable list of PropertyInfo objects representing the properties of this config.
GetType (inherited from Object) Gets the Type of the current instance.
Read (inherited from BaseDocumenterConfig)Loads config details from the specified XmlReader.
SetProject (inherited from BaseDocumenterConfig)Associates this config with a Project.
SetValue (inherited from BaseDocumenterConfig) Sets the value of a named config property.
ToString (inherited from Object) Returns a String that represents the current Object.
Write (inherited from BaseDocumenterConfig)Writes the current state of the config to the specified XmlWriter.

Protected Instance Constructors

BaseReflectionDocumenterConfig Constructor Initializes a new instance of the BaseReflectionDocumenterConfig class.

Protected Instance Properties

Project (inherited from BaseDocumenterConfig) Gets the Project that this config is associated with, if any

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.
HandleUnknownPropertyValue (inherited from BaseDocumenterConfig) When overridden in a derived class, handles a unknown or invalid property value read by Read.
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.
ReadProperty (inherited from BaseDocumenterConfig) Sets the value of a named property.
SetDirty (inherited from BaseDocumenterConfig)Sets the IsDirty property on the Project.

See Also

BaseReflectionDocumenterConfig Class | NDoc.Core.Reflection Namespace