<PackageReference Include="NJsonSchema" Version="9.10.67" />

XmlDocumentationExtensions

public static class XmlDocumentationExtensions
Provides extension methods for reading XML comments from reflected members.
public static Task<string> GetDescriptionAsync(this MemberInfo memberInfo, IEnumerable<Attribute> attributes)

Gets the description of the given member (based on the DescriptionAttribute, DisplayAttribute or XML Documentation).

public static Task<string> GetDescriptionAsync(this ParameterInfo parameter, IEnumerable<Attribute> attributes)

Gets the description of the given member (based on the DescriptionAttribute, DisplayAttribute or XML Documentation).

public static Task<string> GetXmlDocumentationAsync(this Type type)

Returns the contents of the "summary" XML documentation tag for the specified member.

public static Task<XElement> GetXmlDocumentationAsync(this MemberInfo member)

Returns the contents of an XML documentation tag for the specified member.

public static Task<string> GetXmlDocumentationAsync(this ParameterInfo parameter)

Returns the contents of the "returns" or "param" XML documentation tag for the specified parameter.

public static Task<XElement> GetXmlDocumentationAsync(this Type type, string pathToXmlFile)

Returns the contents of the "summary" XML documentation tag for the specified member.

public static Task<XElement> GetXmlDocumentationAsync(this MemberInfo member, string pathToXmlFile)

Returns the contents of the "summary" XML documentation tag for the specified member.

public static Task<XElement> GetXmlDocumentationAsync(this ParameterInfo parameter, string pathToXmlFile)

Returns the contents of the "returns" or "param" XML documentation tag for the specified parameter.

public static Task<string> GetXmlDocumentationTagAsync(this Type type, string tagName)

Returns the contents of an XML documentation tag for the specified member.

public static Task<string> GetXmlDocumentationTagAsync(this MemberInfo member, string tagName)

Returns the contents of an XML documentation tag for the specified member.

public static string GetXmlDocumentationText(this XElement element)

Converts the given XML documentation XElement to text.

public static Task<string> GetXmlRemarksAsync(this Type type)

Returns the contents of the "remarks" XML documentation tag for the specified member.

public static Task<string> GetXmlRemarksAsync(this MemberInfo member)

Returns the contents of the "remarks" XML documentation tag for the specified member.

public static Task<string> GetXmlSummaryAsync(this Type type)

Returns the contents of the "summary" XML documentation tag for the specified member.

public static Task<string> GetXmlSummaryAsync(this MemberInfo member)

Returns the contents of the "summary" XML documentation tag for the specified member.