From d264429726556b16ff1ddc45e67320e1db04a01b Mon Sep 17 00:00:00 2001 From: mmcwilliams Date: Thu, 21 Mar 2019 21:03:03 -0400 Subject: [PATCH] Create new doc files for new libs or ones with jsdoc --- app/lib/cmd/Readme.md | 0 app/lib/devices/Readme.md | 74 +++++++++++++++++++++++++++++++++++++++ app/lib/digital/Readme.md | 44 +++++++++++++++++++++++ app/lib/light/Readme.md | 32 +++++++++++++++++ app/lib/proj/Readme.md | 37 ++++++++++++++++++++ 5 files changed, 187 insertions(+) create mode 100644 app/lib/cmd/Readme.md create mode 100644 app/lib/devices/Readme.md create mode 100644 app/lib/digital/Readme.md create mode 100644 app/lib/light/Readme.md create mode 100644 app/lib/proj/Readme.md diff --git a/app/lib/cmd/Readme.md b/app/lib/cmd/Readme.md new file mode 100644 index 0000000..e69de29 diff --git a/app/lib/devices/Readme.md b/app/lib/devices/Readme.md new file mode 100644 index 0000000..e48bcbe --- /dev/null +++ b/app/lib/devices/Readme.md @@ -0,0 +1,74 @@ + + +## 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) + + + +### devices.init() +**Kind**: instance method of [Devices](#Devices) + + +### devices.listen() +**Kind**: instance method of [Devices](#Devices) + + +### devices.listener() +**Kind**: instance method of [Devices](#Devices) + + +### devices.enumerate() +**Kind**: instance method of [Devices](#Devices) + + +### devices.favor() +**Kind**: instance method of [Devices](#Devices) + + +### devices.distinguish() +**Kind**: instance method of [Devices](#Devices) + + +### devices.fakeProjector() +**Kind**: instance method of [Devices](#Devices) + + +### devices.fakeCamera() +**Kind**: instance method of [Devices](#Devices) + + +### devices.fakeLight() +**Kind**: instance method of [Devices](#Devices) + + +### devices.connectDevice() +**Kind**: instance method of [Devices](#Devices) + + +### devices.all() +**Kind**: instance method of [Devices](#Devices) + + +### devices.remember() +**Kind**: instance method of [Devices](#Devices) + + +### devices.ready() +**Kind**: instance method of [Devices](#Devices) diff --git a/app/lib/digital/Readme.md b/app/lib/digital/Readme.md new file mode 100644 index 0000000..967474c --- /dev/null +++ b/app/lib/digital/Readme.md @@ -0,0 +1,44 @@ + + +## 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) + + + +### digital.init() +**Kind**: instance method of [Digital](#Digital) + + +### digital.listen() +**Kind**: instance method of [Digital](#Digital) + + +### digital.set() +**Kind**: instance method of [Digital](#Digital) + + +### digital.move() +**Kind**: instance method of [Digital](#Digital) + + +### digital.start() +**Kind**: instance method of [Digital](#Digital) + + +### digital.end() +**Kind**: instance method of [Digital](#Digital) + + +### digital.connectDigital() +Use a file as the "digital" source on "projector" + +**Kind**: instance method of [Digital](#Digital) diff --git a/app/lib/light/Readme.md b/app/lib/light/Readme.md new file mode 100644 index 0000000..fbc28b4 --- /dev/null +++ b/app/lib/light/Readme.md @@ -0,0 +1,32 @@ + + +## Light +**Kind**: global class + +* [Light](#Light) + * [.init()](#Light+init) + * [.listen()](#Light+listen) + * [.listener()](#Light+listener) + * [.set()](#Light+set) + * [.end()](#Light+end) + + + +### light.init() +**Kind**: instance method of [Light](#Light) + + +### light.listen() +**Kind**: instance method of [Light](#Light) + + +### light.listener() +**Kind**: instance method of [Light](#Light) + + +### light.set() +**Kind**: instance method of [Light](#Light) + + +### light.end() +**Kind**: instance method of [Light](#Light) diff --git a/app/lib/proj/Readme.md b/app/lib/proj/Readme.md new file mode 100644 index 0000000..a3d61e0 --- /dev/null +++ b/app/lib/proj/Readme.md @@ -0,0 +1,37 @@ + + +## Projector +**Kind**: global class + +* [Projector](#Projector) + * [.init()](#Projector+init) + * [.listen()](#Projector+listen) + * [.set()](#Projector+set) + * [.move()](#Projector+move) + * [.listener()](#Projector+listener) + * [.end()](#Projector+end) + + + +### projector.init() +**Kind**: instance method of [Projector](#Projector) + + +### projector.listen() +**Kind**: instance method of [Projector](#Projector) + + +### projector.set() +**Kind**: instance method of [Projector](#Projector) + + +### projector.move() +**Kind**: instance method of [Projector](#Projector) + + +### projector.listener() +**Kind**: instance method of [Projector](#Projector) + + +### projector.end() +**Kind**: instance method of [Projector](#Projector)