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

NDoc::Documenter::NativeHtmlHelp2::NativeHtmlHelp2Config Class Reference

Inheritance diagram for NDoc::Documenter::NativeHtmlHelp2::NativeHtmlHelp2Config:

NDoc::Core::Reflection::BaseReflectionDocumenterConfig NDoc::Core::BaseDocumenterConfig NDoc::Core::IDocumenterConfig

List of all members.


Detailed Description

Config settings for the native Html Help 2 Documenter.

Definition at line 56 of file NativeHtmlHelp2Config.cs.


Public Member Functions

IEnumerable GetProperties ()
 Gets an enumerable list of PropertyInfo objects representing the properties of this config.
 NativeHtmlHelp2Config ()
 Initializes a new instance of the NativeHtmlHelp2Config class.
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

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

FilePath AboutPageIconPage [get, set]
 Gets or sets the AboutPageIconPage property.
FilePath AboutPageInfo [get, set]
 Gets or sets the AboutPageInfo property.
FolderPath AdditionalContentResourceDirectory [get, set]
 Gets or sets the AdditionalContentResourceDirectory property.
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 BuildSeparateIndexFile [get, set]
 Gets or sets the BuildSeparateIndexFile property.
bool CleanIntermediates [get, set]
 Gets or sets a value indicating whether to delete intermediate files after a successful build.
string CollectionNamespace [get, set]
 Gets or sets the CollectionNamespace property.
TOCStyle CollectionTOCStyle [get, set]
 Gets or sets the CollectionTOCStyle property.
string CopyrightHref [get, set]
 Gets or sets the CopyrightHref property.
string CopyrightText [get, set]
 Gets or sets the CopyrightText property.
bool CreateFullTextIndex [get, set]
 Gets or sets the CreateFullTextIndex property.
string DocSetList [get, set]
 Get's or sets the DocSetList 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.
FilePath EmptyIndexTermPage [get, set]
 Gets or sets the EmptyIndexTermPage property.
FilePath ExtensibilityStylesheet [get, set]
 Gets or sets the ExtensibilityStylesheet property.
string FeedbackEmailAddress [get, set]
 Gets or sets the FeedbackEmailAddress property.
string FooterHtml [get, set]
 Gets or sets the FooterHtml property.
bool GenerateCollectionFiles [get, set]
 Gets or sets the GenerateCollectionFiles property.
string HeaderHtml [get, set]
 Gets or sets the HeaderHtml property.
string HtmlHelpName [get, set]
 Gets or sets the HtmlHelpName property.
bool IncludeDefaultStopWordList [get, set]
 Gets or sets the IncludeDefaultStopWordList property.
bool IncludeDefaultThreadSafety [get, set]
 Gets or sets the IncludeDefaultThreadSafety property.
bool InstanceMembersDefaultToSafe [get, set]
 Gets or sets the InstanceMembersDefaultToSafe property.
FilePath IntroductionPage [get, set]
 Gets or sets the IntroductionPage property.
short LangID [get, set]
 Gets or sets the LangID property.
string Name [get]
 Gets the display name of the documenter.
FilePath NavFailPage [get, set]
 Gets or sets the NavFailPage property.
string OutputDirectory [get, set]
 Gets or sets the OutputDirectory property.
string PlugInNamespace [get, set]
 Gets or sets the PlugInNamespace property.
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.
bool RegisterTitleAsCollection [get, set]
 Gets or sets the RegisterTitleAsCollection property.
bool RegisterTitleWithNamespace [get, set]
 Gets or sets the RegisterTitleWithNamespace property.
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.
string Title [get, set]
 Gets or sets the Title property.
FilePath UseHelpNamespaceMappingFile [get, set]
 Gets or sets the UseHelpNamespaceMappingFile 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.
string Version [get, set]
 Get's or sets the version property.

Private Member Functions

void ResetAboutPageIconPage ()
void ResetAboutPageInfo ()
void ResetAdditionalContentResourceDirectory ()
void ResetEmptyIndexTermPage ()
void ResetExtensibilityStylesheet ()
void ResetIntroductionPage ()
void ResetNavFailPage ()
void ResetOutputDirectory ()
void ResetUseHelpNamespaceMappingFile ()

Private Attributes

FilePath _AboutPageIconPage = new FilePath()
FilePath _AboutPageInfo = new FilePath()
FolderPath _AdditionalContentResourceDirectory = new FolderPath()
bool _BuildSeparateIndexFile = false
string _CollectionNamespace = String.Empty
TOCStyle _CollectionTOCStyle = TOCStyle.Hierarchical
bool _CreateFullTextIndex = true
string _DocSetList = "NETFramework"
FilePath _EmptyIndexTermPage = new FilePath()
FilePath _ExtensibilityStylesheet = new FilePath()
string _FooterHtml
bool _GenerateCollectionFiles = false
string _HeaderHtml
string _htmlHelpName = "Documentation"
bool _IncludeDefaultStopWordList = true
FilePath _IntroductionPage = new FilePath()
short _LangID = 1033
FilePath _NavFailPage = new FilePath()
string _outputDirectory = string.Format( ".{0}doc{0}", Path.DirectorySeparatorChar )
string _PlugInNamespace = "ms.vscc"
bool _RegisterTitleAsCollection = false
bool _RegisterTitleWithNamespace = false
string _Title = "An NDoc documented library"
FilePath _UseHelpNamespaceMappingFile = new FilePath()
string _Version = "1.0.0.0"
const string ADDITIONAL_CONTENT_CATEGORY = "Html Help 2 Additional Content"
const string DEPLOYMENT_CATEGORY = "Html Help 2 Deployment"
const string HTMLHELP2_CONFIG_CATEGORY = "Html Help 2 Settings"

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

Generated by  Doxygen 1.6.0   Back to index