gryf/pentadactyl-pm
1
0
Fork 0
mirror of https://github.com/gryf/pentadactyl-pm.git synced 2025-12-30 19:52:25 +01:00
Code Issues Projects Releases Wiki Activity

Replace use of <b>arg</b> in API docs with *arg*.

Browse Source 
--HG--
extra : rebase_source : f127ac4f494053e4306074f5acded34b2d363eef
This commit is contained in:
Doug Kearns
2010-10-21 22:55:15 +11:00
parent f3d194b00b
commit 377f8b01d4
22 changed files with 205 additions and 232 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
common/content/options.js
View File

@@ -83,7 +83,7 @@ const Option = Class("Option", {
set globalValue(val) { options.store.set(this.name, { value: val, time: Date.now() }); },
/**
* Returns <b>value</b> as an array of parsed values if the option type is
* Returns *value* as an array of parsed values if the option type is
* "charlist" or "stringlist" or else unchanged.
*
* @param {value} value The option value.
@@ -92,8 +92,7 @@ const Option = Class("Option", {
parse: function (value) Option.dequote(value),
/**
* Returns <b>values</b> packed in the appropriate format for the option
* type.
* Returns *values* packed in the appropriate format for the option type.
*
* @param {value|string[]} values The option value.
* @returns {value}
@@ -190,7 +189,7 @@ const Option = Class("Option", {
has: function () Array.some(arguments, function (val) this.value.indexOf(val) >= 0, this),
/**
* Returns whether this option is identified by <b>name</b>.
* Returns whether this option is identified by *name*.
*
* @param {string} name
* @returns {boolean}
@@ -198,7 +197,7 @@ const Option = Class("Option", {
hasName: function (name) this.names.indexOf(name) >= 0,
/**
* Returns whether the specified <b>values</b> are valid for this option.
* Returns whether the specified *values* are valid for this option.
* @see Option#validator
*/
isValidValue: function (values) this.validator(values),
@@ -214,7 +213,7 @@ const Option = Class("Option", {
},
/**
* Sets the option's value using the specified set <b>operator</b>.
* 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.
@@ -583,7 +582,7 @@ const Option = Class("Option", {
},
/**
* Validates the specified <b>values</b> against values generated by the
* 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.
@@ -679,7 +678,7 @@ const Options = Module("options", {
withContext: deprecated("Please use prefs.withContext", function withContext() prefs.withContext.apply(prefs, arguments)),
/**
* Returns the option with <b>name</b> in the specified <b>scope</b>.
* Returns the option with *name* in the specified *scope*.
*
* @param {string} name The option's name.
* @param {number} scope The option's scope (see {@link Option#scope}).
@@ -696,8 +695,8 @@ const Options = Module("options", {
},
/**
* Lists all options in <b>scope</b> or only those with changed values
* if <b>onlyNonDefault</b> is specified.
* Lists all options in *scope* or only those with changed values if
* *onlyNonDefault* is specified.
*
* @param {boolean} onlyNonDefault Limit the list to prefs with a
* non-default value.
@@ -793,7 +792,7 @@ const Options = Module("options", {
},
/**
* Remove the option with matching <b>name</b>.
* Remove the option with matching *name*.
*
* @param {string} name The name of the option to remove. This can be
* any of the option's names.