This build component is used to generate IntelliSense files based on the documented APIs.

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

Syntax

C#
public class IntelliSenseComponent : BuildComponent

Visual Basic
Public Class IntelliSenseComponent _ Inherits BuildComponent

Remarks

Only the basic set of tags needed for IntelliSense are exported and only for documented API members. This is based on the Microsoft IntelliSense build component. That version only works with Microsoft-specific XML comments files and does not work with general XML comments files created by the compilers.

Examples

CopyExample configuration

<!-- IntelliSense component configuration.  This must appear
     before the TransformComponent. -->
<component type="SandcastleBuilder.Components.IntelliSenseComponent"
  assembly="C:\SandcastleBuilder\SandcastleBuilder.Components.dll">
 <!-- Output options (optional)
      Attributes:
         Include Namespaces (false by default)
         Namespaces filename ("Namespaces" if not specified or empty)
         Directory (current folder if not specified or empty) -->
 <output includeNamespaces="false" namespacesFile="Namespaces"
     folder="C:\ProjectDocs\" />
</component>

Inheritance Hierarchy

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

Syntax

Remarks

Examples

Inheritance Hierarchy

See Also