Search Results for

    Show / Hide Table of Contents

    Interface IHostService

    Namespace: Microsoft.DocAsCode.Plugins
    Assembly: Microsoft.DocAsCode.Plugins.dll
    Syntax
    public interface IHostService

    Properties

    | Improve this Doc View Source

    BuildParameters

    Declaration
    IBuildParameters BuildParameters { get; }
    Property Value
    Type Description
    IBuildParameters
    | Improve this Doc View Source

    GroupInfo

    Declaration
    GroupInfo GroupInfo { get; }
    Property Value
    Type Description
    GroupInfo
    | Improve this Doc View Source

    HasMetadataValidation

    Declaration
    bool HasMetadataValidation { get; }
    Property Value
    Type Description
    Boolean
    | Improve this Doc View Source

    IncrementalInfos

    Declaration
    ImmutableDictionary<string, FileIncrementalInfo> IncrementalInfos { get; }
    Property Value
    Type Description
    ImmutableDictionary<String, FileIncrementalInfo>
    | Improve this Doc View Source

    MarkdownServiceName

    Declaration
    string MarkdownServiceName { get; }
    Property Value
    Type Description
    String
    | Improve this Doc View Source

    Processor

    Get current IDocumentProcessor.

    Declaration
    IDocumentProcessor Processor { get; }
    Property Value
    Type Description
    IDocumentProcessor
    | Improve this Doc View Source

    SourceFiles

    Declaration
    ImmutableDictionary<string, FileAndType> SourceFiles { get; }
    Property Value
    Type Description
    ImmutableDictionary<String, FileAndType>
    | Improve this Doc View Source

    TableOfContentRestructions

    Declaration
    ImmutableList<TreeItemRestructure> TableOfContentRestructions { get; set; }
    Property Value
    Type Description
    ImmutableList<TreeItemRestructure>
    | Improve this Doc View Source

    VersionName

    current version's name, String.Empty for default version

    Declaration
    string VersionName { get; }
    Property Value
    Type Description
    String
    | Improve this Doc View Source

    VersionOutputFolder

    current version's output base folder

    Declaration
    string VersionOutputFolder { get; }
    Property Value
    Type Description
    String

    Methods

    | Improve this Doc View Source

    GetAllUids()

    Declaration
    ImmutableHashSet<string> GetAllUids()
    Returns
    Type Description
    ImmutableHashSet<String>
    | Improve this Doc View Source

    GetModels(Nullable<DocumentType>)

    Declaration
    ImmutableList<FileModel> GetModels(DocumentType? type = default(DocumentType? ))
    Parameters
    Type Name Description
    Nullable<DocumentType> type
    Returns
    Type Description
    ImmutableList<FileModel>
    | Improve this Doc View Source

    LogDiagnostic(String, String, String)

    Declaration
    void LogDiagnostic(string message, string file = null, string line = null)
    Parameters
    Type Name Description
    String message
    String file
    String line
    | Improve this Doc View Source

    LogError(String, String, String)

    Declaration
    void LogError(string message, string file = null, string line = null)
    Parameters
    Type Name Description
    String message
    String file
    String line
    | Improve this Doc View Source

    LogInfo(String, String, String)

    Declaration
    void LogInfo(string message, string file = null, string line = null)
    Parameters
    Type Name Description
    String message
    String file
    String line
    | Improve this Doc View Source

    LogSuggestion(String, String, String)

    Declaration
    void LogSuggestion(string message, string file = null, string line = null)
    Parameters
    Type Name Description
    String message
    String file
    String line
    | Improve this Doc View Source

    LogVerbose(String, String, String)

    Declaration
    void LogVerbose(string message, string file = null, string line = null)
    Parameters
    Type Name Description
    String message
    String file
    String line
    | Improve this Doc View Source

    LogWarning(String, String, String)

    Declaration
    void LogWarning(string message, string file = null, string line = null)
    Parameters
    Type Name Description
    String message
    String file
    String line
    | Improve this Doc View Source

    LookupByUid(String)

    Declaration
    ImmutableList<FileModel> LookupByUid(string uid)
    Parameters
    Type Name Description
    String uid
    Returns
    Type Description
    ImmutableList<FileModel>
    | Improve this Doc View Source

    Markup(String, FileAndType)

    Declaration
    MarkupResult Markup(string markdown, FileAndType ft)
    Parameters
    Type Name Description
    String markdown
    FileAndType ft
    Returns
    Type Description
    MarkupResult
    | Improve this Doc View Source

    Markup(String, FileAndType, Boolean)

    Declaration
    MarkupResult Markup(string markdown, FileAndType ft, bool omitParse)
    Parameters
    Type Name Description
    String markdown
    FileAndType ft
    Boolean omitParse
    Returns
    Type Description
    MarkupResult
    | Improve this Doc View Source

    Markup(String, FileAndType, Boolean, Boolean)

    Declaration
    MarkupResult Markup(string markdown, FileAndType ft, bool omitParse, bool enableValidation)
    Parameters
    Type Name Description
    String markdown
    FileAndType ft
    Boolean omitParse
    Boolean enableValidation
    Returns
    Type Description
    MarkupResult
    | Improve this Doc View Source

    Parse(MarkupResult, FileAndType)

    Declaration
    MarkupResult Parse(MarkupResult markupResult, FileAndType ft)
    Parameters
    Type Name Description
    MarkupResult markupResult
    FileAndType ft
    Returns
    Type Description
    MarkupResult
    | Improve this Doc View Source

    ReportDependencyFrom(FileModel, String, String)

    report dependency from

    Declaration
    void ReportDependencyFrom(FileModel currentFileModel, string from, string type)
    Parameters
    Type Name Description
    FileModel currentFileModel

    FileModel of 'to' node

    String from

    'from' node's file path from working directory or file path relative to 'to' FileModel

    String type

    dependency type

    | Improve this Doc View Source

    ReportDependencyFrom(FileModel, String, String, String)

    report dependency from

    Declaration
    void ReportDependencyFrom(FileModel currentFileModel, string from, string fromType, string type)
    Parameters
    Type Name Description
    FileModel currentFileModel

    FileModel of 'to' node

    String from

    'from' node's value

    String fromType

    'from' node's type, it could be file or reference type

    String type

    dependency type

    | Improve this Doc View Source

    ReportDependencyTo(FileModel, String, String)

    report dependency to

    Declaration
    void ReportDependencyTo(FileModel currentFileModel, string to, string type)
    Parameters
    Type Name Description
    FileModel currentFileModel

    FileModel of 'from' node

    String to

    'to' node's file path from working directory or file path relative to 'from' FileModel

    String type

    dependency type

    | Improve this Doc View Source

    ReportDependencyTo(FileModel, String, String, String)

    report dependency to

    Declaration
    void ReportDependencyTo(FileModel currentFileModel, string to, string toType, string type)
    Parameters
    Type Name Description
    FileModel currentFileModel

    FileModel of 'from' node

    String to

    'to' node's value

    String toType

    'to' node's type, it could be file or reference type

    String type

    dependency type

    | Improve this Doc View Source

    ReportReference(FileModel, String, String)

    report reference

    Declaration
    void ReportReference(FileModel currentFileModel, string reference, string referenceType)
    Parameters
    Type Name Description
    FileModel currentFileModel

    The current FileModel

    String reference

    the reference that the FileModel could provide

    String referenceType

    the type of the reference

    | Improve this Doc View Source

    ValidateInputMetadata(String, ImmutableDictionary<String, Object>)

    Declaration
    void ValidateInputMetadata(string file, ImmutableDictionary<string, object> metadata)
    Parameters
    Type Name Description
    String file
    ImmutableDictionary<String, Object> metadata

    Extension Methods

    JsonUtility.ToJsonString(Object, Formatting, JsonSerializer)
    • Improve this Doc
    • View Source
    • 0 Comments
    In This Article
    Back to top Copyright © Microsoft.
    Generated by DocFX