Fixed API doc

mwittig · Jun 18, 2016 · b9c10ae · b9c10ae
1 parent dd0e146
commit b9c10ae
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 7 deletions.
diff --git 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
@@ -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
@@ -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
         ###