diff options
author | portix <portix@gmx.net> | 2014-02-24 01:14:54 +0100 |
---|---|---|
committer | portix <portix@gmx.net> | 2014-02-24 01:14:54 +0100 |
commit | 97a2552ca3818dc84856048f6b9a5fea9b8bd158 (patch) | |
tree | a47ad79d99e9f8f81870db2fe29f92442de26359 | |
parent | b340d2b57d9534aa734d13368bffa0f16619455c (diff) | |
download | dwb-97a2552ca3818dc84856048f6b9a5fea9b8bd158.zip |
Changing api documentation
-rw-r--r-- | scripts/lib/dwb.js.in | 10 | ||||
-rw-r--r-- | src/scripts.c | 5 |
2 files changed, 9 insertions, 6 deletions
diff --git a/scripts/lib/dwb.js.in b/scripts/lib/dwb.js.in index d7b474c9..a506b38d 100644 --- a/scripts/lib/dwb.js.in +++ b/scripts/lib/dwb.js.in @@ -90,8 +90,9 @@ * The callback that will be called, if the callback returns <i>false</i> * the timer will be stopped * - * @returns {Number} - * A timer id that can be passed to {@link timer.stop|stop} + * @returns {Object} + * A handle, call handle.remove or timer.stop(handle) to stop the + * timer. * */ Object.defineProperties(timer, { @@ -129,8 +130,9 @@ * A command the can be used on dwb's commandline or an * {@link Enums and Flags.OverrideKey|OverrideKey} flag * - * @returns {Number} - * The shortcut id, can be used in {@link unbind} to identify the shortcut + * @returns {Object} + * An handle that contains an id, handle.remove() or + * unbind(handle.id) will unbind this shortcut * @example * bind("Control U", function () { * execute("tabopen " + tabs.current.uri); diff --git a/src/scripts.c b/src/scripts.c index 264cdde1..2287deee 100644 --- a/src/scripts.c +++ b/src/scripts.c @@ -2006,7 +2006,7 @@ scripts_eval_key(KeyMap *m, Arg *arg) * @function * * @param {Number|String|bindCallback} id|command|callback - * Either the id returned from bind or the function or the command passed to {@link bind} + * Either the handle id returned from bind or the function or the command passed to {@link bind} * * @returns {Boolean} * Whether the shortcut was found and unbound @@ -2694,7 +2694,8 @@ timeout_callback(JSObjectRef obj) * @memberOf timer * @function * - * @param {Number} id A timer id retrieved from {@link timer.start|start} + * @param {Number} id + * A timer handle retrieved from {@link timer.start|start} * * @returns {Boolean} * true if the timer was stopped |