Remove extra function name from docs

jsdoc does this well enough without repeating. Does not actually
improve readability in code
This commit is contained in:
mmcwilliams 2017-09-19 15:23:48 -04:00
parent 52c0c6f352
commit aadf6aef37
8 changed files with 2 additions and 36 deletions

View File

@ -7,7 +7,6 @@ Class representing the bluetooth interface
<a name="Blootstrap+on"></a> <a name="Blootstrap+on"></a>
### blootstrap.on(eventName, callback) ### blootstrap.on(eventName, callback)
Blootstrap.on() -
Binds functions to events that are triggered by BLE messages Binds functions to events that are triggered by BLE messages
**Kind**: instance method of [<code>Blootstrap</code>](#Blootstrap) **Kind**: instance method of [<code>Blootstrap</code>](#Blootstrap)

View File

@ -26,7 +26,6 @@ class Blootstrap {
}) })
} }
/** /**
* Blootstrap.on() -
* Binds functions to events that are triggered by BLE messages * Binds functions to events that are triggered by BLE messages
* *
* @param {string} eventName Name of the event to to bind * @param {string} eventName Name of the event to to bind

View File

@ -18,14 +18,12 @@ Class representing the intval3 features
<a name="Intval+_declarePins"></a> <a name="Intval+_declarePins"></a>
### intval._declarePins() ### intval._declarePins()
Intval._declarePins() -
(internal function) Declares all Gpio pins that will be used (internal function) Declares all Gpio pins that will be used
**Kind**: instance method of [<code>Intval</code>](#Intval) **Kind**: instance method of [<code>Intval</code>](#Intval)
<a name="Intval+_undeclarePins"></a> <a name="Intval+_undeclarePins"></a>
### intval._undeclarePins() ### intval._undeclarePins()
Intval._undeclarePins() -
(internal function) Undeclares all Gpio in event of uncaught error (internal function) Undeclares all Gpio in event of uncaught error
that interupts the node process that interupts the node process
@ -33,28 +31,24 @@ that interupts the node process
<a name="Intval+_startFwd"></a> <a name="Intval+_startFwd"></a>
### intval._startFwd() ### intval._startFwd()
Intval._startFwd() -
Start motor in forward direction by setting correct pins in h-bridge Start motor in forward direction by setting correct pins in h-bridge
**Kind**: instance method of [<code>Intval</code>](#Intval) **Kind**: instance method of [<code>Intval</code>](#Intval)
<a name="Intval+_startBwd"></a> <a name="Intval+_startBwd"></a>
### intval._startBwd() ### intval._startBwd()
Intval._startBwd() -
Start motor in backward direction by setting correct pins in h-bridge Start motor in backward direction by setting correct pins in h-bridge
**Kind**: instance method of [<code>Intval</code>](#Intval) **Kind**: instance method of [<code>Intval</code>](#Intval)
<a name="Intval+_stop"></a> <a name="Intval+_stop"></a>
### intval._stop() ### intval._stop()
Intval._stop() -
Stop motor by setting both motor pins to 0 (LOW) Stop motor by setting both motor pins to 0 (LOW)
**Kind**: instance method of [<code>Intval</code>](#Intval) **Kind**: instance method of [<code>Intval</code>](#Intval)
<a name="Intval+_watchMicro"></a> <a name="Intval+_watchMicro"></a>
### intval._watchMicro(err, val) ### intval._watchMicro(err, val)
Intval._watchMicro() -
Callback for watching relese switch state changes. Callback for watching relese switch state changes.
Using GPIO 06 on Raspberry Pi Zero W. Using GPIO 06 on Raspberry Pi Zero W.
* If closed, start timer. * If closed, start timer.
@ -74,7 +68,6 @@ Microswitch + 10K ohm resistor
<a name="Intval+_watchRelease"></a> <a name="Intval+_watchRelease"></a>
### intval._watchRelease(err, val) ### intval._watchRelease(err, val)
Intval._watchRelease() -
Callback for watching relese switch state changes. Callback for watching relese switch state changes.
Using GPIO 05 on Raspberry Pi Zero W. Using GPIO 05 on Raspberry Pi Zero W.
@ -97,7 +90,6 @@ Button + 10K ohm resistor
<a name="Intval+frame"></a> <a name="Intval+frame"></a>
### intval.frame([dir], [time], [delay]) ### intval.frame([dir], [time], [delay])
Intval.frame() -
Begin a single frame with set variables or defaults Begin a single frame with set variables or defaults
**Kind**: instance method of [<code>Intval</code>](#Intval) **Kind**: instance method of [<code>Intval</code>](#Intval)

View File

@ -55,7 +55,6 @@ class Intval {
process.on('SIGINT', this._undeclarePins) process.on('SIGINT', this._undeclarePins)
} }
/** /**
* Intval._declarePins() -
* (internal function) Declares all Gpio pins that will be used * (internal function) Declares all Gpio pins that will be used
* *
*/ */
@ -69,8 +68,7 @@ class Intval {
console.dir(this._pin) console.dir(this._pin)
this._pin.release.watch(this._watchRelease) this._pin.release.watch(this._watchRelease)
} }
/** /**
* Intval._undeclarePins() -
* (internal function) Undeclares all Gpio in event of uncaught error * (internal function) Undeclares all Gpio in event of uncaught error
* that interupts the node process * that interupts the node process
* *
@ -82,7 +80,6 @@ class Intval {
this._pin.release.unexport() this._pin.release.unexport()
} }
/** /**
* Intval._startFwd() -
* Start motor in forward direction by setting correct pins in h-bridge * Start motor in forward direction by setting correct pins in h-bridge
* *
*/ */
@ -92,7 +89,6 @@ class Intval {
//start high-cpu watch //start high-cpu watch
} }
/** /**
* Intval._startBwd() -
* Start motor in backward direction by setting correct pins in h-bridge * Start motor in backward direction by setting correct pins in h-bridge
* *
*/ */
@ -100,8 +96,7 @@ class Intval {
this._pin.fwd.set(0) this._pin.fwd.set(0)
this._pin.bwd.set(1) this._pin.bwd.set(1)
} }
/** /**
* Intval._stop() -
* Stop motor by setting both motor pins to 0 (LOW) * Stop motor by setting both motor pins to 0 (LOW)
* *
*/ */
@ -117,7 +112,6 @@ class Intval {
this._state.frame.active = false this._state.frame.active = false
} }
/** /**
* Intval._watchMicro() -
* Callback for watching relese switch state changes. * Callback for watching relese switch state changes.
* Using GPIO 06 on Raspberry Pi Zero W. * Using GPIO 06 on Raspberry Pi Zero W.
* * If closed, start timer. * * If closed, start timer.
@ -140,7 +134,6 @@ class Intval {
//determine when to stop //determine when to stop
} }
/** /**
* Intval._watchRelease() -
* Callback for watching relese switch state changes. * Callback for watching relese switch state changes.
* Using GPIO 05 on Raspberry Pi Zero W. * Using GPIO 05 on Raspberry Pi Zero W.
* *
@ -191,7 +184,6 @@ class Intval {
this._state.dir = val this._state.dir = val
} }
/** /**
* Intval.frame() -
* Begin a single frame with set variables or defaults * Begin a single frame with set variables or defaults
* *
* @param {?boolean} [dir="null"] (optional) Direction of the frame * @param {?boolean} [dir="null"] (optional) Direction of the frame

View File

@ -7,7 +7,6 @@ Object representing a fake onoff Gpio class
<a name="onoffsim.Gpio"></a> <a name="onoffsim.Gpio"></a>
### onoffsim.Gpio(no, dir, additional) ⇒ <code>object</code> ### onoffsim.Gpio(no, dir, additional) ⇒ <code>object</code>
Gpio() -
Returns a Gpio class in the case of running on a dev machine Returns a Gpio class in the case of running on a dev machine
**Kind**: static method of [<code>onoffsim</code>](#onoffsim) **Kind**: static method of [<code>onoffsim</code>](#onoffsim)

View File

@ -3,7 +3,6 @@
/** Object representing a fake onoff Gpio class */ /** Object representing a fake onoff Gpio class */
const onoffsim = { const onoffsim = {
/** /**
* Gpio() -
* Returns a Gpio class in the case of running on a dev machine * Returns a Gpio class in the case of running on a dev machine
* *
* @param {integer} no Number of the GPIO pin * @param {integer} no Number of the GPIO pin

View File

@ -17,7 +17,6 @@ Class representing the wifi features
<a name="Wifi+list"></a> <a name="Wifi+list"></a>
### wifi.list(callback) ### wifi.list(callback)
Wifi.list() -
List available wifi access points List available wifi access points
**Kind**: instance method of [<code>Wifi</code>](#Wifi) **Kind**: instance method of [<code>Wifi</code>](#Wifi)
@ -29,7 +28,6 @@ List available wifi access points
<a name="Wifi+_readConfigCb"></a> <a name="Wifi+_readConfigCb"></a>
### wifi._readConfigCb(err, data) ### wifi._readConfigCb(err, data)
Wifi._readConfigCb() -
(internal function) Invoked after config file is read, (internal function) Invoked after config file is read,
then invokes file write on the config file then invokes file write on the config file
@ -43,7 +41,6 @@ then invokes file write on the config file
<a name="Wifi+_writeConfigCb"></a> <a name="Wifi+_writeConfigCb"></a>
### wifi._writeConfigCb(err) ### wifi._writeConfigCb(err)
Wifi._writeConfigCb() -
(internal function) Invoked after config file is written, (internal function) Invoked after config file is written,
then executes reconfiguration command then executes reconfiguration command
@ -56,7 +53,6 @@ then executes reconfiguration command
<a name="Wifi+_reconfigureCb"></a> <a name="Wifi+_reconfigureCb"></a>
### wifi._reconfigureCb(err, stdout, stderr) ### wifi._reconfigureCb(err, stdout, stderr)
Wifi._reconfigureCb() -
(internal function) Invoked after reconfiguration command is complete (internal function) Invoked after reconfiguration command is complete
**Kind**: instance method of [<code>Wifi</code>](#Wifi) **Kind**: instance method of [<code>Wifi</code>](#Wifi)
@ -70,7 +66,6 @@ Wifi._reconfigureCb() -
<a name="Wifi+_refreshCb"></a> <a name="Wifi+_refreshCb"></a>
### wifi._refreshCb(err, stdout, stderr) ### wifi._refreshCb(err, stdout, stderr)
Wifi._refreshCb() -
(internal function) Invoked after wifi refresh command is complete (internal function) Invoked after wifi refresh command is complete
**Kind**: instance method of [<code>Wifi</code>](#Wifi) **Kind**: instance method of [<code>Wifi</code>](#Wifi)
@ -84,7 +79,6 @@ Wifi._refreshCb() -
<a name="Wifi+setNetwork"></a> <a name="Wifi+setNetwork"></a>
### wifi.setNetwork(ssid, pwd, callback) ### wifi.setNetwork(ssid, pwd, callback)
Wifi.setNetwork() -
Function which initializes the processes for adding a wifi access point authentication Function which initializes the processes for adding a wifi access point authentication
**Kind**: instance method of [<code>Wifi</code>](#Wifi) **Kind**: instance method of [<code>Wifi</code>](#Wifi)
@ -98,7 +92,6 @@ Function which initializes the processes for adding a wifi access point authenti
<a name="Wifi+getNetwork"></a> <a name="Wifi+getNetwork"></a>
### wifi.getNetwork(callback) ### wifi.getNetwork(callback)
Wifi.getNetwork() -
Executes command which gets the currently connected network Executes command which gets the currently connected network
**Kind**: instance method of [<code>Wifi</code>](#Wifi) **Kind**: instance method of [<code>Wifi</code>](#Wifi)

View File

@ -20,7 +20,6 @@ class Wifi {
this._ssid = null this._ssid = null
} }
/** /**
* Wifi.list() -
* List available wifi access points * List available wifi access points
* *
* @param {function} callback Function which gets invoked after list is returned * @param {function} callback Function which gets invoked after list is returned
@ -45,7 +44,6 @@ class Wifi {
}) })
} }
/** /**
* Wifi._readConfigCb() -
* (internal function) Invoked after config file is read, * (internal function) Invoked after config file is read,
* then invokes file write on the config file * then invokes file write on the config file
* *
@ -66,7 +64,6 @@ class Wifi {
fs.writeFile(filePath, data, 'utf8', this._writeConfigCb) fs.writeFile(filePath, data, 'utf8', this._writeConfigCb)
} }
/** /**
* Wifi._writeConfigCb() -
* (internal function) Invoked after config file is written, * (internal function) Invoked after config file is written,
* then executes reconfiguration command * then executes reconfiguration command
* *
@ -80,7 +77,6 @@ class Wifi {
exec(reconfigure, this._reconfigureCb) exec(reconfigure, this._reconfigureCb)
} }
/** /**
* Wifi._reconfigureCb() -
* (internal function) Invoked after reconfiguration command is complete * (internal function) Invoked after reconfiguration command is complete
* *
* @param {object} err (optional) Error object only present if configuration command fails * @param {object} err (optional) Error object only present if configuration command fails
@ -96,7 +92,6 @@ class Wifi {
exec(refresh, this._refreshCb) exec(refresh, this._refreshCb)
} }
/** /**
* Wifi._refreshCb() -
* (internal function) Invoked after wifi refresh command is complete * (internal function) Invoked after wifi refresh command is complete
* *
* @param {object} err (optional) Error object only present if refresh command fails * @param {object} err (optional) Error object only present if refresh command fails
@ -113,7 +108,6 @@ class Wifi {
this._callback = () => {} this._callback = () => {}
} }
/** /**
* Wifi.setNetwork() -
* Function which initializes the processes for adding a wifi access point authentication * Function which initializes the processes for adding a wifi access point authentication
* *
* @param {string} ssid SSID of network to configure * @param {string} ssid SSID of network to configure
@ -127,7 +121,6 @@ class Wifi {
fs.readFile(filePath, 'utf8', this._readConfigCb) fs.readFile(filePath, 'utf8', this._readConfigCb)
} }
/** /**
* Wifi.getNetwork() -
* Executes command which gets the currently connected network * Executes command which gets the currently connected network
* *
* @param {function} callback Function which is invoked after command is completed * @param {function} callback Function which is invoked after command is completed