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

NDoc::Documenter::HtmlHelp2::HtmlHelp2Config Class Reference

Inheritance diagram for NDoc::Documenter::HtmlHelp2::HtmlHelp2Config:

NDoc::Documenter::Msdn::MsdnDocumenterConfig NDoc::Core::Reflection::BaseReflectionDocumenterConfig NDoc::Core::BaseDocumenterConfig NDoc::Core::IDocumenterConfig

List of all members.


Detailed Description

Config setting for the CHM to HxS converter/compiler.

Definition at line 36 of file HtmlHelp2Config.cs.


Public Member Functions

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

FolderPath AdditionalContentResourceDirectory [get, set]
 Gets or sets the AdditionalContentResourceDirectory property.
AssemblyVersionInformationType AssemblyVersionInfo [get, set]
 Gets or sets the AssemblyVersion property.
bool AugmentXmlDataIslands [get, set]
 Adds additional tags to the embedded Xml data islands (results in slower builds but tighter VS.NET integration).
bool AutoDocumentConstructors [get, set]
 Gets or sets the AutoDocumentConstructors property.
bool AutoPropertyBackerSummaries [get, set]
 Gets or sets the AutoPropertyBackerSummaries property.
bool BinaryTOC [get, set]
 Gets or sets the BinaryToc property.
CharacterSet CharacterSet [get, set]
 Gets or sets the character set that will be used when compiling the help file. Defaults to Ascii.
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 DeleteCHM [get, set]
 Flag that indicates whether to keep the CHM file after successful conversion.
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 ExtensibilityStylesheet [get, set]
 Gets or sets the ExtensibilityStylesheet property.
string FeedbackEmailAddress [get, set]
 Gets or sets the FeedbackEmailAddress property.
string FilesToInclude [get, set]
 Gets or sets the FilesToInclude property.
string FooterHtml [get, set]
 Gets or sets the FooterHtml property.
string HeaderHtml [get, set]
 Gets or sets the HeaderHtml property.
internal string HtmlHelp2CompilerPath [get]
string HtmlHelpName [get, set]
 Gets or sets the HtmlHelpName property.
bool IncludeDefaultThreadSafety [get, set]
 Gets or sets the IncludeDefaultThreadSafety property.
bool IncludeFavorites [get, set]
 Gets or sets the IncludeFavorites property.
bool InstanceMembersDefaultToSafe [get, set]
 Gets or sets the InstanceMembersDefaultToSafe property.
short LangID [get, set]
 Gets or sets the LangID property.
string Name [get]
 Gets the display name of the documenter.
string OutputDirectory [get, set]
 Gets or sets the OutputDirectory property.
OutputType OutputTarget [get, set]
 Gets or sets the OutputTarget property.
string ParentCollectionNamespace [get, set]
 If RegisterTitleWithNamespace is true this is the namesapce to which it will be added.
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]
 If true the HxS title will be registered as a collection (ignored if RegisterTitleWithNamespace is ture).
bool RegisterTitleWithNamespace [get, set]
 Should the compiled Html 2 title be registered after it is compiled. (If true ParentCollectionNamespace is required).
bool RootPageContainsNamespaces [get, set]
 Gets or sets the RootPageContainsNamespaces property.
string RootPageFileName [get, set]
 Gets or sets the RootPageFileName property.
string RootPageTOCName [get, set]
 Gets or sets the RootPageTOCName property.
SdkLanguage SdkDocLanguage [get, set]
 Gets or sets the SdkDocLanguage property.
SdkVersion SdkDocVersion [get, set]
 Gets or sets the LinkToSdkDocVersion property.
bool SdkLinksOnWeb [get, set]
 Gets or sets the SdkLinksOnWeb 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 ShowVisualBasic [get, set]
 Gets or sets the ShowVisualBasic property.
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.
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

bool FindHxComp ()

Private Attributes

bool _AugmentXmlDataIslands = true
CharacterSet _CharacterSet = CharacterSet.Ascii
bool _DeleteCHM = false
string _HtmlHelp2CompilerPath
string _ParentCollectionNamespace = String.Empty
bool _RegisterTitleAsCollection = false
bool _RegisterTitleWithNamespace = false
const string HTMLHELP2_CONFIG_CATEGORY = "Html Help v2.0 Settings"

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

Generated by  Doxygen 1.6.0   Back to index