GetDocumentationFor(String)

Retrieves the XmlDocument for the provided crefPath.

Namespace: TheBoxSoftware.API.LiveDocumenterAssembly: TheBoxSoftware.API.LiveDocumenter in (TheBoxSoftware.API.LiveDocumenter.dll)

Syntax

public string GetDocumentationFor(
	string crefPath
	)

crefPathString

The CRefPath to retrieve the documentation for.

String

A cref path is a way of determining a unique identifier for a type and is generated by the XML documentation compiler when XML comments are produced.

You can retrieve cref paths easily in the API by finding the element you want to GetDocumentationFor from the table of contents.

Thrown when the key provided does not resolve to a member in the documentation.

Thrown when the provided crefPath does not parse correctly.

System.ArgumentNullException

The provided crefPath was null or empty.

System.InvalidOperationException

Thrown when the Load method was not called, call the Load method first.