VR Development Framework
v 1.0.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Pages
Public Member Functions | Private Attributes | List of all members
AVR.Core.Attributes.DocumentationUrl Class Reference

Sets the documentation html file inside of Packages/com.avr.core/Documentation/html of a given class. When the user clicks on the documentation button in the inspector the respective page will be opened. Example: More...

Inheritance diagram for AVR.Core.Attributes.DocumentationUrl:

Public Member Functions

 DocumentationUrl (string url)
 Defines the html file used for documentation for an AVR_Component.

Parameters
urlFile relative to Packages/com.avr.core/Documentation/html that is the documentation for this class.
More...
 
string getDocumentationUrl ()
 

Private Attributes

string url
 

Detailed Description

Sets the documentation html file inside of Packages/com.avr.core/Documentation/html of a given class. When the user clicks on the documentation button in the inspector the respective page will be opened. Example:

[AVR.Core.Attributes.DocumentationUrl("class_a_v_r_1_1_core_1_1_a_v_r___controller.html")]
public class AVR_Controller : AVR_GenericXRDevice
{ ... }

Definition at line 89 of file AVR_Attributes.cs.