diff --git a/common/content/abbreviations.js b/common/content/abbreviations.js
index e3b896e8..d04d101b 100644
--- a/common/content/abbreviations.js
+++ b/common/content/abbreviations.js
@@ -158,7 +158,7 @@ const Abbreviations = Module("abbreviations", {
},
/**
- * Lists all abbreviations matching modes and lhs.
+ * Lists all abbreviations matching *modes* and *lhs*.
*
* @param {Array} list of mode.
* @param {string} lhs The LHS of the abbreviation.
@@ -199,7 +199,7 @@ const Abbreviations = Module("abbreviations", {
},
/**
- * Removes all abbreviations specified modes.
+ * Removes all abbreviations specified *modes*.
*
* @param {Array} list of mode.
*/
diff --git a/common/content/autocommands.js b/common/content/autocommands.js
index 8362ded3..a8e97bcd 100644
--- a/common/content/autocommands.js
+++ b/common/content/autocommands.js
@@ -21,9 +21,8 @@ const AutoCommands = Module("autocommands", {
__iterator__: function () array.iterValues(this._store),
/**
- * Adds a new autocommand. cmd will be executed when one of the
- * specified events occurs and the URL of the applicable buffer
- * matches regex.
+ * Adds a new autocommand. *cmd* will be executed when one of the specified
+ * *events* occurs and the URL of the applicable buffer matches *regex*.
*
* @param {Array} events The array of event names for which this
* autocommand should be executed.
@@ -37,8 +36,7 @@ const AutoCommands = Module("autocommands", {
},
/**
- * Returns all autocommands with a matching event and
- * regex.
+ * Returns all autocommands with a matching *event* and *regex*.
*
* @param {string} event The event name filter.
* @param {string} regex The URL pattern filter.
@@ -49,8 +47,7 @@ const AutoCommands = Module("autocommands", {
},
/**
- * Deletes all autocommands with a matching event and
- * regex.
+ * Deletes all autocommands with a matching *event* and *regex*.
*
* @param {string} event The event name filter.
* @param {string} regex The URL pattern filter.
@@ -60,8 +57,7 @@ const AutoCommands = Module("autocommands", {
},
/**
- * Lists all autocommands with a matching event and
- * regex.
+ * Lists all autocommands with a matching *event* and *regex*.
*
* @param {string} event The event name filter.
* @param {string} regex The URL pattern filter.
@@ -98,9 +94,8 @@ const AutoCommands = Module("autocommands", {
},
/**
- * Triggers the execution of all autocommands registered for
- * event. A map of args is passed to each autocommand
- * when it is being executed.
+ * Triggers the execution of all autocommands registered for *event*. A map
+ * of *args* is passed to each autocommand when it is being executed.
*
* @param {string} event The event to fire.
* @param {Object} args The args to pass to each autocommand.
diff --git a/common/content/buffer.js b/common/content/buffer.js
index 094476de..c93562b9 100644
--- a/common/content/buffer.js
+++ b/common/content/buffer.js
@@ -656,7 +656,7 @@ const Buffer = Module("buffer", {
.QueryInterface(Ci.nsISelectionController),
/**
- * Opens the appropriate context menu for elem.
+ * Opens the appropriate context menu for *elem*.
*
* @param {Node} elem The context element.
*/
@@ -697,7 +697,7 @@ const Buffer = Module("buffer", {
},
/**
- * Scrolls the buffer laterally cols columns.
+ * Scrolls the buffer laterally *cols* columns.
*
* @param {number} cols The number of columns to scroll. A positive
* value scrolls right and a negative value left.
@@ -714,7 +714,7 @@ const Buffer = Module("buffer", {
},
/**
- * Scrolls the buffer vertically lines rows.
+ * Scrolls the buffer vertically *lines* rows.
*
* @param {number} lines The number of lines to scroll. A positive
* value scrolls down and a negative value up.
@@ -724,7 +724,7 @@ const Buffer = Module("buffer", {
},
/**
- * Scrolls the buffer vertically pages pages.
+ * Scrolls the buffer vertically *pages* pages.
*
* @param {number} pages The number of pages to scroll. A positive
* value scrolls down and a negative value up.
@@ -934,8 +934,8 @@ const Buffer = Module("buffer", {
/**
* Opens a viewer to inspect the source of the current buffer or the
- * specified url. Either the default viewer or the configured
- * external editor is used.
+ * specified *url*. Either the default viewer or the configured external
+ * editor is used.
*
* @param {string} url The URL of the source.
* @default The current buffer.
diff --git a/common/content/commandline.js b/common/content/commandline.js
index 5c2058f6..8aad710a 100644
--- a/common/content/commandline.js
+++ b/common/content/commandline.js
@@ -436,10 +436,10 @@ const CommandLine = Module("commandline", {
}),
/**
- * Open the command line. The main mode is set to
- * COMMAND_LINE, the extended mode to extendedMode.
- * Further, callbacks defined for extendedMode are
- * triggered as appropriate (see {@link #registerCallback}).
+ * Open the command line. The main mode is set to COMMAND_LINE, the
+ * extended mode to *extendedMode*. Further, callbacks defined for
+ * *extendedMode* are triggered as appropriate
+ * (see {@link #registerCallback}).
*
* @param {string} prompt
* @param {string} cmd
diff --git a/common/content/commands.js b/common/content/commands.js
index f21cb53e..54c66da8 100644
--- a/common/content/commands.js
+++ b/common/content/commands.js
@@ -159,7 +159,7 @@ const Command = Class("Command", {
},
/**
- * Returns whether this command may be invoked via name.
+ * Returns whether this command may be invoked via *name*.
*
* @param {string} name The candidate name.
* @returns {boolean}
@@ -292,10 +292,9 @@ const Command = Class("Command", {
*/
privateData: true,
/**
- * @property {function} Should return an array of Objects suitable
- * to be passed to {@link Commands#commandToString}, one for each past
- * invocation which should be restored on subsequent @dactyl
- * startups.
+ * @property {function} Should return an array of *Object*s suitable to be
+ * passed to {@link Commands#commandToString}, one for each past
+ * invocation which should be restored on subsequent @dactyl startups.
*/
serialize: null,
/**
@@ -305,7 +304,7 @@ const Command = Class("Command", {
*/
subCommand: null,
/**
- * @property {boolean} Specifies whether this is a user command. User
+ * @property {boolean} Specifies whether this is a user command. User
* commands may be created by plugins, or directly by users, and,
* unlike basic commands, may be overwritten. Users and plugin authors
* should create only user commands.
@@ -587,7 +586,7 @@ const Commands = Module("commands", {
},
/**
- * Returns the command with matching name.
+ * Returns the command with matching *name*.
*
* @param {string} name The name of the command to return. This can be
* any of the command's names.
@@ -598,7 +597,7 @@ const Commands = Module("commands", {
},
/**
- * Returns the user-defined command with matching name.
+ * Returns the user-defined command with matching *name*.
*
* @param {string} name The name of the command to return. This can be
* any of the command's names.
@@ -619,7 +618,7 @@ const Commands = Module("commands", {
/**
* Returns true if a command invocation contains a URL referring to the
- * domain 'host'.
+ * domain *host*.
*
* @param {string} command
* @param {string} host
@@ -663,13 +662,13 @@ const Commands = Module("commands", {
// especially since it is further augmented for use in
// Command#action etc.
/**
- * Parses str for options and plain arguments.
+ * Parses *str* for options and plain arguments.
*
- * The returned Args object is an augmented array of arguments.
- * Any key/value pairs of extra will be available and the
+ * The returned *Args* object is an augmented array of arguments.
+ * Any key/value pairs of *extra* will be available and the
* following additional properties:
* -opt - the value of the option -opt if specified
- * string - the original argument string str
+ * string - the original argument string *str*
* literalArg - any trailing literal argument
*
* Quoting rules:
@@ -1035,7 +1034,7 @@ const Commands = Module("commands", {
get quoteArg() Commands.quoteArg, // XXX: better somewhere else?
/**
- * Remove the user-defined command with matching name.
+ * Remove the user-defined command with matching *name*.
*
* @param {string} name The name of the command to remove. This can be
* any of the command's names.
@@ -1050,12 +1049,11 @@ const Commands = Module("commands", {
// FIXME: still belong here? Also used for autocommand parameters.
/**
- * Returns a string with all tokens in string matching ""
- * replaced with "value". Where "key" is a property of the specified
- * tokens object and "value" is the corresponding value. The
- * token can be used to include a literal "<" in the returned
- * string. Any tokens prefixed with "q-" will be quoted except for
- * which is treated like .
+ * Returns a string with all tokens in *string* matching "" replaced
+ * with "value". Where "key" is a property of the specified *tokens* object
+ * and "value" is the corresponding value. The token can be used to
+ * include a literal "<" in the returned string. Any tokens prefixed with
+ * "q-" will be quoted except for which is treated like .
*
* @param {string} str The string with tokens to replace.
* @param {Object} tokens A map object whose keys are replaced with its
diff --git a/common/content/completion.js b/common/content/completion.js
index 4ffc42a4..06c28e1d 100644
--- a/common/content/completion.js
+++ b/common/content/completion.js
@@ -524,15 +524,15 @@ const CompletionContext = Class("CompletionContext", {
},
/**
- * Advances the context count characters. {@link #filter} is
- * advanced to match. If {@link #quote} is non-null, its prefix and suffix
- * are set to the null-string.
+ * Advances the context *count* characters. {@link #filter} is advanced to
+ * match. If {@link #quote} is non-null, its prefix and suffix are set to
+ * the null-string.
*
* This function is still imperfect for quoted strings. When
* {@link #quote} is non-null, it adjusts the count based on the quoted
- * size of the count-character substring of the filter, which is
- * accurate so long as unquoting and quoting a string will always map to
- * the original quoted string, which is often not the case.
+ * size of the *count*-character substring of the filter, which is accurate
+ * so long as unquoting and quoting a string will always map to the
+ * original quoted string, which is often not the case.
*
* @param {number} count The number of characters to advance the context.
*/
@@ -556,8 +556,8 @@ const CompletionContext = Class("CompletionContext", {
},
/**
- * Gets a key from {@link #cache}, setting it to defVal if it
- * doesn't already exists.
+ * Gets a key from {@link #cache}, setting it to *defVal* if it doesn't
+ * already exists.
*
* @param {string} key
* @param defVal
diff --git a/common/content/dactyl.js b/common/content/dactyl.js
index e5109ce3..80f978ec 100644
--- a/common/content/dactyl.js
+++ b/common/content/dactyl.js
@@ -193,8 +193,8 @@ const Dactyl = Module("dactyl", {
},
/**
- * Copies a string to the system clipboard. If verbose is specified
- * the copied string is also echoed to the command line.
+ * Copies a string to the system clipboard. If *verbose* is specified the
+ * copied string is also echoed to the command line.
*
* @param {string} str
* @param {boolean} verbose
@@ -261,7 +261,7 @@ const Dactyl = Module("dactyl", {
* @param {string} str The message to output.
* @param {number} verbosity The messages log level (0 - 15). Only
* messages with verbosity less than or equal to the value of the
- * 'verbosity' option will be output.
+ * *verbosity* option will be output.
* @param {number} flags These control the multiline message behaviour.
* See {@link CommandLine#echo}.
*/
@@ -276,8 +276,8 @@ const Dactyl = Module("dactyl", {
},
/**
- * Loads and executes the script referenced by uri in the scope
- * of the context object.
+ * Loads and executes the script referenced by *uri* in the scope of the
+ * *context* object.
*
* @param {string} uri The URI of the script to load. Should be a local
* chrome:, file:, or resource: URL.
@@ -372,7 +372,7 @@ const Dactyl = Module("dactyl", {
},
/**
- * Returns whether this Dactyl extension supports feature.
+ * Returns whether this Dactyl extension supports *feature*.
*
* @param {string} feature The feature name.
* @returns {boolean}
@@ -380,7 +380,7 @@ const Dactyl = Module("dactyl", {
has: function (feature) config.features.indexOf(feature) >= 0,
/**
- * Returns the URL of the specified help topic if it exists.
+ * Returns the URL of the specified help *topic* if it exists.
*
* @param {string} topic The help topic to lookup.
* @param {boolean} unchunked Whether to search the unchunked help page.
@@ -597,8 +597,8 @@ const Dactyl = Module("dactyl", {
/**
* Generates a help entry and writes it to the clipboard.
*
- * @param {Command|Map|Option} obj A dactyl Command,
- * Map or Option object
+ * @param {Command|Map|Option} obj A dactyl *Command*, *Map* or *Option*
+ * object
* @param {XMLList} extraHelp Extra help text beyond the description.
* @returns {string}
*/
@@ -658,8 +658,7 @@ const Dactyl = Module("dactyl", {
},
/**
- * Opens the help page containing the specified topic if it
- * exists.
+ * Opens the help page containing the specified *topic* if it exists.
*
* @param {string} topic The help topic to open.
* @param {boolean} unchunked Whether to use the unchunked help page.
@@ -735,9 +734,8 @@ const Dactyl = Module("dactyl", {
// TODO: add proper level constants
/**
* Logs a message to the JavaScript error console. Each message has an
- * associated log level. Only messages with a log level less than or
- * equal to level will be printed. If msg is an object,
- * it is pretty printed.
+ * associated log level. Only messages with a log level less than or equal
+ * to *level* will be printed. If *msg* is an object, it is pretty printed.
*
* @param {string|Object} msg The message to print.
* @param {number} level The logging level 0 - 15.
@@ -896,7 +894,7 @@ const Dactyl = Module("dactyl", {
},
/**
- * Returns an array of URLs parsed from str.
+ * Returns an array of URLs parsed from *str*.
*
* Given a string like 'google bla, www.osnews.com' return an array
* ['www.google.com/search?q=bla', 'www.osnews.com']
diff --git a/common/content/events.js b/common/content/events.js
index a03180be..54f7c4ae 100644
--- a/common/content/events.js
+++ b/common/content/events.js
@@ -198,7 +198,7 @@ const Events = Module("events", {
},
/**
- * Returns all macros matching filter.
+ * Returns all macros matching *filter*.
*
* @param {string} filter A regular expression filter string. A null
* filter selects all macros.
@@ -209,7 +209,7 @@ const Events = Module("events", {
},
/**
- * Deletes all macros matching filter.
+ * Deletes all macros matching *filter*.
*
* @param {string} filter A regular expression filter string. A null
* filter deletes all macros.
@@ -549,8 +549,8 @@ const Events = Module("events", {
},
/**
- * Whether key is a key code defined to accept/execute input on
- * the command line.
+ * Whether *key* is a key code defined to accept/execute input on the
+ * command line.
*
* @param {string} key The key code to test.
* @returns {boolean}
@@ -558,8 +558,8 @@ const Events = Module("events", {
isAcceptKey: function (key) key == "" || key == "" || key == "",
/**
- * Whether key is a key code defined to reject/cancel input on
- * the command line.
+ * Whether *key* is a key code defined to reject/cancel input on the
+ * command line.
*
* @param {string} key The key code to test.
* @returns {boolean}
diff --git a/common/content/io.js b/common/content/io.js
index 4a14cd2b..e3a87c4b 100644
--- a/common/content/io.js
+++ b/common/content/io.js
@@ -135,7 +135,7 @@ const IO = Module("io", {
sourcing: null,
/**
- * Expands "~" and environment variables in path.
+ * Expands "~" and environment variables in *path*.
*
* "~" is expanded to to the value of $HOME. On Windows if this is not
* set then the following are tried in order:
@@ -152,7 +152,7 @@ const IO = Module("io", {
expandPath: File.expandPath,
/**
- * Returns all directories named name in 'runtimepath'.
+ * Returns all directories named *name* in 'runtimepath'.
*
* @param {string} name
* @returns {nsIFile[])
@@ -166,7 +166,7 @@ const IO = Module("io", {
},
/**
- * Returns the first user RC file found in dir.
+ * Returns the first user RC file found in *dir*.
*
* @param {string} dir The directory to search.
* @param {boolean} always When true, return a path whether
@@ -217,7 +217,7 @@ const IO = Module("io", {
* Runs an external program.
*
* @param {string} program The program to run.
- * @param {string[]} args An array of arguments to pass to program.
+ * @param {string[]} args An array of arguments to pass to *program*.
* @param {boolean} blocking Whether to wait until the process terminates.
*/
blockingProcesses: [],
@@ -272,11 +272,10 @@ lookup:
// FIXME: multiple paths?
/**
- * Sources files found in 'runtimepath'. For each relative path in
- * paths each directory in 'runtimepath' is searched and if a
- * matching file is found it is sourced. Only the first file found (per
- * specified path) is sourced unless all is specified, then
- * all found files are sourced.
+ * Sources files found in 'runtimepath'. For each relative path in *paths*
+ * each directory in 'runtimepath' is searched and if a matching file is
+ * found it is sourced. Only the first file found (per specified path) is
+ * sourced unless *all* is specified, then all found files are sourced.
*
* @param {string[]} paths An array of relative paths to source.
* @param {boolean} all Whether all found files should be sourced.
@@ -311,7 +310,7 @@ lookup:
},
/**
- * Reads Ex commands, JavaScript or CSS from filename.
+ * Reads Ex commands, JavaScript or CSS from *filename*.
*
* @param {string} filename The name of the file to source.
* @param {boolean} silent Whether errors should be reported.
@@ -379,8 +378,8 @@ lookup:
// TODO: when https://bugzilla.mozilla.org/show_bug.cgi?id=68702 is
// fixed use that instead of a tmpfile
/**
- * Runs command in a subshell and returns the output in a
- * string. The shell used is that specified by the 'shell' option.
+ * Runs *command* in a subshell and returns the output in a string. The
+ * shell used is that specified by the 'shell' option.
*
* @param {string} command The command to run.
* @param {string} input Any input to be provided to the command on stdin.
@@ -422,14 +421,14 @@ lookup:
/**
* Creates a temporary file context for executing external commands.
- * func is called with a temp file, created with
- * {@link #createTempFile}, for each explicit argument. Ensures that
- * all files are removed when func returns.
+ * *func* is called with a temp file, created with {@link #createTempFile},
+ * for each explicit argument. Ensures that all files are removed when
+ * *func* returns.
*
* @param {function} func The function to execute.
* @param {Object} self The 'this' object used when executing func.
* @returns {boolean} false if temp files couldn't be created,
- * otherwise, the return value of func.
+ * otherwise, the return value of *func*.
*/
withTempFiles: function (func, self) {
let args = util.map(util.range(0, func.length), this.createTempFile);
diff --git a/common/content/mappings.js b/common/content/mappings.js
index 613e7990..3b8de180 100644
--- a/common/content/mappings.js
+++ b/common/content/mappings.js
@@ -14,7 +14,7 @@
*
* @param {number[]} modes The modes in which this mapping is active.
* @param {string[]} keys The key sequences which are bound to
- * action.
+ * *action*.
* @param {string} description A short one line description of the key mapping.
* @param {function} action The action invoked by each key sequence.
* @param {Object} extraInfo An optional extra configuration hash. The
@@ -83,7 +83,7 @@ const Map = Class("Map", {
/**
* Returns whether this mapping can be invoked by a key sequence matching
- * name.
+ * *name*.
*
* @param {string} name The name to query.
* @returns {boolean}
@@ -190,8 +190,7 @@ const Mappings = Module("mappings", {
// used by :mkpentadactylrc to save mappings
/**
- * Returns a user-defined mappings iterator for the specified
- * mode.
+ * Returns a user-defined mappings iterator for the specified *mode*.
*
* @param {number} mode The mode to return mappings from.
* @returns {Iterator(Map)}
@@ -202,8 +201,7 @@ const Mappings = Module("mappings", {
* Adds a new default key mapping.
*
* @param {number[]} modes The modes that this mapping applies to.
- * @param {string[]} keys The key sequences which are bound to
- * action.
+ * @param {string[]} keys The key sequences which are bound to *action*.
* @param {string} description A description of the key mapping.
* @param {function} action The action invoked by each key sequence.
* @param {Object} extra An optional extra configuration hash.
@@ -217,8 +215,7 @@ const Mappings = Module("mappings", {
* Adds a new user-defined key mapping.
*
* @param {number[]} modes The modes that this mapping applies to.
- * @param {string[]} keys The key sequences which are bound to
- * action.
+ * @param {string[]} keys The key sequences which are bound to *action*.
* @param {string} description A description of the key mapping.
* @param {function} action The action invoked by each key sequence.
* @param {Object} extra An optional extra configuration hash (see
@@ -241,7 +238,7 @@ const Mappings = Module("mappings", {
},
/**
- * Returns the map from mode named cmd.
+ * Returns the map from *mode* named *cmd*.
*
* @param {number} mode The mode to search.
* @param {string} cmd The map name to match.
@@ -253,7 +250,7 @@ const Mappings = Module("mappings", {
},
/**
- * Returns the default map from mode named cmd.
+ * Returns the default map from *mode* named *cmd*.
*
* @param {number} mode The mode to search.
* @param {string} cmd The map name to match.
@@ -266,7 +263,7 @@ const Mappings = Module("mappings", {
/**
* Returns an array of maps with names starting with but not equal to
- * prefix.
+ * *prefix*.
*
* @param {number} mode The mode to search.
* @param {string} prefix The map prefix string to match.
@@ -290,8 +287,8 @@ const Mappings = Module("mappings", {
},
/**
- * Returns whether there is a user-defined mapping cmd for the
- * specified mode.
+ * Returns whether there is a user-defined mapping *cmd* for the specified
+ * *mode*.
*
* @param {number} mode The mode to search.
* @param {string} cmd The candidate key mapping.
@@ -300,7 +297,7 @@ const Mappings = Module("mappings", {
hasMap: function (mode, cmd) this._user[mode].some(function (map) map.hasName(cmd)),
/**
- * Remove the user-defined mapping named cmd for mode.
+ * Remove the user-defined mapping named *cmd* for *mode*.
*
* @param {number} mode The mode to search.
* @param {string} cmd The map name to match.
@@ -310,7 +307,7 @@ const Mappings = Module("mappings", {
},
/**
- * Remove all user-defined mappings for mode.
+ * Remove all user-defined mappings for *mode*.
*
* @param {number} mode The mode to remove all mappings from.
*/
@@ -319,8 +316,8 @@ const Mappings = Module("mappings", {
},
/**
- * Lists all user-defined mappings matching filter for the
- * specified modes.
+ * Lists all user-defined mappings matching *filter* for the specified
+ * *modes*.
*
* @param {number[]} modes An array of modes to search.
* @param {string} filter The filter string to match.
diff --git a/common/content/marks.js b/common/content/marks.js
index be179543..304c1b70 100644
--- a/common/content/marks.js
+++ b/common/content/marks.js
@@ -71,8 +71,8 @@ const Marks = Module("marks", {
},
/**
- * Remove all marks matching filter. If special is
- * given, removes all local marks.
+ * Remove all marks matching *filter*. If *special* is given, removes all
+ * local marks.
*
* @param {string} filter A string containing one character for each
* mark to be removed.
@@ -144,7 +144,7 @@ const Marks = Module("marks", {
},
/**
- * List all marks matching filter.
+ * List all marks matching *filter*.
*
* @param {string} filter
*/
diff --git a/common/content/options.js b/common/content/options.js
index a15c502e..0bf7b987 100644
--- a/common/content/options.js
+++ b/common/content/options.js
@@ -83,7 +83,7 @@ const Option = Class("Option", {
set globalValue(val) { options.store.set(this.name, { value: val, time: Date.now() }); },
/**
- * Returns value 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 values 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 name.
+ * 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 values 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 operator.
+ * 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 values 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 name in the specified scope.
+ * 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 scope or only those with changed values
- * if onlyNonDefault 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 name.
+ * 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.
diff --git a/common/content/quickmarks.js b/common/content/quickmarks.js
index 32c8b643..d003a6d9 100644
--- a/common/content/quickmarks.js
+++ b/common/content/quickmarks.js
@@ -20,9 +20,8 @@ const QuickMarks = Module("quickmarks", {
},
/**
- * Adds a new quickmark with name qmark referencing
- * the URL location. Any existing quickmark with the same name
- * will be replaced.
+ * Adds a new quickmark with name *qmark* referencing the URL *location*.
+ * Any existing quickmark with the same name will be replaced.
*
* @param {string} qmark The name of the quickmark {A-Z}.
* @param {string} location The URL accessed by this quickmark.
@@ -55,8 +54,8 @@ const QuickMarks = Module("quickmarks", {
get: function (mark) this._qmarks.get(mark) || null,
/**
- * Deletes the specified quickmarks. The filter is a list of
- * quickmarks and ranges are supported. Eg. "ab c d e-k".
+ * Deletes the specified quickmarks. The *filter* is a list of quickmarks
+ * and ranges are supported. Eg. "ab c d e-k".
*
* @param {string} filter The list of quickmarks to delete.
*
@@ -78,7 +77,7 @@ const QuickMarks = Module("quickmarks", {
},
/**
- * Opens the URL referenced by the specified qmark.
+ * Opens the URL referenced by the specified *qmark*.
*
* @param {string} qmark The quickmark to open.
* @param {object} where A set of parameters specifying how to open the
@@ -94,7 +93,7 @@ const QuickMarks = Module("quickmarks", {
},
/**
- * Lists all quickmarks matching filter in the message window.
+ * Lists all quickmarks matching *filter* in the message window.
*
* @param {string} filter The list of quickmarks to display. Eg. "abc"
* Ranges are not supported.
diff --git a/common/content/tabs.js b/common/content/tabs.js
index 08833317..f46b0268 100644
--- a/common/content/tabs.js
+++ b/common/content/tabs.js
@@ -92,9 +92,8 @@ const Tabs = Module("tabs", {
get visibleTabs() config.tabbrowser.visibleTabs || this.allTabs.filter(function (tab) !tab.hidden),
/**
- * Returns the local state store for the tab at the specified
- * tabIndex. If tabIndex is not specified then the
- * current tab is used.
+ * Returns the local state store for the tab at the specified *tabIndex*.
+ * If *tabIndex* is not specified then the current tab is used.
*
* @param {number} tabIndex
* @returns {Object}
@@ -124,7 +123,7 @@ const Tabs = Module("tabs", {
get closedTabs() services.get("json").decode(services.get("sessionStore").getClosedTabData(window)),
/**
- * Clones the specified tab and append it to the tab list.
+ * Clones the specified *tab* and append it to the tab list.
*
* @param {Object} tab The tab to clone.
* @param {boolean} activate Whether to select the newly cloned tab.
@@ -140,8 +139,8 @@ const Tabs = Module("tabs", {
},
/**
- * Detaches the specified tab and open it in a new window. If no
- * tab is specified the currently selected tab is detached.
+ * Detaches the specified *tab* and open it in a new window. If no tab is
+ * specified the currently selected tab is detached.
*
* @param {Object} tab The tab to detach.
*/
@@ -154,7 +153,7 @@ const Tabs = Module("tabs", {
},
/**
- * Returns the index of the tab containing content.
+ * Returns the index of the tab containing *content*.
*
* @param {Object} content Either a content window or a content
* document.
@@ -188,9 +187,8 @@ const Tabs = Module("tabs", {
},
/**
- * Returns the tab at the specified index or the currently
- * selected tab if index is not specified. This is a 0-based
- * index.
+ * Returns the tab at the specified *index* or the currently selected tab
+ * if *index* is not specified. This is a 0-based index.
*
* @param {number|Node} index The index of the tab required or the tab itself
* @returns {Object}
@@ -204,9 +202,8 @@ const Tabs = Module("tabs", {
},
/**
- * Returns the index of tab or the index of the currently
- * selected tab if tab is not specified. This is a 0-based
- * index.
+ * Returns the index of *tab* or the index of the currently selected tab if
+ * *tab* is not specified. This is a 0-based index.
*
* @param {} tab A tab from the current tab list.
* @param {boolean} visible Whether to consider only visible tabs.
@@ -255,7 +252,7 @@ const Tabs = Module("tabs", {
},
/**
- * Removes all tabs from the tab list except the specified tab.
+ * Removes all tabs from the tab list except the specified *tab*.
*
* @param {Object} tab The tab to keep.
*/
@@ -264,7 +261,7 @@ const Tabs = Module("tabs", {
},
/**
- * Lists all tabs matching filter.
+ * Lists all tabs matching *filter*.
*
* @param {string} filter A filter matching a substring of the tab's
* document title or URL.
@@ -278,9 +275,8 @@ const Tabs = Module("tabs", {
*
* @param {Object} tab The tab to move.
* @param {string} spec See {@link Tabs.indexFromSpec}.
- * @param {boolean} wrap Whether an out of bounds spec causes
- * the destination position to wrap around the start/end of the tab
- * list.
+ * @param {boolean} wrap Whether an out of bounds *spec* causes the
+ * destination position to wrap around the start/end of the tab list.
*/
move: function (tab, spec, wrap) {
let index = tabs.indexFromSpec(spec, wrap);
@@ -288,7 +284,7 @@ const Tabs = Module("tabs", {
},
/**
- * Removes the specified tab from the tab list.
+ * Removes the specified *tab* from the tab list.
*
* @param {Object} tab The tab to remove.
* @param {number} count How many tabs to remove.
@@ -357,12 +353,11 @@ const Tabs = Module("tabs", {
},
/**
- * Selects the tab at the position specified by spec.
+ * Selects the tab at the position specified by *spec*.
*
* @param {string} spec See {@link Tabs.indexFromSpec}
- * @param {boolean} wrap Whether an out of bounds spec causes
- * the selection position to wrap around the start/end of the tab
- * list.
+ * @param {boolean} wrap Whether an out of bounds *spec* causes the
+ * selection position to wrap around the start/end of the tab list.
*/
select: function (spec, wrap) {
let index = tabs.indexFromSpec(spec, wrap);
@@ -402,7 +397,7 @@ const Tabs = Module("tabs", {
},
/**
- * Selects the tab containing the specified buffer.
+ * Selects the tab containing the specified *buffer*.
*
* @param {string} buffer A string which matches the URL or title of a
* buffer, if it is null, the last used string is used again.
diff --git a/common/modules/base.jsm b/common/modules/base.jsm
index 83e31d8b..ba76fa04 100644
--- a/common/modules/base.jsm
+++ b/common/modules/base.jsm
@@ -266,7 +266,7 @@ function values(obj) {
*
* @param {object} iter The iterator.
* @param {function} fn The callback.
- * @param {object} self The this object for 'fn'.
+ * @param {object} self The this object for *fn*.
*/
function forEach(iter, fn, self) {
for (let val in iter)
@@ -733,7 +733,7 @@ Class.Property.prototype.init = function () {};
* Extends a subclass with a superclass. The subclass's
* prototype is replaced with a new object, which inherits
* from the superclass's prototype, {@see update}d with the
- * members of 'overrides'.
+ * members of *overrides*.
*
* @param {function} subclass
* @param {function} superclass
@@ -795,12 +795,12 @@ Class.prototype = {
toString: function () "[instance " + this.constructor.className + "]",
/**
- * Executes 'callback' after 'timeout' milliseconds. The value of
- * 'this' is preserved in the invocation of 'callback'.
+ * Executes *callback* after *timeout* milliseconds. The value of
+ * 'this' is preserved in the invocation of *callback*.
*
- * @param {function} callback The function to call after 'timeout'
+ * @param {function} callback The function to call after *timeout*
* @param {number} timeout The time, in milliseconds, to wait
- * before calling 'callback'.
+ * before calling *callback*.
* @returns {nsITimer} The timer which backs this timeout.
*/
timeout: function (callback, timeout) {
@@ -1114,9 +1114,8 @@ const array = Class("array", Array, {
},
/**
- * Filters out all duplicates from an array. If
- * unsorted is false, the array is sorted before
- * duplicates are removed.
+ * Filters out all duplicates from an array. If *unsorted* is false, the
+ * array is sorted before duplicates are removed.
*
* @param {Array} ary
* @param {boolean} unsorted
diff --git a/common/modules/highlight.jsm b/common/modules/highlight.jsm
index 6126129b..550dce50 100644
--- a/common/modules/highlight.jsm
+++ b/common/modules/highlight.jsm
@@ -210,7 +210,7 @@ const Highlights = Module("Highlight", {
*
* If Star is provided, the style is applied as an agent sheet.
*
- * The new styles are lazily activated unless Bang or 'eager' is
+ * The new styles are lazily activated unless Bang or *eager* is
* provided. See {@link Util#xmlToDom}.
*
* @param {string} css The rules to load. See {@link Highlights#css}.
diff --git a/common/modules/storage.jsm b/common/modules/storage.jsm
index 213e7788..3e1dd1d6 100644
--- a/common/modules/storage.jsm
+++ b/common/modules/storage.jsm
@@ -356,7 +356,7 @@ const File = Class("File", {
},
/**
- * Writes the string buf to this file.
+ * Writes the string *buf* to this file.
*
* @param {string} buf The file content.
* @param {string|number} mode The file access mode, a bitwise OR of
diff --git a/common/modules/styles.jsm b/common/modules/styles.jsm
index 3c4db697..d079fef0 100644
--- a/common/modules/styles.jsm
+++ b/common/modules/styles.jsm
@@ -164,9 +164,8 @@ const Styles = Module("Styles", {
/**
* Remove a style sheet. See {@link #addSheet} for parameters.
- * In cases where filter is supplied, the given filters
- * are removed from matching sheets. If any remain, the sheet is
- * left in place.
+ * In cases where *filter* is supplied, the given filters are removed from
+ * matching sheets. If any remain, the sheet is left in place.
*
* @param {boolean} system
* @param {string} name
diff --git a/common/modules/util.jsm b/common/modules/util.jsm
index 5c2c3747..8d144a2f 100644
--- a/common/modules/util.jsm
+++ b/common/modules/util.jsm
@@ -146,7 +146,7 @@ const Util = Module("Util", XPCOM([Ci.nsIObserver, Ci.nsISupportsWeakReference])
},
/**
- * Returns a shallow copy of obj.
+ * Returns a shallow copy of *obj*.
*
* @param {Object} obj
* @returns {Object}
@@ -162,7 +162,7 @@ const Util = Module("Util", XPCOM([Ci.nsIObserver, Ci.nsISupportsWeakReference])
/**
* Clips a string to a given length. If the input string is longer
- * than length, an ellipsis is appended.
+ * than *length*, an ellipsis is appended.
*
* @param {string} str The string to truncate.
* @param {number} length The length of the returned string.
@@ -289,8 +289,8 @@ const Util = Module("Util", XPCOM([Ci.nsIObserver, Ci.nsISupportsWeakReference])
},
/**
- * Prints a message to the console. If msg is an object it is
- * pretty printed.
+ * Prints a message to the console. If *msg* is an object it is pretty
+ * printed.
*
* @param {string|Object} msg The message to print.
*/
@@ -314,7 +314,7 @@ const Util = Module("Util", XPCOM([Ci.nsIObserver, Ci.nsISupportsWeakReference])
"tel", "text", "time", "url", "week"]),
/**
- * Converts HTML special characters in str to the equivalent HTML
+ * Converts HTML special characters in *str* to the equivalent HTML
* entities.
*
* @param {string} str
@@ -325,7 +325,7 @@ const Util = Module("Util", XPCOM([Ci.nsIObserver, Ci.nsISupportsWeakReference])
},
/**
- * Escapes Regular Expression special characters in str.
+ * Escapes Regular Expression special characters in *str*.
*
* @param {string} str
* @returns {string}
@@ -335,9 +335,9 @@ const Util = Module("Util", XPCOM([Ci.nsIObserver, Ci.nsISupportsWeakReference])
},
/**
- * Escapes quotes, newline and tab characters in str. The returned
- * string is delimited by delimiter or " if delimiter is not
- * specified. {@see String#quote}.
+ * Escapes quotes, newline and tab characters in *str*. The returned string
+ * is delimited by *delimiter* or " if *delimiter* is not specified.
+ * {@see String#quote}.
*
* @param {string} str
* @param {string} delimiter
@@ -358,7 +358,7 @@ const Util = Module("Util", XPCOM([Ci.nsIObserver, Ci.nsISupportsWeakReference])
* @param {Document} doc The document to evaluate the expression in.
* @default The current document.
* @param {Node} elem The context element.
- * @default doc
+ * @default *doc*
* @param {boolean} asIterator Whether to return the results as an
* XPath iterator.
*/
@@ -410,11 +410,11 @@ const Util = Module("Util", XPCOM([Ci.nsIObserver, Ci.nsISupportsWeakReference])
},
/**
- * Converts bytes to a pretty printed data size string.
+ * Converts *bytes* to a pretty printed data size string.
*
* @param {number} bytes The number of bytes.
* @param {string} decimalPlaces The number of decimal places to use if
- * humanReadable is true.
+ * *humanReadable* is true.
* @param {boolean} humanReadable Use byte multiples.
* @returns {string}
*/
@@ -465,10 +465,10 @@ const Util = Module("Util", XPCOM([Ci.nsIObserver, Ci.nsISupportsWeakReference])
},
/**
- * Sends a synchronous or asynchronous HTTP request to url and
- * returns the XMLHttpRequest object. If callback is specified the
- * request is asynchronous and the callback is invoked with the
- * object as its argument.
+ * Sends a synchronous or asynchronous HTTP request to *url* and returns
+ * the XMLHttpRequest object. If *callback* is specified the request is
+ * asynchronous and the *callback* is invoked with the object as its
+ * argument.
*
* @param {string} url
* @param {function(XMLHttpRequest)} callback
@@ -518,7 +518,7 @@ const Util = Module("Util", XPCOM([Ci.nsIObserver, Ci.nsISupportsWeakReference])
}),
/**
- * Returns true if 'url' is in the domain 'domain'.
+ * Returns true if *url* is in the domain *domain*.
*
* @param {string} url
* @param {string} domain
@@ -527,7 +527,7 @@ const Util = Module("Util", XPCOM([Ci.nsIObserver, Ci.nsISupportsWeakReference])
isDomainURL: function isDomainURL(url, domain) util.isSubdomain(util.getHost(url), domain),
/**
- * Returns true if 'os' matches Dactyl's notion of the current operating
+ * Returns true if *os* matches Dactyl's notion of the current operating
* system platform. This is one of "WINNT", "Darwin" or "Unix".
*
* @param {string} os The OS platform to test.
@@ -539,7 +539,7 @@ const Util = Module("Util", XPCOM([Ci.nsIObserver, Ci.nsISupportsWeakReference])
},
/**
- * Returns true if 'host' is a subdomain of 'domain'.
+ * Returns true if *host* is a subdomain of *domain*.
*
* @param {string} host The host to check.
* @param {string} domain The base domain to check the host agains.
@@ -577,8 +577,8 @@ const Util = Module("Util", XPCOM([Ci.nsIObserver, Ci.nsISupportsWeakReference])
},
/**
- * Returns the array that results from applying func to each
- * property of obj.
+ * Returns the array that results from applying *func* to each property of
+ * *obj*.
*
* @param {Object} obj
* @param {function} func
@@ -604,7 +604,7 @@ const Util = Module("Util", XPCOM([Ci.nsIObserver, Ci.nsISupportsWeakReference])
/**
* Pretty print a JavaScript object. Use HTML markup to color certain items
- * if color is true.
+ * if *color* is true.
*
* @param {Object} object The object to pretty print.
* @param {boolean} color Whether the output should be colored.
@@ -804,8 +804,8 @@ const Util = Module("Util", XPCOM([Ci.nsIObserver, Ci.nsISupportsWeakReference])
},
/**
- * A generator that returns the values between start and end,
- * in step increments.
+ * A generator that returns the values between *start* and *end*, in *step*
+ * increments.
*
* @param {number} start The interval's start value.
* @param {number} end The interval's end value.
@@ -827,8 +827,8 @@ const Util = Module("Util", XPCOM([Ci.nsIObserver, Ci.nsISupportsWeakReference])
},
/**
- * An interruptible generator that returns all values between start
- * and end. The thread yields every time milliseconds.
+ * An interruptible generator that returns all values between *start* and
+ * *end*. The thread yields every *time* milliseconds.
*
* @param {number} start The interval's start value.
* @param {number} end The interval's end value.
@@ -945,7 +945,7 @@ const Util = Module("Util", XPCOM([Ci.nsIObserver, Ci.nsISupportsWeakReference])
.QueryInterface(Ci.nsISelectionController),
/**
- * Suspend execution for at least 'delay' milliseconds. Functions by
+ * Suspend execution for at least *delay* milliseconds. Functions by
* yielding execution to the next item in the main event queue, and
* so may lead to unexpected call graphs, and long delays if another
* handler yields execution while waiting.
@@ -976,7 +976,7 @@ const Util = Module("Util", XPCOM([Ci.nsIObserver, Ci.nsISupportsWeakReference])
},
/**
- * Behaves like String.split, except that when 'limit' is reached,
+ * Behaves like String.split, except that when *limit* is reached,
* the trailing element contains the entire trailing portion of the
* string.
*
@@ -1146,8 +1146,8 @@ const Prefs = Module("prefs", XPCOM([Ci.nsIObserver, Ci.nsISupportsWeakReference
},
/**
- * Lists all preferences matching filter or only those with
- * changed values if onlyNonDefault is specified.
+ * Lists all preferences matching *filter* or only those with changed
+ * values if *onlyNonDefault* is specified.
*
* @param {boolean} onlyNonDefault Limit the list to prefs with a
* non-default value.
@@ -1230,8 +1230,8 @@ const Prefs = Module("prefs", XPCOM([Ci.nsIObserver, Ci.nsISupportsWeakReference
},
/**
- * Resets the preference name to value but warns the user
- * if the value is changed from its default.
+ * Resets the preference *name* to *value* but warns the user if the value
+ * is changed from its default.
*
* @param {string} name The preference name.
* @param {value} value The new preference value.
@@ -1243,8 +1243,8 @@ const Prefs = Module("prefs", XPCOM([Ci.nsIObserver, Ci.nsISupportsWeakReference
},
/**
- * Sets the preference name to value but warns the user
- * if the value is changed from its default.
+ * Sets the preference *name* to *value* but warns the user if the value is
+ * changed from its default.
*
* @param {string} name The preference name.
* @param {value} value The new preference value.
@@ -1256,7 +1256,7 @@ const Prefs = Module("prefs", XPCOM([Ci.nsIObserver, Ci.nsISupportsWeakReference
},
/**
- * Sets the preference name to value.
+ * Sets the preference *name* to *value*.
*
* @param {string} name The preference name.
* @param {value} value The new preference value.
@@ -1266,7 +1266,7 @@ const Prefs = Module("prefs", XPCOM([Ci.nsIObserver, Ci.nsISupportsWeakReference
},
/**
- * Resets the preference name to its default value.
+ * Resets the preference *name* to its default value.
*
* @param {string} name The preference name.
*/
@@ -1278,7 +1278,7 @@ const Prefs = Module("prefs", XPCOM([Ci.nsIObserver, Ci.nsISupportsWeakReference
},
/**
- * Toggles the value of the boolean preference name.
+ * Toggles the value of the boolean preference *name*.
*
* @param {string} name The preference name.
*/
@@ -1308,13 +1308,12 @@ const Prefs = Module("prefs", XPCOM([Ci.nsIObserver, Ci.nsISupportsWeakReference
},
/**
- * Executes func with a new preference context. When func
- * returns, the context is popped and any preferences set via
- * {@link #setPref} or {@link #invertPref} are restored to their
- * previous values.
+ * Executes *func* with a new preference context. When *func* returns, the
+ * context is popped and any preferences set via {@link #setPref} or
+ * {@link #invertPref} are restored to their previous values.
*
* @param {function} func The function to call.
- * @param {Object} func The 'this' object with which to call func
+ * @param {Object} func The 'this' object with which to call *func*
* @see #pushContext
* @see #popContext
*/
@@ -1415,8 +1414,7 @@ const Prefs = Module("prefs", XPCOM([Ci.nsIObserver, Ci.nsISupportsWeakReference
const GlobalMath = Math;
var Math = update(Object.create(GlobalMath), {
/**
- * Returns the specified value constrained to the range min -
- * max.
+ * Returns the specified *value* constrained to the range *min* - *max*.
*
* @param {number} value The value to constrain.
* @param {number} min The minimum constraint.
diff --git a/melodactyl/content/config.js b/melodactyl/content/config.js
index 2593ee02..25482d9e 100644
--- a/melodactyl/content/config.js
+++ b/melodactyl/content/config.js
@@ -163,7 +163,7 @@ const Config = Module("config", ConfigBase, {
},
/**
- * Opens the display panel with the specified id.
+ * Opens the display panel with the specified *id*.
*
* @param {string} id The ID of the display pane.
*/
@@ -183,7 +183,7 @@ const Config = Module("config", ConfigBase, {
},
/**
- * Closes the display panel with the specified id
+ * Closes the display panel with the specified *id*
*
* @param {string} id The ID of the display pane.
*/
diff --git a/melodactyl/content/library.js b/melodactyl/content/library.js
index 30f1dfe1..66d904dd 100644
--- a/melodactyl/content/library.js
+++ b/melodactyl/content/library.js
@@ -28,8 +28,8 @@ const Library = Module("library", {
// FIXME: Prathyush do we really want to remove duplicates? If so, why not tracks too? --djk
/**
- * Returns an array of all the album names for artist in the
- * main library.
+ * Returns an array of all the album names for *artist* in the main
+ * library.
*
* @param {string} artist The artist's name.
* @returns {string[]}
@@ -41,8 +41,8 @@ const Library = Module("library", {
},
/**
- * Returns an array of all the track names for artist and
- * album in the main library.
+ * Returns an array of all the track names for *artist* and *album* in the
+ * main library.
*
* @param {string} artist The artist's name.
* @param {string} album The album's name.
diff --git a/melodactyl/content/player.js b/melodactyl/content/player.js
index 84bbd876..4af2caf0 100644
--- a/melodactyl/content/player.js
+++ b/melodactyl/content/player.js
@@ -22,8 +22,7 @@ const Player = Module("player", {
},
/**
- * Moves the track position interval milliseconds forwards or
- * backwards.
+ * Moves the track position *interval* milliseconds forwards or backwards.
*
* @param {number} interval The time interval (ms) to move the track
* position.
@@ -176,22 +175,20 @@ const Player = Module("player", {
},
/**
- * Seeks forward interval milliseconds in the currently playing
- * track.
+ * Seeks forward *interval* milliseconds in the currently playing track.
*
- * @param {number} interval The time interval (ms) to advance the
- * current track.
+ * @param {number} interval The time interval (ms) to advance the
+ * current track.
*/
seekForward: function seekForward(interval) {
this._seek(interval, true);
},
/**
- * Seeks backwards interval milliseconds in the currently
- * playing track.
+ * Seeks backwards *interval* milliseconds in the currently playing track.
*
- * @param {number} interval The time interval (ms) to rewind the
- * current track.
+ * @param {number} interval The time interval (ms) to rewind the
+ * current track.
*/
seekBackward: function seekBackward(interval) {
this._seek(interval, false);
@@ -236,7 +233,7 @@ const Player = Module("player", {
},
/**
- * Searches the current media view for str
+ * Searches the current media view for *str*
*
* @param {string} str The search string.
*/
@@ -349,7 +346,7 @@ const Player = Module("player", {
},
/**
- * Plays the media item at index in playlist.
+ * Plays the media item at *index* in *playlist*.
*
* @param {sbIMediaList} playlist
* @param {number} index
@@ -370,8 +367,8 @@ const Player = Module("player", {
},
/**
- * Loads the the specified media page into view with the given
- * list of media items.
+ * Loads the the specified media page into *view* with the given *list* of
+ * media items.
*
* @param {sbIMediaPage} page
* @param {sbIMediaList} list
@@ -383,7 +380,7 @@ const Player = Module("player", {
},
/**
- * Applys the specified rating to mediaItem.
+ * Applys the specified *rating* to *mediaItem*.
*
* @param {sbIMediaItem} mediaItem The media item to rate.
* @param {number} rating The star rating (1-5).
@@ -395,8 +392,8 @@ const Player = Module("player", {
// TODO: add more fields, and generate the list dynamically. PT should the
// available fields reflect only the visible view fields or offer others? --djk
/**
- * Sorts the current media view by field in the order specified by
- * ascending.
+ * Sorts the current media view by *field* in the order specified by
+ * *ascending*.
*
* @param {string} field The sort field.
* @param {boolean} ascending If true sort in ascending order, otherwise in