markdocdocumentation IDocResolver

IDocResolver interface

Description

Interface for documentation resolvers

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph MarkDoc.Documentation
  MarkDoc.Documentation.IDocResolver[[IDocResolver]]
  class MarkDoc.Documentation.IDocResolver interfaceStyle;
  end

Loading

Members

Methods

Public methods

Returns	Name
Task	ResolveAsync(string path) Resolve xml documentation on given path
bool	TryFindType(IType type, out IDocElement resultType)

Details

Summary

Interface for documentation resolvers

Methods

ResolveAsync

public abstract Task ResolveAsync(string path)

Arguments

Type	Name	Description
string	path	Path to documentation

Summary

Resolve xml documentation on given path

TryFindType

public abstract bool TryFindType(IType type, out IDocElement resultType)

Arguments

Type	Name	Description
IType	type
out IDocElement	resultType

Generated with MarkDoc