XmlDocProvider.TryGetDoc Method

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

Definition

Attempts to retrieves the XML documentation for the specified code reference.
public virtual bool TryGetDoc(string cref, [NotNullWhen(true)] out XmlDocEntry doc)

Parameters

cref string
The code reference to retrieve the documentation for.
doc XmlDocEntry
When this method returns, contains the XmlDocEntry representing the documentation for the code reference, if the documentation is available; otherwise, null. This parameter is passed uninitialized.

Returns

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