Getting started
Exporting
- Export quick start
- Examples
- Help compilers
- What are LDEC files
- Customising the export
- Creating your own LDEC files
API
CRefPath
Class that handles and parses a CRef comment path. A CRef path can contain a fully qualified link to a type, property, method etc in an assembly.
Inheritance
ObjectCRefPath
Namespace: TheBoxSoftware.API.LiveDocumenterAssembly: TheBoxSoftware.API.LiveDocumenter in (TheBoxSoftware.API.LiveDocumenter.dll)
Syntax
C#
public sealed class CRefPath
Remarks
Obtains the unique cref path for this content entry. See CRefPath for more information.
Constructors
Initialises a new instance of the CRefPath class.
Methods
Parses the provided path and returns a populated cref path instance.
Returns a string representation of this CRefPath.
Properties
Gets or sets a string that is the value of the element name from the cref path.
Gets or sets a string that indicates the namespace the type parsed from the cref path resides in.
A string representing the parameter section of the CRefPath.
Indicates the type of element that is referenced by the CRef path.
Gets or sets a string that indicates the name of the type from the CRef path.