Logo Search packages:      
Sourcecode: ndoc version File versions  Download package

NDoc::Core::Reflection::BaseReflectionDocumenterConfig Class Reference

Inheritance diagram for NDoc::Core::Reflection::BaseReflectionDocumenterConfig:

NDoc::Core::BaseDocumenterConfig NDoc::Core::IDocumenterConfig NDoc::Documenter::Intellisense::IntellisenseDocumenterConfig NDoc::Documenter::JavaDoc::JavaDocDocumenterConfig NDoc::Documenter::Latex::LatexDocumenterConfig NDoc::Documenter::LinearHtml::LinearHtmlDocumenterConfig NDoc::Documenter::Msdn2::Msdn2DocumenterConfig NDoc::Documenter::Msdn::MsdnDocumenterConfig NDoc::Documenter::NativeHtmlHelp2::NativeHtmlHelp2Config NDoc::Documenter::Xml::XmlDocumenterConfig

List of all members.


Detailed Description

The base config class for documenters which use the ReflectionEngine to extract documentation from .Net assemblies.

Generating the documentation consists of two high level steps:

  1. Merging the /doc XML summary with reflected meta-data from the assemblies.
  2. Transforming that merged XML into the documentation (HTML for the MSDN and VS.NET documenters).

The settings below govern how exactly the XML summary data is merged with the reflected meta-data and therefore govern what items will and will not appear in the final documentation.

Definition at line 47 of file BaseReflectionDocumenterConfig.cs.


Public Member Functions

IEnumerable GetProperties ()
 Gets an enumerable list of PropertyInfo objects representing the properties of this config.
void Read (XmlReader reader)
 Loads config details from the specified XmlReader.
void SetProject (Project project)
 Associates this config with a Project.
void SetValue (string name, string value)
 Sets the value of a named config property.
void Write (XmlWriter writer)
 Writes the current state of the config to the specified XmlWriter.

Protected Member Functions

 BaseReflectionDocumenterConfig (string name)
 Initializes a new instance of the BaseReflectionDocumenterConfig class.
override string HandleUnknownPropertyType (string name, string value)
virtual string HandleUnknownPropertyValue (PropertyInfo property, string value)
 When overridden in a derived class, handles a unknown or invalid property value read by Read.
string ReadProperty (string name, string value)
 Sets the value of a named property.
void SetDirty ()
 Sets the NDoc.Core.Project.IsDirty property on the Project.

Properties

AssemblyVersionInformationType AssemblyVersionInfo [get, set]
 Gets or sets the AssemblyVersion property.
bool AutoDocumentConstructors [get, set]
 Gets or sets the AutoDocumentConstructors property.
bool AutoPropertyBackerSummaries [get, set]
 Gets or sets the AutoPropertyBackerSummaries property.
bool CleanIntermediates [get, set]
 Gets or sets a value indicating whether to delete intermediate files after a successful build.
string CopyrightHref [get, set]
 Gets or sets the CopyrightHref property.
string CopyrightText [get, set]
 Gets or sets the CopyrightText property.
bool DocumentAttributes [get, set]
 Gets or sets whether or not to document the attributes.
string DocumentedAttributes [get, set]
 Gets or sets which attributes should be documented.
bool DocumentEmptyNamespaces [get, set]
 Gets or sets the DocumentPrivates property.
bool DocumentExplicitInterfaceImplementations [get, set]
 Gets or sets the DocumentInternals property.
bool DocumentInheritedAttributes [get, set]
 Gets or sets whether or not to document the attributes inherited from base types.
bool DocumentInheritedFrameworkMembers [get, set]
 Gets or sets the DocumentInheritedFrameworkMembers property.
DocumentedInheritedMembers DocumentInheritedMembers [get, set]
 Gets or sets the DocumentInheritedMembers property.
bool DocumentInternals [get, set]
 Gets or sets the DocumentInternals property.
bool DocumentPrivates [get, set]
 Gets or sets the DocumentPrivates property.
