| SandcastleBuilder.Utils Namespace |
| Class | Description | |
|---|---|---|
| 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
| |
| BaseBuildItem |
This is a base wrapper class for a build item in the project
| |
| BuilderException |
This exception class is thrown by the application if it encounters an
unrecoverable error.
| |
| COMReferenceItem |
This represents a COM reference item that can be used by
MRefBuilder to locate assembly dependencies for the assemblies
being documented.
| |
| DocumentationSource |
This represents an assembly, an XML comments file, a Visual Studio Solution (C#, VB.NET, or J#), or a
Visual Studio solution containing one or more C#, VB.NET or J# projects to use for building a help file.
| |
| DocumentationSourceCollection |
This collection class is used to hold the documentation sources
| |
| FileItem |
This class represents a file that is part of the project
(MAML/additional content, site map, stylesheet, etc.).
| |
| FileItemCollection |
This collection class is used to hold build items from a project.
| |
| 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.
| |
| MSHelpAttr |
This represents an MS Help 2 attribute that can be added to the XML
data island in each help topic generated by BuildAssembler.
| |
| MSHelpAttrCollection |
This collection class is used to hold the help attribute items for a project
| |
| MSHelpKeyword |
This represents an MS Help 2 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
| |
| ProjectPropertyChangedEventArgs |
This event arguments class is used to specify which project property
changed along with the old and new values.
| |
| ProjectReferenceItem |
This represents a project reference item that can be used by MRefBuilder to locate assembly
dependencies for the assemblies being documented.
| |
| PropertyBasedCollectionItem |
This is the base class for collection items that are stored in an
MSBuild property element.
| |
| ReferenceItem |
This represents a reference item that can be used by MRefBuilder
to locate assembly dependencies for the assemblies being documented.
| |
| ReferenceItemCollection |
This collection class is used to hold the reference items for a project
| |
| 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
|
| Interface | Description | |
|---|---|---|
| IBasePathProvider |
This interface defines the properties used to obtain a base path for
a FilePath object.
|
| Enumeration | Description | |
|---|---|---|
| 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
| |
| CollectionTocStyle |
This public enumerated type defines the collection table of contents
style for MS Help 2 collections.
| |
| 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.
| |
| MSHelp2SdkLinkType |
This public enumerated type defines the type of links used to reference
other help topics referring to framework (SDK) help topics in MS Help 2
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.
| |
| 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 MSDN SDK links.
| |
| VisibleItems |
This public enumerated type defines the optional visible items in the help file
|