gryf/pentadactyl-pm
1
0
Fork 0
mirror of https://github.com/gryf/pentadactyl-pm.git synced 2026-03-14 01:55:46 +01:00
Code Issues Projects Releases Wiki Activity

Fix outdated mode type signatures in the source code docs.

Browse Source
This commit is contained in:
Štěpán Němec
2011-07-21 15:23:05 +02:00
parent c177a35a39
commit 5b895f0ef7
2 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
common/content/dactyl.js
View File

@@ -111,7 +111,7 @@ var Dactyl = Module("dactyl", XPCOM(Ci.nsISupportsWeakReference, ModuleBase), {
}), }),
/** /**
* @property {number} The current main mode. * @property {Modes.Mode} The current main mode.
* @see modes#mainModes * @see modes#mainModes
*/ */
mode: deprecated("modes.main", { mode: deprecated("modes.main", {

20
common/content/mappings.js
View File

@@ -12,7 +12,7 @@
* A class representing key mappings. Instances are created by the * A class representing key mappings. Instances are created by the
* {@link Mappings} class. * {@link Mappings} class.
* *
* @param {number[]} modes The modes in which this mapping is active. * @param {Modes.Mode[]} modes The modes in which this mapping is active.
* @param {string[]} keys The key sequences which are bound to * @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 {string} description A short one line description of the key mapping.
@@ -53,7 +53,7 @@ var Map = Class("Map", {
/** @property {number} A unique ID for this mapping. */ /** @property {number} A unique ID for this mapping. */
id: null, id: null,
/** @property {number[]} All of the modes for which this mapping applies. */ /** @property {Modes.Mode[]} All of the modes for which this mapping applies. */
modes: null, modes: null,
/** @property {function (number)} The function called to execute this mapping. */ /** @property {function (number)} The function called to execute this mapping. */
action: null, action: null,
@@ -156,7 +156,7 @@ var MapHive = Class("MapHive", Contexts.Hive, {
/** /**
* Adds a new key mapping. * Adds a new key mapping.
* *
* @param {number[]} modes The modes that this mapping applies to. * @param {Modes.Mode[]} 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 {string} description A description of the key mapping.
* @param {function} action The action invoked by each key sequence. * @param {function} action The action invoked by each key sequence.
@@ -348,7 +348,7 @@ var Mappings = Module("mappings", {
/** /**
* Adds a new default key mapping. * Adds a new default key mapping.
* *
* @param {number[]} modes The modes that this mapping applies to. * @param {Modes.Mode[]} 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 {string} description A description of the key mapping.
* @param {function} action The action invoked by each key sequence. * @param {function} action The action invoked by each key sequence.
@@ -370,7 +370,7 @@ var Mappings = Module("mappings", {
/** /**
* Adds a new user-defined key mapping. * Adds a new user-defined key mapping.
* *
* @param {number[]} modes The modes that this mapping applies to. * @param {Modes.Mode[]} 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 {string} description A description of the key mapping.
* @param {function} action The action invoked by each key sequence. * @param {function} action The action invoked by each key sequence.
@@ -387,7 +387,7 @@ var 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 {Modes.Mode} mode The mode to search.
* @param {string} cmd The map name to match. * @param {string} cmd The map name to match.
* @returns {Map} * @returns {Map}
*/ */
@@ -397,7 +397,7 @@ var Mappings = Module("mappings", {
* Returns an array of maps with names starting with but not equal to * Returns an array of maps with names starting with but not equal to
* *prefix*. * *prefix*.
* *
* @param {number} mode The mode to search. * @param {Modes.Mode} mode The mode to search.
* @param {string} prefix The map prefix string to match. * @param {string} prefix The map prefix string to match.
* @returns {Map[]} * @returns {Map[]}
*/ */
@@ -407,10 +407,10 @@ var Mappings = Module("mappings", {
/** /**
* Lists all user-defined mappings matching *filter* for the specified * Lists all user-defined mappings matching *filter* for the specified
* *modes*. * *modes* in the specified *hives*.
* *
* @param {number[]} modes An array of modes to search. * @param {Modes.Mode[]} modes An array of modes to search.
* @param {string} filter The filter string to match. * @param {string} filter The filter string to match. @optional
* @param {[MapHive]} hives The map hives to list. @optional * @param {[MapHive]} hives The map hives to list. @optional
*/ */
list: function (modes, filter, hives) { list: function (modes, filter, hives) {