gryf/pentadactyl-pm
1
0
Fork 0
mirror of https://github.com/gryf/pentadactyl-pm.git synced 2026-01-28 13:35:45 +01:00
Code Issues Projects Releases Wiki Activity

Use [foo] instead of foo[] consistently in source doc type annotations.

Browse Source
This commit is contained in:
Štěpán Němec
2011-07-22 12:33:36 +02:00
parent eca606fab2
commit cc03bfadf8
15 changed files with 51 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
common/modules/options.jsm
View File

@@ -25,7 +25,7 @@ let ValueError = Class("ValueError", ErrorBase);
* A class representing configuration options. Instances are created by the
* {@link Options} class.
*
* @param {string[]} names The names by which this option is identified.
* @param {[string]} names The names by which this option is identified.
* @param {string} description A short one line description of the option.
* @param {string} type The option's value data type (see {@link Option#type}).
* @param {string} defaultValue The default value for this option.
@@ -100,14 +100,14 @@ var Option = Class("Option", {
* "charlist" or "stringlist" or else unchanged.
*
* @param {value} value The option value.
* @returns {value|string[]}
* @returns {value|[string]}
*/
parse: function parse(value) Option.dequote(value),
/**
* Returns *values* packed in the appropriate format for the option type.
*
* @param {value|string[]} values The option value.
* @param {value|[string]} values The option value.
* @returns {value}
*/
stringify: function stringify(vals) Commands.quote(vals),
@@ -118,7 +118,7 @@ var Option = Class("Option", {
*
* @param {number} scope The scope to return these values from (see
* {@link Option#scope}).
* @returns {value|string[]}
* @returns {value|[string]}
*/
get: function get(scope) {
if (scope) {
@@ -229,7 +229,7 @@ var Option = Class("Option", {
* Sets the option's value using the specified set *operator*.
*
* @param {string} operator The set operator.
* @param {value|string[]} values The value (or values) to apply.
* @param {value|[string]} values The value (or values) to apply.
* @param {number} scope The scope to apply this value to (see
* {@link #scope}).
* @param {boolean} invert Whether this is an invert boolean operation.
@@ -258,7 +258,7 @@ var Option = Class("Option", {
/** @property {string} The option's canonical name. */
name: null,
/** @property {string[]} All names by which this option is identified. */
/** @property {[string]} All names by which this option is identified. */
names: null,
/**
@@ -675,7 +675,7 @@ var Option = Class("Option", {
* Validates the specified *values* against values generated by the
* option's completer function.
*
* @param {value|string[]} values The value or array of values to validate.
* @param {value|[string]} values The value or array of values to validate.
* @returns {boolean}
*/
validateCompleter: function validateCompleter(values) {
@@ -825,7 +825,7 @@ var Options = Module("options", {
/**
* Adds a new option.
*
* @param {string[]} names All names for the option.
* @param {[string]} names All names for the option.
* @param {string} description A description of the option.
* @param {string} type The option type (see {@link Option#type}).
* @param {value} defaultValue The option's default value.