| BuildStep Enumeration |
This public enumerated type defines the build steps used when reporting progress during a build.
Namespace: SandcastleBuilder.Utils.BuildEngineAssembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0
Syntax [SerializableAttribute]
public enum BuildStep
<SerializableAttribute>
Public Enumeration BuildStep
[SerializableAttribute]
public enum class BuildStep
[<SerializableAttribute>]
type BuildStep
Members
| Member name | Value | Description |
---|
| None | 0 | The build has not yet started. |
| Initializing | 1 | Initializing to prepare for build. |
| ClearWorkFolder | 2 | The working folder is about to be created or cleared. |
| ValidatingDocumentationSources | 3 | The documentation source information is being validated and copied to the build folder. |
| GenerateSharedContent | 4 | The shared content files are being generated. |
| GenerateApiFilter | 5 | Generate the API filter for MRefBuilder |
| GenerateReflectionInfo | 6 | The reflection information is being generated by MRefBuilder. |
| TransformReflectionInfo | 7 | The reflection information is being transformed by XslTransform based on the
presentation style's document model and the topic manifest is being generated. |
| GenerateNamespaceSummaries | 8 | Namespace summary information is being generated. |
| GenerateInheritedDocumentation | 9 | All <inheritDoc /> tags are being expanded. |
| CopyConceptualContent | 10 | The conceptual content files are being copied to the working and output folders. |
| CreateConceptualTopicConfigs | 11 | The conceptual content topic configuration files are being generated. |
| CopyAdditionalContent | 12 | The additional content files are being copied to the help output folder. |
| MergeTablesOfContents | 13 | The conceptual and additional content tables of contents are being merged. |
| GenerateIntermediateTableOfContents | 14 | The intermediate table of contents is being generated by XslTransform. |
| CreateBuildAssemblerConfigs | 15 | The sandcastle.configConceptual.configBuildAssembler files are
being created. |
| MergeCustomConfigs | 16 | Custom build component configurations are being merged into the sandcastle.config
file. |
| BuildConceptualTopics | 17 | Conceptual help file topics are being generated by BuildAssembler. |
| BuildReferenceTopics | 18 | API reference help file topics are being generated by BuildAssembler. |
| CombiningIntermediateTocFiles | 19 | The intermediate table of content files are being merged into a single file. |
| ExtractingHtmlInfo | 20 | Title and keyword index information is being extracted for the HTML Help 1 TOC and index
and/or website TOC. |
| CopyStandardHelpContent | 21 | The standard help file content (art, scripts, styles, and other standard presentation style
content) is being copied to the help output folder. |
| GenerateHelpFormatTableOfContents | 22 | The format-specific table of contents is being generated by XslTransform. |
| GenerateHelpFileIndex | 23 | The help file index is being generated. |
| GenerateHelpProject | 24 | The help project file is being generated. |
| CompilingHelpFile | 25 | The help file project is being compiled. |
| GenerateFullTextIndex | 26 | Generate full-text index for ASP.NET website search. |
| CopyingWebsiteFiles | 27 | The website files are being copied to the output path. |
| CleanIntermediates | 28 | The temporary help project files are being removed. |
| Completed | 29 | The build has completed successfully. |
| Canceled | 30 | The build was canceled by user request. |
| Failed | 31 | The build failed with an unexpected error. |
See Also