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: 1.9.3.0
Syntax
| C# |
|---|
[SerializableAttribute] public enum BuildStep |
| Visual Basic |
|---|
<SerializableAttribute> _ Public Enumeration 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. | |
| FindingTools | 3 | The builder is searching for Sandcastle and the HTML help compiler. | |
| ValidatingDocumentationSources | 4 | The documentation source information is being validated and copied to the build folder. | |
| GenerateSharedContent | 5 | The shared content files are being generated. | |
| GenerateApiFilter | 6 | Generate the API filter for MRefBuilder | |
| GenerateReflectionInfo | 7 | The reflection information is being generated by MRefBuilder. | |
| GenerateNamespaceSummaries | 8 | Namespace summary information is being generated. | |
| ApplyVisibilityProperties | 9 | The Visibility category properties are being applied to the reflection information file to remove unwanted items. | |
| GenerateInheritedDocumentation | 10 | All <inheritDoc /> tags are being expanded. | |
| TransformReflectionInfo | 11 | The reflection information is being transformed by XslTransform. | |
| ModifyHelpTopicFilenames | 12 | Help topic filenames are being altered. | |
| CopyStandardContent | 13 | The standard help file content (art, scripts, and styles) is being copied to the help project folder. | |
| CopyConceptualContent | 14 | The conceptual content files are being copied. | |
| CreateConceptualTopicConfigs | 15 | The conceptual content topic configuration files are being generated. | |
| CopyAdditionalContent | 16 | The additional content files are being copied to the help project folder. | |
| MergeTablesOfContents | 17 | The conceptual and additional content tables of contents are being merged. | |
| GenerateIntermediateTableOfContents | 18 | The intermediate table of contents is being generated by XslTransform. | |
| CreateBuildAssemblerConfigs | 19 | The sandcastle.configConceptual.configBuildAssembler files are being created. | |
| MergeCustomConfigs | 20 | Custom build component configurations are being merged into the sandcastle.config file. | |
| BuildConceptualTopics | 21 | Conceptual help file topics are being generated by BuildAssembler. | |
| BuildReferenceTopics | 22 | API reference help file topics are being generated by BuildAssembler. | |
| CombiningIntermediateTocFiles | 23 | The intermediate table of content files are being merged into a single file. | |
| ExtractingHtmlInfo | 24 | Title and keyword index information is being extracted for the HTML Help 1 TOC and index and/or website TOC. | |
| GenerateHelpFormatTableOfContents | 25 | The format-specific table of contents is being generated by XslTransform. | |
| GenerateHelpFileIndex | 26 | The help file index is being generated. | |
| GenerateHelpProject | 27 | The help project file is being generated. | |
| CompilingHelpFile | 28 | The help file project is being compiled. | |
| GenerateFullTextIndex | 29 | Generate full-text index for ASP.NET website search. | |
| CopyingWebsiteFiles | 30 | The website files are being copied to the output path. | |
| CleanIntermediates | 31 | The temporary help project files are being removed. | |
| Completed | 32 | The build has completed successfully. | |
| Canceled | 33 | The build was canceled by user request. | |
| Failed | 34 | The build failed with an unexpected error. |
See Also
