XmlDocExtensions.TryGetNamespaceDoc Method

Namespace

Kampute.DocToolkit.XmlDoc

Assembly

• Kampute.DocToolkit.dll

Definition

public static bool TryGetNamespaceDoc(this IXmlDocProvider xmlDocProvider, string ns, [NotNullWhen(true)] out XmlDocEntry doc)

Parameters

xmlDocProvider IXmlDocProvider

The XML documentation provider to use.

ns string

The namespace to retrieve the documentation for.

doc XmlDocEntry

When this method returns, contains the XmlDocEntry representing the documentation for the namespace, if the documentation is available; otherwise, null.

Returns

bool

true if the documentation is available; otherwise, false.

Exceptions

ArgumentNullException

Thrown when xmlDocProvider is null.

ArgumentException

Thrown when ns is null, empty, or consists only of whitespace.

Remarks