diff --git a/API.md b/API.md index 54e3709..3eaeeea 100644 --- a/API.md +++ b/API.md @@ -162,15 +162,14 @@ Schedules a given function which will not be called as long as it * **Number** *delay* - delay in milliseconds * **Function** *fn* - function to be called -## generateDeviceId([framework], prefix, framework, [lastId]) +## generateDeviceId(framework, prefix, [lastId]) Generates a new device id which is not yet in use by another device ### Params: -* *[framework]* - the pimatic framework object. +* **Object** *framework* - the pimatic framework object. * **String** *prefix* - a prefix string to be used as part of device id. -* **Integer** *framework* - the pimatic framework object. * **String** *[lastId]* - the lastId returned by generateDeviceId ### Return: diff --git a/lib/index.js b/lib/index.js index 4d589cb..78cc293 100644 --- a/lib/index.js +++ b/lib/index.js @@ -275,9 +275,8 @@ module.exports = function(env) { /* Generates a new device id which is not yet in use by another device - @param {*} [framework] - the pimatic framework object. + @param {Object} framework - the pimatic framework object. @param {String} prefix - a prefix string to be used as part of device id. - @param {Integer} framework - the pimatic framework object. @param {String} [lastId] - the lastId returned by generateDeviceId @returns {String} the id generated or undefined if id could not be generated */ diff --git a/src/index.coffee b/src/index.coffee index 733cdb5..16fcef1 100644 --- a/src/index.coffee +++ b/src/index.coffee @@ -215,9 +215,8 @@ module.exports = (env) -> ### Generates a new device id which is not yet in use by another device - @param {*} [framework] - the pimatic framework object. + @param {Object} framework - the pimatic framework object. @param {String} prefix - a prefix string to be used as part of device id. - @param {Integer} framework - the pimatic framework object. @param {String} [lastId] - the lastId returned by generateDeviceId @returns {String} the id generated or undefined if id could not be generated ###