Documentation

The Documentation class provides access to methods which allow you to load and obtain information and documentation from a documentation file.

Inheritance

ObjectDocumentation

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

Syntax

public sealed class Documentation

Examples

Documentation can be instantiated simply by passing in a Visual Studio solution file, project or .NET library. Further you can create Live Documenter project files and load those for a more flexability.

You will need to call Load() to load the documentation in to memory.

using TheBoxSoftware.API.LiveDocumenter
{
    void Main()
    {
        Documentation fromSolution = new Documentation("c:\\Build\Output\VsSolution.sln");
        fromSolution.Load();
        
        Documentation fromLdProj = new Documentation("c:\\projectoutput.ldproj");
        fromLdProj.Load();
    }
}

Remarks

A Documentation instance is an accessor to the documentation file, it enables you to access information such as the table of contents for the documentation or documentation for a single type/member.

A documentation file is a .NET managed code DLL, Visual Studio Solution/Project or a Live Documenter project file (.ldec).

All returned results are provided in XML format, the specification for this format can be found .

Constructors

Documentation(String)

Initialises an instance of the Documentation class.

Methods

GetDocumentationFor(Int64)

Retrieves the XmlDocument for the provided key.

GetDocumentationFor(String)

Retrieves the XmlDocument for the provided crefPath.

GetDocumentationFor(ContentEntry)

Retrieves the XmlDocument for the provided entry.

GetTableOfContents()

Obtains the details of the Entries for the currently loaded documentation.

Load()

Initialises the state of the documentation class and prepares it so Documentation can be accessed.