XmlDocumentationProvider Class

Extracts summary and remarks XML documentation from an XML documentation file.

Namespace
Microsoft.AspNetCore.Razor.Runtime.TagHelpers
Assemblies
  • Microsoft.AspNetCore.Razor.Runtime

Syntax

public class XmlDocumentationProvider
class Microsoft.AspNetCore.Razor.Runtime.TagHelpers.XmlDocumentationProvider

Constructors

XmlDocumentationProvider(System.String)

Instantiates a new instance of the Microsoft.AspNetCore.Razor.Runtime.TagHelpers.XmlDocumentationProvider.

Arguments:xmlFileLocation (System.String) – Path to the XML documentation file to read. 
public XmlDocumentationProvider(string xmlFileLocation)

Methods

GetId(System.Reflection.PropertyInfo)

Generates the System.String identifier for the given <em>propertyInfo</em>.

Arguments:propertyInfo (System.Reflection.PropertyInfo) – The System.Reflection.PropertyInfo to get the identifier for.
Return type:System.String
Returns:The System.String identifier for the given <em>propertyInfo</em>. 
public static string GetId(PropertyInfo propertyInfo)
GetId(System.Type)

Generates the System.String identifier for the given <em>type</em>.

Arguments:type (System.Type) – The System.Type to get the identifier for.
Return type:System.String
Returns:The System.String identifier for the given <em>type</em>. 
public static string GetId(Type type)
GetRemarks(System.String)

Retrieves the <code><remarks></code> documentation for the given <em>id</em>.

Arguments:id (System.String) – The id to lookup.
Return type:System.String
Returns:<code><remarks></code> documentation for the given <em>id</em>. 
public string GetRemarks(string id)
GetSummary(System.String)

Retrieves the <code><summary></code> documentation for the given <em>id</em>.

Arguments:id (System.String) – The id to lookup.
Return type:System.String
Returns:<code><summary></code> documentation for the given <em>id</em>. 
public string GetSummary(string id)