<PackageReference Include="Namotion.Reflection" Version="3.4.2" />

XmlDocsExtensions

public static class XmlDocsExtensions
Provides extension methods for reading XML comments from reflected members.
public static string GetXmlDocs(this ContextualParameterInfo parameter, XmlDocsOptions options = null)

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

public static string GetXmlDocs(this ParameterInfo parameter, XmlDocsOptions options = null)

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

public static XElement GetXmlDocsElement(this MemberInfo member, XmlDocsOptions options = null)

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

public static XElement GetXmlDocsElement(this MemberInfo member, string pathToXmlFile, XmlDocsOptions options = null)

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

public static XElement GetXmlDocsElement(this ParameterInfo parameter, string pathToXmlFile, XmlDocsOptions options = null)

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

public static string GetXmlDocsPath(Assembly assembly, XmlDocsOptions options)

Gets the file path to the XML docs for the given assembly.

public static string GetXmlDocsRecordPropertySummary(this PropertyInfo member, XmlDocsOptions options = null)

Returns the property summary of a Record type which is read from the param tag on the type.

public static string GetXmlDocsRemarks(this CachedType type, XmlDocsOptions options = null)

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

public static string GetXmlDocsRemarks(this ContextualMemberInfo member, XmlDocsOptions options = null)

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

public static string GetXmlDocsRemarks(this Type type, XmlDocsOptions options = null)

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

public static string GetXmlDocsRemarks(this MemberInfo member, XmlDocsOptions options = null)

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

public static string GetXmlDocsSummary(this CachedType type, XmlDocsOptions options = null)

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

public static string GetXmlDocsSummary(this ContextualMemberInfo member, XmlDocsOptions options = null)

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

public static string GetXmlDocsSummary(this Type type, XmlDocsOptions options = null)

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

public static string GetXmlDocsSummary(this MemberInfo member, XmlDocsOptions options = null)

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

public static string GetXmlDocsTag(this CachedType type, string tagName, XmlDocsOptions options = null)

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

public static string GetXmlDocsTag(this ContextualMemberInfo member, string tagName, XmlDocsOptions options = null)

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

public static string GetXmlDocsTag(this Type type, string tagName, XmlDocsOptions options = null)

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

public static string GetXmlDocsTag(this MemberInfo member, string tagName, XmlDocsOptions options = null)

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

public static string ToXmlDocsContent(this XElement element, XmlDocsOptions options = null)

Converts the given XML documentation XElement to text.