XmlDocExtensions.TryGetMemberDoc Method

Namespace

Kampute.DocToolkit.XmlDoc

Assembly

Kampute.DocToolkit.dll

Definition

Attempts to retrieves the XML documentation for the specified member.

public static bool TryGetMemberDoc(this IXmlDocProvider xmlDocProvider, IMember member, [NotNullWhen(true)] out XmlDocEntry doc)

Parameters

xmlDocProvider IXmlDocProvider: The XML documentation provider to use.
member IMember: The member to retrieve the documentation for.
doc XmlDocEntry: When this method returns, contains the XmlDocEntry representing the documentation for the member, if the documentation is available; otherwise, null.

Returns

bool: true if the documentation is available; otherwise, false.

Exceptions

ArgumentNullException: Thrown when xmlDocProvider or member is null.