C# Class Microsoft.DocAsCode.Build.Engine.SingleDocumentBuilder

Inheritance: IDisposable
显示文件 Open project: dotnet/docfx Class Usage Examples

Private Properties

Property Type Description
ApplyFileMetadata object>.ImmutableDictionary
ApplySystemMetadata void
BuildArticle void
BuildCore IEnumerable
BuildCore Microsoft.DocAsCode.Plugins.Manifest
BuildCore void
CheckFileLink void
Cleanup void
CreateMarkdownService IMarkdownService
ExportManifest IEnumerable
ExportXRefMap string
FeedGlobalVariables object>.IDictionary
FeedOptions void
FeedXRefMap void
GetFilesFromUids IEnumerable
GetHomepages List
GetInnerContexts IEnumerable
GetManifestItem InternalManifestItem
HandleSaveResult InternalManifestItem
HandleToc void
HandleUids void
IsProcessorSupportIncremental bool
Load Microsoft.DocAsCode.Plugins.FileModel
Postbuild void
Prebuild void
PrepareBuild void
RegisterDependencyType void
RegisterXRefSpec void
RunBuildSteps void
UpdateContext void
UpdateHostServices void
UpdateHostServicesPerchanges void
UpdateHref void
UpdateUidDependency void

Public Methods

Method Description
Build ( IDocumentProcessor processor, DocumentBuildParameters parameters, IMarkdownService markdownService ) : ImmutableList
Build ( DocumentBuildParameters parameters ) : Manifest
Dispose ( ) : void

Private Methods

Method Description
ApplyFileMetadata ( string file, object>.ImmutableDictionary metadata, FileMetadata fileMetadata ) : object>.ImmutableDictionary
ApplySystemMetadata ( List manifest, IDocumentBuildContext context ) : void
BuildArticle ( HostService hostService, int maxParallelism ) : void
BuildCore ( List hostServices, DocumentBuildContext context, string versionName ) : IEnumerable
BuildCore ( DocumentBuildParameters parameters ) : Manifest
BuildCore ( List hostServices, int maxParallelism, Action buildSaver, Action loader, System.Action updater ) : void
CheckFileLink ( HostService hostService, SaveResult result ) : void
Cleanup ( HostService hostService ) : void
CreateMarkdownService ( DocumentBuildParameters parameters, string>.ImmutableDictionary tokens ) : IMarkdownService
ExportManifest ( HostService hostService, DocumentBuildContext context ) : IEnumerable
ExportXRefMap ( DocumentBuildParameters parameters, DocumentBuildContext context ) : string

Export xref map file.

FeedGlobalVariables ( string>.IDictionary initialGlobalVariables, List manifest, IDocumentBuildContext context ) : object>.IDictionary
FeedOptions ( List manifest, IDocumentBuildContext context ) : void
FeedXRefMap ( List manifest, IDocumentBuildContext context ) : void
GetFilesFromUids ( DocumentBuildContext context, IEnumerable uids ) : IEnumerable
GetHomepages ( DocumentBuildContext context ) : List
GetInnerContexts ( DocumentBuildParameters parameters, IEnumerable processors, TemplateProcessor templateProcessor, IMarkdownService markdownService, DocumentBuildContext context ) : IEnumerable
GetManifestItem ( DocumentBuildContext context, FileModel model, SaveResult result ) : InternalManifestItem
HandleSaveResult ( DocumentBuildContext context, HostService hostService, FileModel model, SaveResult result ) : InternalManifestItem
HandleToc ( DocumentBuildContext context, SaveResult result ) : void
HandleUids ( DocumentBuildContext context, SaveResult result ) : void
IsProcessorSupportIncremental ( IDocumentProcessor processor ) : bool
Load ( IDocumentProcessor processor, object>.ImmutableDictionary metadata, FileMetadata fileMetadata, FileAndType file, bool canProcessorIncremental, DocumentBuildContext context ) : FileModel
Postbuild ( HostService hostService ) : void
Prebuild ( HostService hostService ) : void
PrepareBuild ( DocumentBuildContext context, IEnumerable hostServices ) : void
RegisterDependencyType ( HostService hostService ) : void
RegisterXRefSpec ( DocumentBuildContext context, SaveResult result ) : void
RunBuildSteps ( IEnumerable buildSteps, Action action ) : void
UpdateContext ( DocumentBuildContext context ) : void
UpdateHostServices ( IncrementalBuildContext incrementalContext, IEnumerable hostServices ) : void
UpdateHostServicesPerchanges ( DocumentBuildContext context, IEnumerable hostServices ) : void
UpdateHref ( List manifest, IDocumentBuildContext context ) : void
UpdateUidDependency ( IEnumerable hostServices, DocumentBuildContext context ) : void

Method Details

Build() public static method

public static Build ( IDocumentProcessor processor, DocumentBuildParameters parameters, IMarkdownService markdownService ) : ImmutableList
processor IDocumentProcessor
parameters DocumentBuildParameters
markdownService IMarkdownService
return ImmutableList

Build() public method

public Build ( DocumentBuildParameters parameters ) : Manifest
parameters DocumentBuildParameters
return Microsoft.DocAsCode.Plugins.Manifest

Dispose() public method

public Dispose ( ) : void
return void