Create new doc files for new libs or ones with jsdoc
This commit is contained in:
parent
65ba1f8c18
commit
d264429726
|
@ -0,0 +1,74 @@
|
||||||
|
<a name="Devices"></a>
|
||||||
|
|
||||||
|
## Devices
|
||||||
|
class representing the device discovery features
|
||||||
|
|
||||||
|
**Kind**: global class
|
||||||
|
|
||||||
|
* [Devices](#Devices)
|
||||||
|
* [.init()](#Devices+init)
|
||||||
|
* [.listen()](#Devices+listen)
|
||||||
|
* [.listener()](#Devices+listener)
|
||||||
|
* [.enumerate()](#Devices+enumerate)
|
||||||
|
* [.favor()](#Devices+favor)
|
||||||
|
* [.distinguish()](#Devices+distinguish)
|
||||||
|
* [.fakeProjector()](#Devices+fakeProjector)
|
||||||
|
* [.fakeCamera()](#Devices+fakeCamera)
|
||||||
|
* [.fakeLight()](#Devices+fakeLight)
|
||||||
|
* [.connectDevice()](#Devices+connectDevice)
|
||||||
|
* [.all()](#Devices+all)
|
||||||
|
* [.remember()](#Devices+remember)
|
||||||
|
* [.ready()](#Devices+ready)
|
||||||
|
|
||||||
|
<a name="Devices+init"></a>
|
||||||
|
|
||||||
|
### devices.init()
|
||||||
|
**Kind**: instance method of [<code>Devices</code>](#Devices)
|
||||||
|
<a name="Devices+listen"></a>
|
||||||
|
|
||||||
|
### devices.listen()
|
||||||
|
**Kind**: instance method of [<code>Devices</code>](#Devices)
|
||||||
|
<a name="Devices+listener"></a>
|
||||||
|
|
||||||
|
### devices.listener()
|
||||||
|
**Kind**: instance method of [<code>Devices</code>](#Devices)
|
||||||
|
<a name="Devices+enumerate"></a>
|
||||||
|
|
||||||
|
### devices.enumerate()
|
||||||
|
**Kind**: instance method of [<code>Devices</code>](#Devices)
|
||||||
|
<a name="Devices+favor"></a>
|
||||||
|
|
||||||
|
### devices.favor()
|
||||||
|
**Kind**: instance method of [<code>Devices</code>](#Devices)
|
||||||
|
<a name="Devices+distinguish"></a>
|
||||||
|
|
||||||
|
### devices.distinguish()
|
||||||
|
**Kind**: instance method of [<code>Devices</code>](#Devices)
|
||||||
|
<a name="Devices+fakeProjector"></a>
|
||||||
|
|
||||||
|
### devices.fakeProjector()
|
||||||
|
**Kind**: instance method of [<code>Devices</code>](#Devices)
|
||||||
|
<a name="Devices+fakeCamera"></a>
|
||||||
|
|
||||||
|
### devices.fakeCamera()
|
||||||
|
**Kind**: instance method of [<code>Devices</code>](#Devices)
|
||||||
|
<a name="Devices+fakeLight"></a>
|
||||||
|
|
||||||
|
### devices.fakeLight()
|
||||||
|
**Kind**: instance method of [<code>Devices</code>](#Devices)
|
||||||
|
<a name="Devices+connectDevice"></a>
|
||||||
|
|
||||||
|
### devices.connectDevice()
|
||||||
|
**Kind**: instance method of [<code>Devices</code>](#Devices)
|
||||||
|
<a name="Devices+all"></a>
|
||||||
|
|
||||||
|
### devices.all()
|
||||||
|
**Kind**: instance method of [<code>Devices</code>](#Devices)
|
||||||
|
<a name="Devices+remember"></a>
|
||||||
|
|
||||||
|
### devices.remember()
|
||||||
|
**Kind**: instance method of [<code>Devices</code>](#Devices)
|
||||||
|
<a name="Devices+ready"></a>
|
||||||
|
|
||||||
|
### devices.ready()
|
||||||
|
**Kind**: instance method of [<code>Devices</code>](#Devices)
|
|
@ -0,0 +1,44 @@
|
||||||
|
<a name="Digital"></a>
|
||||||
|
|
||||||
|
## Digital
|
||||||
|
**Kind**: global class
|
||||||
|
|
||||||
|
* [Digital](#Digital)
|
||||||
|
* [.init()](#Digital+init)
|
||||||
|
* [.listen()](#Digital+listen)
|
||||||
|
* [.set()](#Digital+set)
|
||||||
|
* [.move()](#Digital+move)
|
||||||
|
* [.start()](#Digital+start)
|
||||||
|
* [.end()](#Digital+end)
|
||||||
|
* [.connectDigital()](#Digital+connectDigital)
|
||||||
|
|
||||||
|
<a name="Digital+init"></a>
|
||||||
|
|
||||||
|
### digital.init()
|
||||||
|
**Kind**: instance method of [<code>Digital</code>](#Digital)
|
||||||
|
<a name="Digital+listen"></a>
|
||||||
|
|
||||||
|
### digital.listen()
|
||||||
|
**Kind**: instance method of [<code>Digital</code>](#Digital)
|
||||||
|
<a name="Digital+set"></a>
|
||||||
|
|
||||||
|
### digital.set()
|
||||||
|
**Kind**: instance method of [<code>Digital</code>](#Digital)
|
||||||
|
<a name="Digital+move"></a>
|
||||||
|
|
||||||
|
### digital.move()
|
||||||
|
**Kind**: instance method of [<code>Digital</code>](#Digital)
|
||||||
|
<a name="Digital+start"></a>
|
||||||
|
|
||||||
|
### digital.start()
|
||||||
|
**Kind**: instance method of [<code>Digital</code>](#Digital)
|
||||||
|
<a name="Digital+end"></a>
|
||||||
|
|
||||||
|
### digital.end()
|
||||||
|
**Kind**: instance method of [<code>Digital</code>](#Digital)
|
||||||
|
<a name="Digital+connectDigital"></a>
|
||||||
|
|
||||||
|
### digital.connectDigital()
|
||||||
|
Use a file as the "digital" source on "projector"
|
||||||
|
|
||||||
|
**Kind**: instance method of [<code>Digital</code>](#Digital)
|
|
@ -0,0 +1,32 @@
|
||||||
|
<a name="Light"></a>
|
||||||
|
|
||||||
|
## Light
|
||||||
|
**Kind**: global class
|
||||||
|
|
||||||
|
* [Light](#Light)
|
||||||
|
* [.init()](#Light+init)
|
||||||
|
* [.listen()](#Light+listen)
|
||||||
|
* [.listener()](#Light+listener)
|
||||||
|
* [.set()](#Light+set)
|
||||||
|
* [.end()](#Light+end)
|
||||||
|
|
||||||
|
<a name="Light+init"></a>
|
||||||
|
|
||||||
|
### light.init()
|
||||||
|
**Kind**: instance method of [<code>Light</code>](#Light)
|
||||||
|
<a name="Light+listen"></a>
|
||||||
|
|
||||||
|
### light.listen()
|
||||||
|
**Kind**: instance method of [<code>Light</code>](#Light)
|
||||||
|
<a name="Light+listener"></a>
|
||||||
|
|
||||||
|
### light.listener()
|
||||||
|
**Kind**: instance method of [<code>Light</code>](#Light)
|
||||||
|
<a name="Light+set"></a>
|
||||||
|
|
||||||
|
### light.set()
|
||||||
|
**Kind**: instance method of [<code>Light</code>](#Light)
|
||||||
|
<a name="Light+end"></a>
|
||||||
|
|
||||||
|
### light.end()
|
||||||
|
**Kind**: instance method of [<code>Light</code>](#Light)
|
|
@ -0,0 +1,37 @@
|
||||||
|
<a name="Projector"></a>
|
||||||
|
|
||||||
|
## Projector
|
||||||
|
**Kind**: global class
|
||||||
|
|
||||||
|
* [Projector](#Projector)
|
||||||
|
* [.init()](#Projector+init)
|
||||||
|
* [.listen()](#Projector+listen)
|
||||||
|
* [.set()](#Projector+set)
|
||||||
|
* [.move()](#Projector+move)
|
||||||
|
* [.listener()](#Projector+listener)
|
||||||
|
* [.end()](#Projector+end)
|
||||||
|
|
||||||
|
<a name="Projector+init"></a>
|
||||||
|
|
||||||
|
### projector.init()
|
||||||
|
**Kind**: instance method of [<code>Projector</code>](#Projector)
|
||||||
|
<a name="Projector+listen"></a>
|
||||||
|
|
||||||
|
### projector.listen()
|
||||||
|
**Kind**: instance method of [<code>Projector</code>](#Projector)
|
||||||
|
<a name="Projector+set"></a>
|
||||||
|
|
||||||
|
### projector.set()
|
||||||
|
**Kind**: instance method of [<code>Projector</code>](#Projector)
|
||||||
|
<a name="Projector+move"></a>
|
||||||
|
|
||||||
|
### projector.move()
|
||||||
|
**Kind**: instance method of [<code>Projector</code>](#Projector)
|
||||||
|
<a name="Projector+listener"></a>
|
||||||
|
|
||||||
|
### projector.listener()
|
||||||
|
**Kind**: instance method of [<code>Projector</code>](#Projector)
|
||||||
|
<a name="Projector+end"></a>
|
||||||
|
|
||||||
|
### projector.end()
|
||||||
|
**Kind**: instance method of [<code>Projector</code>](#Projector)
|
Loading…
Reference in New Issue