Skip to content

Commit

Permalink
Add more JsDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
Caprico85 committed Feb 20, 2024
1 parent ed681c8 commit 6f3c601
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 6 deletions.
15 changes: 11 additions & 4 deletions devices/device.js
Original file line number Diff line number Diff line change
Expand Up @@ -1872,6 +1872,11 @@ module.exports = function (RED) {
}
}

/**
* Updates the status icon of this device node.
*
* @param {boolean} is_local - Indicates whether the current command was issued using local fulfillment.
*/
updateStatusIcon(is_local) {
const me = this;
let text = '';
Expand Down Expand Up @@ -2845,10 +2850,12 @@ module.exports = function (RED) {
return traits;
}

//
//
//
//
/**
* Updates the states of this device with new values.
*
* @param {Object} from_states - The new states values.
* @returns {Array} - Array of the state keys that were modified.
*/
updateState(from_states) {
const me = this;
let modified = [];
Expand Down
2 changes: 1 addition & 1 deletion lib/Auth.js
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ class Auth {
/**
* Retrieves the duration (in minutes) for which an access token is valid.
*
* @return {number} The duration in minutes.
* @returns {number} The duration in minutes.
*/
getAccessTokenDuration() {
return this._accessTokenDuration;
Expand Down
2 changes: 1 addition & 1 deletion lib/SmartHome.js
Original file line number Diff line number Diff line change
Expand Up @@ -604,7 +604,7 @@ class GoogleSmartHome {
* read the local app.js file, parse the version number out of the file and compare the version numbers with each
* other. If the version numbers do not match, the user gets a message on Node-RED's debug panel.
*
* @param {string} remoteAppJsVersion
* @param {string} remoteAppJsVersion - version number of the script running on the speaker
*/
checkAppJsVersion(remoteAppJsVersion) {
const appJsPath = path.resolve(__dirname, '../local-execution/app.js');
Expand Down

0 comments on commit 6f3c601

Please sign in to comment.