This build component is used to add additional MS Help 2 attributes to the XML data island in each generated API topic.

Namespace: SandcastleBuilder.Components
Assembly: SandcastleBuilder.Components (in SandcastleBuilder.Components.dll) Version: 1.9.3.0

Syntax

C#
public class MSHelpAttrComponent : BuildComponent
Visual Basic
Public Class MSHelpAttrComponent _
	Inherits BuildComponent

Examples

CopyExample configuration
<!-- MS Help 2 attribute configuration.  This must appear after
     the TransformComponent. -->
<component type="SandcastleBuilder.Components.MSHelpAttrComponent"
  assembly="C:\SandcastleBuilder\SandcastleBuilder.Components.dll">
    <!-- Additional attributes.  If no attributes are specified,
         the component will do nothing. -->
    <attributes>
        <!-- The "name" attribute is required.  The "value" attribute
             is optional. -->
        <attribute name="DocSet" value="NETFramework" / >
        <attribute name="DocSet" value="ProjectNamespace" / >
        <attribute name="TargetOS" value="Windows" / >
    </attributes>
</component>

Inheritance Hierarchy

System..::..Object
  Microsoft.Ddue.Tools..::..BuildComponent
    SandcastleBuilder.Components..::..MSHelpAttrComponent

See Also