XmlDocProvider.TryGetNamespaceDoc Method

Namespace
Kampute.DocToolkit.XmlDoc
Assembly
  • Kampute.DocToolkit.dll

Definition

Attempts to retrieves the XML documentation for the specified namespace.
public virtual bool TryGetNamespaceDoc(string ns, [NotNullWhen(true)] out XmlDocEntry doc)

Parameters

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.

Remarks

The XML documentation for a namespace is represented by a special type named "NamespaceDoc" within the namespace.