Merge pull request #34 from ExtendRealityLtd/feat/api_docs

feat(API): add auto-generated API documentation

Author: thestonefox

.gitignore

@@ -1,6 +1,7 @@
 [Ll]ibrary/
 [Tt]emp/
 [Oo]bj/
+[Oo]bj.meta
 [Bb]uild/
 [Bb]uilds/
 [Ll]ogs/
@@ -32,4 +33,4 @@ ExportedObj/
 
 # System files
 .DS_Store
-*.swp
+*.swp

Documentation/API.meta

@@ -0,0 +1,20 @@
+# Namespace Tilia.Input.UnityInputManager
+
+### Classes
+
+#### [UnityInputManagerAxis1DAction]
+
+Listens for the specified axis and emits the appropriate action.
+
+#### [UnityInputManagerAxis2DAction]
+
+Listens for the specified axes and emits the appropriate action.
+
+#### [UnityInputManagerButtonAction]
+
+Listens for the specified [KeyCode] state and emits the appropriate action.
+
+[UnityInputManagerAxis1DAction]: UnityInputManagerAxis1DAction.md
+[UnityInputManagerAxis2DAction]: UnityInputManagerAxis2DAction.md
+[UnityInputManagerButtonAction]: UnityInputManagerButtonAction.md
+[KeyCode]: UnityInputManagerButtonAction.md#Tilia_Input_UnityInputManager_UnityInputManagerButtonAction_KeyCode

Documentation/API/README.md

@@ -0,0 +1,83 @@
+# Class UnityInputManagerAxis1DAction
+
+Listens for the specified axis and emits the appropriate action.
+
+## Contents
+
+* [Inheritance]
+* [Namespace]
+* [Syntax]
+* [Properties]
+  * [AxisName]
+  * [Multiplier]
+* [Methods]
+  * [Process()]
+* [Implements]
+
+## Details
+
+##### Inheritance
+
+* System.Object
+* UnityInputManagerAxis1DAction
+
+##### Implements
+
+IProcessable
+
+##### Namespace
+
+* [Tilia.Input.UnityInputManager]
+
+##### Syntax
+
+```
+public class UnityInputManagerAxis1DAction : FloatAction, IProcessable
+```
+
+### Properties
+
+#### AxisName
+
+The named axis to listen for state changes on.
+
+##### Declaration
+
+```
+public string AxisName { get; set; }
+```
+
+#### Multiplier
+
+Multiplies the axis value.
+
+##### Declaration
+
+```
+public float Multiplier { get; set; }
+```
+
+### Methods
+
+#### Process()
+
+##### Declaration
+
+```
+public void Process()
+```
+
+### Implements
+
+IProcessable
+
+[Tilia.Input.UnityInputManager]: README.md
+[Inheritance]: #Inheritance
+[Namespace]: #Namespace
+[Syntax]: #Syntax
+[Properties]: #Properties
+[AxisName]: #AxisName
+[Multiplier]: #Multiplier
+[Methods]: #Methods
+[Process()]: #Process
+[Implements]: #Implements

Documentation/API/README.md.meta

@@ -0,0 +1,107 @@
+# Class UnityInputManagerAxis2DAction
+
+Listens for the specified axes and emits the appropriate action.
+
+## Contents
+
+* [Inheritance]
+* [Namespace]
+* [Syntax]
+* [Properties]
+  * [XAxisName]
+  * [XMultiplier]
+  * [YAxisName]
+  * [YMultiplier]
+* [Methods]
+  * [Process()]
+* [Implements]
+
+## Details
+
+##### Inheritance
+
+* System.Object
+* UnityInputManagerAxis2DAction
+
+##### Implements
+
+IProcessable
+
+##### Namespace
+
+* [Tilia.Input.UnityInputManager]
+
+##### Syntax
+
+```
+public class UnityInputManagerAxis2DAction : Vector2Action, IProcessable
+```
+
+### Properties
+
+#### XAxisName
+
+The named x axis to listen for state changes on.
+
+##### Declaration
+
+```
+public string XAxisName { get; set; }
+```
+
+#### XMultiplier
+
+Multiplies the x axis value.
+
+##### Declaration
+
+```
+public float XMultiplier { get; set; }
+```
+
+#### YAxisName
+
+The named y axis to listen for state changes on.
+
+##### Declaration
+
+```
+public string YAxisName { get; set; }
+```
+
+#### YMultiplier
+
+Multiplies the y axis value.
+
+##### Declaration
+
+```
+public float YMultiplier { get; set; }
+```
+
+### Methods
+
+#### Process()
+
+##### Declaration
+
+```
+public void Process()
+```
+
+### Implements
+
+IProcessable
+
+[Tilia.Input.UnityInputManager]: README.md
+[Inheritance]: #Inheritance
+[Namespace]: #Namespace
+[Syntax]: #Syntax
+[Properties]: #Properties
+[XAxisName]: #XAxisName
+[XMultiplier]: #XMultiplier
+[YAxisName]: #YAxisName
+[YMultiplier]: #YMultiplier
+[Methods]: #Methods
+[Process()]: #Process
+[Implements]: #Implements

Documentation/API/UnityInputManagerAxis1DAction.md

@@ -0,0 +1,72 @@
+# Class UnityInputManagerButtonAction
+
+Listens for the specified [KeyCode] state and emits the appropriate action.
+
+## Contents
+
+* [Inheritance]
+* [Namespace]
+* [Syntax]
+* [Properties]
+  * [KeyCode]
+* [Methods]
+  * [Process()]
+* [Implements]
+
+## Details
+
+##### Inheritance
+
+* System.Object
+* UnityInputManagerButtonAction
+
+##### Implements
+
+IProcessable
+
+##### Namespace
+
+* [Tilia.Input.UnityInputManager]
+
+##### Syntax
+
+```
+public class UnityInputManagerButtonAction : BooleanAction, IProcessable
+```
+
+### Properties
+
+#### KeyCode
+
+The UnityEngine.KeyCode to listen for state changes on.
+
+##### Declaration
+
+```
+public KeyCode KeyCode { get; set; }
+```
+
+### Methods
+
+#### Process()
+
+##### Declaration
+
+```
+public void Process()
+```
+
+### Implements
+
+IProcessable
+
+[KeyCode]: UnityInputManagerButtonAction.md#KeyCode
+[Tilia.Input.UnityInputManager]: README.md
+[Inheritance]: #Inheritance
+[Namespace]: #Namespace
+[Syntax]: #Syntax
+[Properties]: #Properties
+[KeyCode]: #KeyCode
+[Methods]: #Methods
+[Process()]: #Process
+[Implements]: #Implements