Getting started
Exporting
- Export quick start
- Examples
- Help compilers
- What are LDEC files
- Customising the export
- Creating your own LDEC files
API
GetEntryFor(String)
Retrieves the ContentEntry for the provided crefPath.
Namespace: TheBoxSoftware.API.LiveDocumenterAssembly: TheBoxSoftware.API.LiveDocumenter in (TheBoxSoftware.API.LiveDocumenter.dll)
Syntax
C#
public ContentEntry GetEntryFor( string crefPath )
Parameters
crefPathStringThe CRefPath to retrieve the documentation for.
Returns
The ContentEntry for the specified crefpath or null if not found.
Remarks
Each ContentEntry can be found by a unique cref path.
To retrieve a specific type the following can be used.
Documentation docs = new Documentation("mysolution.sln");
TableOfContents tocs = docs.GetTableOfContents();
ContentEntry method = tocs.GetEntryFor("T:TheBoxSoftware.API.LiveDocumenter.Documentation);