This namespace contains custom build components used by the Sandcastle tools MRefBuilder and BuildAssembler. The MRefBuilder components are used to add features such as assembly binding redirection when generating reflection information. The BuildAssembler components are used to add additional features to the help topics such as a logo, code colorization, warnings that indicate missing documentation elements, etc.
Classes
| Class | Description | |
|---|---|---|
| BindingRedirectResolver |
This is a custom assembly resolver for Sandcastle's MRefBuilder
tool that supports assembly binding redirect elements in its
configuration that let you redirect an unknown assembly's strong name
to another by version number when resolving an unknown reference.
| |
| BindingRedirectSettings |
This represents binding redirection settings for the
BindingRedirectResolver.
| |
| CachedCopyFromIndexComponent |
This is a derived CopyFromIndexComponent class that loads the
index document cache from a serialized binary file rather than loading
it from the XML reflection data files. This can significantly decrease
the amount of time needed to instantiate the component.
| |
| CachedResolveReferenceLinksComponent |
This is a derived ResolveReferenceLinksComponent2 class that
loads cached MSDN URLs from a serialized binary file rather than
letting the base component invoke the web service to look them up.
This can significantly decrease the amount of time needed to perform
a build.
| |
| CodeBlockComponent |
This build component is used to search for <code> XML comment
tags and colorize the code within them. It can also include code
from an external file or a region within the file.
| |
| ConceptualLinkInfo |
This is a reimplementation of the ConceptualLinkInfo class used
by ResolveConceptualLinksComponent.
| |
| IntelliSenseComponent |
This build component is used to generate IntelliSense files based on
the documented APIs.
| |
| JavaScriptDeclarationSyntaxGenerator |
This is a JavaScript declaration syntax generator that is used to add a
JavaScript Syntax section to each generated API topic.
| |
| MSHCComponent |
This class is a reimplementation of the MSHCComponent that allows
the inclusion of a sortOrder attribute on the table of contents
file elements. This allows the sort order of the elements to be defined
to set the proper placement of the TOC entries when parented to an entry
outside of the help file and to parent the API content within a conceptual
content folder.
| |
| MSHelpAttrComponent |
This build component is used to add additional MS Help 2 attributes
to the XML data island in each generated API topic.
| |
| MultiFormatOutputComponent |
This build component is used to execute one or more sets of build
components each based on a specific help file output format.
| |
| PostTransformComponent |
This build component is a companion to the
CodeBlockComponent. It is used to add the
stylesheet and JavaScript links to the rendered HTML if the topic
contains colorized code. In addition, it can insert a logo image at
the top of each help topic and, for the Prototype presentation style,
hide the language combo box if only one language appears in the Syntax
section. With a modification to the Sandcastle reference content
files, it will also add version information to each topic.
| |
| ResolveConceptualLinksComponent |
This contains a reimplementation of ResolveConceptualLinksComponent
that allows the use of inner text from the <link> tag,
allows the use of anchor references (#anchorName) in the link target,
and allows the use of an optional linkText element in the
companion file to specify the link text.
| |
| ShowMissingComponent |
This build component is used to add "missing" notes for missing
summary, parameter, returns, value, and remarks tags. It can also
add default summary documentation for constructors.
| |
| TargetDirectory |
This is a reimplementation of the TargetDirectory class used
by ResolveConceptualLinksComponent.
| |
| TargetInfo |
This is a reimplementation of the TargetInfo class used by
ResolveConceptualLinksComponent.
| |
| VersionInfoComponent |
This build component is used to obtain version information for each
topic so that it can be placed in the footer by the
PostTransformComponent.
|
Enumerations
| Enumeration | Description | |
|---|---|---|
| LinkType |
This public enumerated type defines the link types
| |
| PostTransformComponent..::..LogoAlignment |
This enumeration defines the logo alignment options when placement
is set to Above.
| |
| PostTransformComponent..::..LogoPlacement |
This enumeration defines the logo placement options
|