SandcastleBuilder.Utils Namespace
This namespace contains various utility classes and 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
|
| ApiTopicNamer |
This is used to generate topic filenames for API members based on the selected naming method
|
| BuilderException |
This exception class is thrown by the application if it encounters an unrecoverable error
|
| BuildItemMetadata |
This class holds a set of constants that define build item metadata names
|
| DocumentationSource |
This represents an assembly, an XML comments file, a Visual Studio managed code project (C#, VB.NET,
etc.), or a Visual Studio solution containing one or more managed code projects from which information
is obtained to build a help file.
|
| DocumentationSourceCollection |
This collection class is used to hold the documentation sources and can be used for editing them
|
| FileItem |
This class represents a file that is part of the project (MAML/additional content, site map, style
sheet, etc.).
|
| FilePath |
This class is used to represent a file path. Support is included for treating the path as fixed or
relative and for expanding environment variables in the path name.
|
| FolderPath |
This class is used to represent a folder path. Support is included for treating the path as fixed or
relative and for expanding environment variables in the path name.
|
| MSHelpKeyword |
This represents an Microsoft help index keyword that can be added to the XML data island in each help
topic generated by BuildAssembler.
|
| MSHelpKeywordCollection |
This collection class is used to hold the help index keyword items for a project
|
| 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
|
| ProjectElement |
This class is a wrapper for build items in the project.
|
| ProjectFileConfiguration |
This holds configuration settings for Visual Studio project file
documentation sources
|
| SandcastleProject |
This class represents all of the properties that make up a Sandcastle Help File Builder project
|
| Utility |
This class contains utility and extension methods
|
| 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
|
| BuildAssemblerVerbosity |
This public enumerated type defines the build assembler tool verbosity levels
|
| ContentPlacement |
This public enumerated type defines the placement of the additional
content items in the table of contents if any are defined.
|
| DocumentType |
This public enumerated type defines the conceptual document types
|
| 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.
|
| MissingTags |
This public enumerated type defines the missing documentation tags for
which to search.
|
| 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.
|
| 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.
|