bool DocumentProtected [get, set]
 Gets or sets the DocumentProtected property.
bool DocumentProtectedInternalAsProtected [get, set]
 Gets or sets the DocumentProtectedInternalAsProtected property.
bool DocumentSealedProtected [get, set]
 Gets or sets the DocumentSealedProtected property.
EditorBrowsableFilterLevel EditorBrowsableFilter [get, set]
 Specifies the level of filtering on the EditorBrowsable attribute.
string FeedbackEmailAddress [get, set]
 Gets or sets the FeedbackEmailAddress property.
bool IncludeDefaultThreadSafety [get, set]
 Gets or sets the IncludeDefaultThreadSafety property.
bool InstanceMembersDefaultToSafe [get, set]
 Gets or sets the InstanceMembersDefaultToSafe property.
string Name [get]
 Gets the display name of the documenter.
bool Preliminary [get, set]
 Get/set the Preliminary preoperty.
Project Project [get]
 Gets the Project that this config is associated with, if any.
ReferencePathCollection ReferencePaths [get, set]
 Gets or sets a collection of additional paths to search for reference assemblies.
SdkLanguage SdkDocLanguage [get, set]
 Gets or sets the SdkDocLanguage property.
SdkVersion SdkDocVersion [get, set]
 Gets or sets the LinkToSdkDocVersion property.
bool ShowMissingParams [get, set]
 Gets or sets the ShowMissingParams property.
bool ShowMissingRemarks [get, set]
 Gets or sets the ShowMissingRemarks property.
bool ShowMissingReturns [get, set]
 Gets or sets the ShowMissingReturns property.
bool ShowMissingSummaries [get, set]
 Gets or sets the ShowMissingSummaries property.
bool ShowMissingValues [get, set]
 Gets or sets the ShowMissingValues property.
bool ShowTypeIdInAttributes [get, set]
 Gets or sets whether or not to show the TypeId property in attributes.
bool SkipNamespacesWithoutSummaries [get, set]
 Gets or sets the SkipNamespacesWithoutSummaries property.
bool StaticMembersDefaultToSafe [get, set]
 Gets or sets the StaticMembersDefaultToSafe property.
bool UseNamespaceDocSummaries [get, set]
 Gets or sets the UseNamespaceDocSummaries property.
string UseNDocXmlFile [get, set]
 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.

Private Member Functions

void ResetReferencePaths ()
bool ShouldSerializeReferencePaths ()

Private Attributes

AssemblyVersionInformationType _AssemblyVersionInfo
bool _AutoDocumentConstructors
bool _AutoPropertyBackerSummaries
string _CopyrightHref
string _CopyrightText
bool _DocumentAttributes
string _DocumentedAttributes
bool _DocumentEmptyNamespaces
bool _DocumentExplicitInterfaceImplementations
bool _DocumentInheritedAttributes
bool _DocumentInheritedFrameworkMembers
DocumentedInheritedMembers _DocumentInheritedMembers
bool _DocumentInternals
bool _DocumentPrivates
bool _DocumentProtected
bool _DocumentProtectedInternalAsProtected
bool _DocumentSealedProtected
EditorBrowsableFilterLevel _EditorBrowsableFilter
string _FeedbackEmailAddress = string.Empty
bool _IncludeDefaultThreadSafety = true
bool _InstanceMembersDefaultToSafe = false
bool _Preliminary = false
SdkLanguage _SdkDocLanguage = SdkLanguage.en
SdkVersion _SdkDocVersion = SdkVersion.SDK_v1_1
bool _ShowMissingParams
bool _ShowMissingRemarks
bool _ShowMissingReturns
bool _ShowMissingSummaries
bool _ShowMissingValues
bool _ShowTypeIdInAttributes
bool _SkipNamespacesWithoutSummaries
bool _StaticMembersDefaultToSafe = true
bool _UseNamespaceDocSummaries

The documentation for this class was generated from the following file:

Generated by  Doxygen 1.6.0   Back to index