Getting started
Exporting
- Export quick start
- Examples
- Help compilers
- What are LDEC files
- Customising the export
- Creating your own LDEC files
API
GetDocumentationFor(Int64)
Retrieves the XmlDocument for the provided key.
Namespace: TheBoxSoftware.API.LiveDocumenterAssembly: TheBoxSoftware.API.LiveDocumenter in (TheBoxSoftware.API.LiveDocumenter.dll)
Syntax
C#
public string GetDocumentationFor( long key )
Parameters
keyInt64The unique Entry.Key to retrieve the documentation for.
Returns
String
Remarks
Keys are generated each time a documentation set is produced, there is no gaunrentee that between each load the key will be the same. If you are looking for a stable reference use cref paths and the GetDocumentationFor(String) method.Exceptions
Thrown when the key provided does not resolve to a member in the documentation.
System.InvalidOperationException
Thrown when the Load method was not called, call the Load method first.