NJsonSchema.Infrastructure.XmlDocumentationExtensions

XmlDocumentationExtensions

public static class XmlDocumentationExtensions

Provides extension methods for reading XML comments from reflected members.

public static string GetXmlDocumentation(this Type type)

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

public static string GetXmlDocumentation(this Type type, string tagName)

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

public static string GetXmlDocumentation(this MemberInfo member)

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

public static string GetXmlDocumentation(this MemberInfo member, string tagName)

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

public static string GetXmlDocumentation(this ParameterInfo parameter)

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

public static string GetXmlDocumentation(this Type type, string pathToXmlFile, string tagName)

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

public static string GetXmlDocumentation(this MemberInfo member, string pathToXmlFile, string tagName)

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

public static string GetXmlDocumentation(this ParameterInfo parameter, string pathToXmlFile)

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

public static string GetXmlRemarks(this Type type)

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

public static string GetXmlRemarks(this MemberInfo member)

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

public static string GetXmlSummary(this Type type)

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

public static string GetXmlSummary(this MemberInfo member)

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