diff options
Diffstat (limited to 'common')
-rw-r--r-- | common/content/commands.js | 2 | ||||
-rw-r--r-- | common/content/dactyl.js | 5 |
2 files changed, 3 insertions, 4 deletions
diff --git a/common/content/commands.js b/common/content/commands.js index 44164529..be60a5ef 100644 --- a/common/content/commands.js +++ b/common/content/commands.js @@ -24,7 +24,6 @@ * (@link CommandOption.FLOAT), * (@link CommandOption.LIST), * (@link CommandOption.ANY) - * @property {object} default The option's default value * @property {function} validator A validator function * @property {function (CompletionContext, object)} completer A list of * completions, or a completion function which will be passed a @@ -33,6 +32,7 @@ * completeOpt - The name of the option currently being completed. * @property {boolean} multiple Whether this option can be specified multiple times * @property {string} description A description of the option + * @property {object} default The option's default value */ var CommandOption = Struct("names", "type", "validator", "completer", "multiple", "description", "default"); diff --git a/common/content/dactyl.js b/common/content/dactyl.js index 6293114c..95b7c6f6 100644 --- a/common/content/dactyl.js +++ b/common/content/dactyl.js @@ -527,7 +527,7 @@ var Dactyl = Module("dactyl", XPCOM(Ci.nsISupportsWeakReference, ModuleBase), { /** * Returns the URL of the specified help *topic* if it exists. * - * @param {string} topic The help topic to lookup. + * @param {string} topic The help topic to look up. * @param {boolean} unchunked Whether to search the unchunked help page. * @returns {string} */ @@ -851,7 +851,7 @@ var Dactyl = Module("dactyl", XPCOM(Ci.nsISupportsWeakReference, ModuleBase), { }, [function (context, args) completion.file(context)]), /** - * Generates a help entry and writes it to the clipboard. + * Generates a help entry and returns it as a string. * * @param {Command|Map|Option} obj A dactyl *Command*, *Map* or *Option* * object @@ -953,7 +953,6 @@ var Dactyl = Module("dactyl", XPCOM(Ci.nsISupportsWeakReference, ModuleBase), { * * @param {string} topic The help topic to open. * @param {boolean} unchunked Whether to use the unchunked help page. - * @returns {string} */ help: function (topic, unchunked) { dactyl.initHelp(); |