Class DocumentationObject

A special component which provides documentation information in the editor

Inheritance

Object

DocumentationObject

Namespace: i5.Toolkit.Core.SceneDocumentation

Assembly: cs.temp.dll.dll

Syntax

public class DocumentationObject : MonoBehaviour

Fields

description

A description of the documented highlight

Declaration

public string description

Field Value

Type	Description
String

title

The title of the documentation

Declaration

public string title

Field Value

Type	Description
String

type

The type of documentation (e.g. information, todo mark or bug mark) Based on this, the icon is changed

Declaration

public DocumentationType type

Field Value

Type	Description
DocumentationType

url

A url to further documentation on the matter

Declaration

public string url

Field Value

Type	Description
String