Table of Contents

BuildStep Enum

Definition

Namespace
Sandcastle.Core.BuildEngine
Assembly
Sandcastle.Core.dll

This public enumerated type defines the build steps used when reporting progress during a build.

[Serializable]
public enum BuildStep

Fields

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.

ApplyDocumentModel 7

The reflection information is being transformed by applying the presentation style's document model to it.

AddNamespaceGroups 8

Add namespace group entries to the reflection information file.

AddApiTopicFilenames 9

Add topic filenames to API members in the reflection information file.

GenerateApiTopicManifest 10

Generate the API topic manifest file.

GenerateNamespaceSummaries 11

Namespace summary information is being generated.

GenerateInheritedDocumentation 12

All <inheritDoc /> tags are being expanded.

CopyConceptualContent 13

The conceptual content files are being copied to the working and output folders.

CreateConceptualTopicConfigs 14

The conceptual content topic configuration files are being generated.

CopyAdditionalContent 15

The additional content files are being copied to the help output folder.

MergeTablesOfContents 16

The conceptual and additional content tables of contents are being merged.

GenerateIntermediateTableOfContents 17

The intermediate table of contents is being generated.

CreateBuildAssemblerConfigs 18

The BuildAssembler configuration file is being created.

MergeCustomConfigs 19

Custom build component configurations are being merged into the BuildAssembler configuration file.

CombiningIntermediateTocFiles 20

The intermediate table of content files are being merged into a single file.

BuildTopics 21

Conceptual and/or API reference help file topics are being generated by BuildAssembler.

ExtractingHtmlInfo 22

Title and keyword index information is being extracted for the HTML Help 1 TOC and index and/or website TOC.

CopyStandardHelpContent 23

The standard help file content (art, scripts, styles, and other standard presentation style content) is being copied to the help output folder.

This must occur after ExtracingHtmlInfo as the replacement tags in the web content may rely on the table of contents and index files generated in that step.

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.