Class Documentation

Need to live in Runtime as Attribute of documentation is on Runtime classes \o/

Inheritance

Object

Documentation

Namespace: Mechatronics.SystemGraph

Syntax

public static class Documentation

Fields

baseURL

This must be used like [HelpURL(Documentation.baseURL + Documentation.version + Documentation.subURL + "some-page" + Documentation.endURL)] or [HelpURL(Documentation.baseURL + Documentation.version + Documentation.subURL + "some-guide/some-page" + Documentation.endURL)] It cannot support String.Format nor string interpolation

Declaration

public const string baseURL = "https://docs.unity.cn/Packages/com.unity.systemgraph@"

Field Value

Type	Description
String

endURL

Url file extension

Declaration

public const string endURL = ".html"

Field Value

Type	Description
String

subURL

Url folder path

Declaration

public const string subURL = "/manual/"

Field Value

Type	Description
String

version

Update this field when upgrading the target Documentation for the package Should be linked to the package version somehow.

Declaration

public const string version = "2.0"

Field Value

Type	Description
String