Table of Contents

Sandcastle.Core.Project Namespace

This namespace contains types used to interact with the help file builder project.

Classes

ApiFilter

This represents an API entry that is to be removed from the reflection information using MRefBuilder's namespace ripping feature.

ApiFilterCollection

This collection class is used to hold the API filter entries for MRefBuilder to remove

NamespaceSummaryItem

This represents a a namespace summary item that can be used to add comments to a namespace in the help file or exclude it completely from the help file.

NamespaceSummaryItemCollection

This collection class is used to hold the namespace summary items for a project

ProjectFileConfiguration

This holds configuration settings for Visual Studio project file documentation sources

Interfaces

IDocumentationSource

This defines the interface used to interact with a help file builder project documentation source

IFileItem

This defines the interface used to interact with a file item in a help file builder project

ISandcastleProject

This defines the interface used to interact with a Sandcastle Help File Builder project

Enums

ApiEntryType

This public enumerated type defines the API entry types that can be removed from the reflection information file.

BuildAction

This defines the build action (item name) for build items in a project

HelpFileFormats

This public enumerated type defines the type(s) of help file that can be generated

HtmlSdkLinkType

This public enumerated type defines the type of links used to reference other help topics referring to framework (SDK) help topics in HTML Help 1 and website help files.

MSHelpViewerSdkLinkType

This public enumerated type defines the type of links used to reference other help topics referring to framework (SDK) help topics in MS Help Viewer help files.

MissingTags

This public enumerated type defines the missing documentation tags for which to search.

NamingMethod

This public enumerated type defines the naming method to use for the help topic filenames

SdkLinkTarget

This public enumerated type defines the locations in which a browser window can be opened for the external website links.

VisibleItems

This public enumerated type defines the optional visible items to include in the help file