Getting started
Exporting
- Export quick start
- Examples
- Help compilers
- What are LDEC files
- Customising the export
- Creating your own LDEC files
API
CRefTypes
An enumeration of the available types of element that can be referenced by a cref path in the xml code comments for an assembly.
Namespace: TheBoxSoftware.API.LiveDocumenterAssembly: TheBoxSoftware.API.LiveDocumenter in (TheBoxSoftware.API.LiveDocumenter.dll)
Syntax
C#
public enum CRefTypes : byte
Members
Namespace
Represents a cref link to a namespace; these can not have commented directly but can be referenced.
Type
Represents a path to a type defined in this or another assembly.
Property
Represents a path to a property in a type.
Field
Represents a fully qualified path to a field in a type.
Method
Represents a fully qualified path to a method in a type.
Event
Represents a fully qualified path to an event.
Error
The compiler when generating the path could not resolve the type.