C# Class Microsoft.DocAsCode.Build.TableOfContents.TocDocumentProcessor

Inheritance: Microsoft.DocAsCode.Build.Common.DisposableDocumentProcessor
ファイルを表示 Open project: dotnet/docfx

Private Properties

Property Type Description
GetRelativePath string
GetXrefFromUid XRefSpec
RegisterTocMap void
ResolveHref string
ResolveUid void
UpdateTocItemHref void

Public Methods

Method Description
GetProcessingPriority ( FileAndType file ) : ProcessingPriority
Load ( FileAndType file, object>.ImmutableDictionary metadata ) : FileModel
Save ( FileModel model ) : SaveResult
UpdateHref ( FileModel model, IDocumentBuildContext context ) : void

Private Methods

Method Description
GetRelativePath ( string pathFromWorkingFolder, string relativeToPath ) : string
GetXrefFromUid ( string uid, FileModel model, IDocumentBuildContext context ) : XRefSpec
RegisterTocMap ( TocItemViewModel item, string key, IDocumentBuildContext context ) : void
ResolveHref ( string pathToFile, string originalPathToFile, FileModel model, IDocumentBuildContext context, string propertyName ) : string
ResolveUid ( TocItemViewModel item, FileModel model, IDocumentBuildContext context ) : void
UpdateTocItemHref ( TocItemViewModel toc, FileModel model, IDocumentBuildContext context ) : void

Method Details

GetProcessingPriority() public method

public GetProcessingPriority ( FileAndType file ) : ProcessingPriority
file FileAndType
return ProcessingPriority

Load() public method

public Load ( FileAndType file, object>.ImmutableDictionary metadata ) : FileModel
file FileAndType
metadata object>.ImmutableDictionary
return Microsoft.DocAsCode.Plugins.FileModel

Save() public method

public Save ( FileModel model ) : SaveResult
model Microsoft.DocAsCode.Plugins.FileModel
return Microsoft.DocAsCode.Plugins.SaveResult

UpdateHref() public method

public UpdateHref ( FileModel model, IDocumentBuildContext context ) : void
model Microsoft.DocAsCode.Plugins.FileModel
context IDocumentBuildContext
return void