Getting started
Exporting
- Export quick start
- Examples
- Help compilers
- What are LDEC files
- Customising the export
- Creating your own LDEC files
API
TableOfContents
Provides access to the table of contents for Documentation.
Inheritance
ObjectTableOfContents
Namespace: TheBoxSoftware.API.LiveDocumenterAssembly: TheBoxSoftware.API.LiveDocumenter in (TheBoxSoftware.API.LiveDocumenter.dll)
Syntax
C#
public sealed class TableOfContents: IEnumerable
Remarks
The TableOfContents is a heirarchical representation of the elements in the documentation. Each type, member and namespace is a ContentEntry which can be used to obtain the XML documentation.
Methods
Retrieves the ContentEntry for the provided key.
Retrieves the ContentEntry for the provided crefPath.
Searches the documentation and returns a list of ContentEntrys that match the search term.
Properties
Returns the number of top level elements in this Documentation.
Indicates if the collection is read only.
Gets the ContentEntry at the specified index.