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

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

Private Properties

Property Type Description
GetAllSourceFiles FileAndType>.ImmutableDictionary
GetExternalReference XRefSpec
LoadXRefMap Task
LoadXRefMaps List
ResolveByExternalReferencePackages List
ResolveByXRefMaps List

Public Methods

Method Description
DocumentBuildContext ( string buildOutputFolder ) : System
DocumentBuildContext ( string buildOutputFolder, IEnumerable allSourceFiles, ImmutableArray externalReferencePackages, ImmutableArray xrefMaps, int maxParallelism, string baseFolder ) : System
GetFilePath ( string key ) : string
GetTocFileKeySet ( string key ) : IImmutableList
GetTocInfo ( ) : IImmutableList
GetXrefSpec ( string uid ) : XRefSpec
RegisterInternalXrefSpec ( XRefSpec xrefSpec ) : void
RegisterInternalXrefSpecBookmark ( string uid, string bookmark ) : void
RegisterToc ( string tocFileKey, string fileKey ) : void
RegisterTocInfo ( TocInfo toc ) : void
ReportExternalXRefSpec ( XRefSpec spec ) : void
ResolveExternalXRefSpec ( ) : void
SetFilePath ( string key, string filePath ) : void

Private Methods

Method Description
GetAllSourceFiles ( IEnumerable allSourceFiles ) : FileAndType>.ImmutableDictionary
GetExternalReference ( ExternalReferencePackageCollection externalReferences, string uid ) : XRefSpec
LoadXRefMap ( string url, HttpClient client ) : Task
LoadXRefMaps ( ) : List
ResolveByExternalReferencePackages ( List uidList, XRefSpec>.ConcurrentDictionary externalXRefSpec ) : List
ResolveByXRefMaps ( List uidList, XRefSpec>.ConcurrentDictionary externalXRefSpec ) : List

Method Details

DocumentBuildContext() public method

public DocumentBuildContext ( string buildOutputFolder ) : System
buildOutputFolder string
return System

DocumentBuildContext() public method

public DocumentBuildContext ( string buildOutputFolder, IEnumerable allSourceFiles, ImmutableArray externalReferencePackages, ImmutableArray xrefMaps, int maxParallelism, string baseFolder ) : System
buildOutputFolder string
allSourceFiles IEnumerable
externalReferencePackages ImmutableArray
xrefMaps ImmutableArray
maxParallelism int
baseFolder string
return System

GetFilePath() public method

public GetFilePath ( string key ) : string
key string
return string

GetTocFileKeySet() public method

public GetTocFileKeySet ( string key ) : IImmutableList
key string
return IImmutableList

GetTocInfo() public method

public GetTocInfo ( ) : IImmutableList
return IImmutableList

GetXrefSpec() public method

public GetXrefSpec ( string uid ) : XRefSpec
uid string
return XRefSpec

RegisterInternalXrefSpec() public method

public RegisterInternalXrefSpec ( XRefSpec xrefSpec ) : void
xrefSpec XRefSpec
return void

RegisterInternalXrefSpecBookmark() public method

public RegisterInternalXrefSpecBookmark ( string uid, string bookmark ) : void
uid string
bookmark string
return void

RegisterToc() public method

public RegisterToc ( string tocFileKey, string fileKey ) : void
tocFileKey string
fileKey string
return void

RegisterTocInfo() public method

public RegisterTocInfo ( TocInfo toc ) : void
toc Microsoft.DocAsCode.Plugins.TocInfo
return void

ReportExternalXRefSpec() public method

public ReportExternalXRefSpec ( XRefSpec spec ) : void
spec XRefSpec
return void

ResolveExternalXRefSpec() public method

public ResolveExternalXRefSpec ( ) : void
return void

SetFilePath() public method

public SetFilePath ( string key, string filePath ) : void
key string
filePath string
return void