SandcastleBuilder.Utils.BuildEngine Namespace

This namespace contains the classes related to the build engine.

Classes

BuildProcess This class is used to handle all aspects of the build process in a separate thread
BuildProgressEventArgs This is a custom event arguments class use to report build progress
FrameworkCommentsFileLocation This is used to represent a framework XML comments file location
FullTextIndex This is a really basic implementation of an algorithm used to create a full-text index of the website pages so that they can be searched using the ASP.NET web pages.
LanguageSettings This class is used to contain the language settings for the HTML extract build step
MarkdownContentGenerator This class is used to finish up creation of the markdown content and copy it to the output folder
NumberingStyle This is used to track the custom numbering styles found during the step that converts the list elements to Open XML lists.
OpenXmlFileGenerator This class is used to finish up creation of the Open XML file parts and compress the help content into an Open XML document (a ZIP file with a .docx extension).
SubstitutionTagReplacement This class handles substitution tag replacement in build template files
TaskRunner This class is used to execute external tasks such as MSBuild
TitleAndKeywordHtmlExtract This class is used to extract title and keyword information from HTML files for use in creating the Help 1 (CHM) table of contents and keyword index files. It can also optionally convert the files to a different encoding in order to build HTML Help 1 files that use a different language.
XmlCommentsFile This represents an XML comment file and is used when searching for and adding missing documentation tag information.
XmlCommentsFileCollection This collection class is used to hold the XML comments files during the build process

Enumerations

BuildStep This public enumerated type defines the build steps used when reporting progress during a build.
PartialBuildType This public enumerated type defines the partial build types