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

XmlDocsExtensions

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

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

public static string GetXmlDocs(this ParameterInfo parameter, bool resolveExternalXmlDocs = true)

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

public static XElement GetXmlDocsElement(this ContextualMemberInfo member, bool resolveExternalXmlDocs = true)

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

public static XElement GetXmlDocsElement(this Type type, string pathToXmlFile, bool resolveExternalXmlDocs = true)

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

public static XElement GetXmlDocsElement(this MemberInfo member, bool resolveExternalXmlDocs = true)

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

public static XElement GetXmlDocsElement(this MemberInfo member, string pathToXmlFile, bool resolveExternalXmlDocs = true)

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

public static XElement GetXmlDocsElement(this ParameterInfo parameter, string pathToXmlFile, bool resolveExternalXmlDocs = true)

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

public static string GetXmlDocsRecordPropertySummary(this PropertyInfo member, bool resolveExternalXmlDocs = true)

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, bool resolveExternalXmlDocs = true)

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

public static string GetXmlDocsRemarks(this ContextualMemberInfo member, bool resolveExternalXmlDocs = true)

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

public static string GetXmlDocsRemarks(this Type type, bool resolveExternalXmlDocs = true)

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

public static string GetXmlDocsRemarks(this MemberInfo member, bool resolveExternalXmlDocs = true)

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

public static string GetXmlDocsSummary(this CachedType type, bool resolveExternalXmlDocs = true)

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

public static string GetXmlDocsSummary(this ContextualMemberInfo member, bool resolveExternalXmlDocs = true)

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

public static string GetXmlDocsSummary(this Type type, bool resolveExternalXmlDocs = true)

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

public static string GetXmlDocsSummary(this MemberInfo member, bool resolveExternalXmlDocs = true)

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

public static string GetXmlDocsTag(this CachedType type, string tagName, bool resolveExternalXmlDocs = true)

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

public static string GetXmlDocsTag(this ContextualMemberInfo member, string tagName, bool resolveExternalXmlDocs = true)

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

public static string GetXmlDocsTag(this Type type, string tagName, bool resolveExternalXmlDocs = true)

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

public static string GetXmlDocsTag(this MemberInfo member, string tagName, bool resolveExternalXmlDocs = true)

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

public static string ToXmlDocsContent(this XElement element)

Converts the given XML documentation XElement to text.