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

Partially clean up the abbreviations API docs.

Browse Source
This commit is contained in:
Doug Kearns
2010-11-10 12:13:45 +11:00
parent d23b43d963
commit 6490bade8b
1 changed files with 17 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
common/content/abbreviations.js
View File

@@ -94,7 +94,7 @@ const Abbreviations = Module("abbreviations", {
/** /**
* Adds a new abbreviation. * Adds a new abbreviation.
* *
* @param {Abbreviation} * @param {Abbreviation} abbr The abbreviation to add.
*/ */
add: function (abbr) { add: function (abbr) {
if (!(abbr instanceof Abbreviation)) if (!(abbr instanceof Abbreviation))
@@ -108,10 +108,10 @@ const Abbreviations = Module("abbreviations", {
}, },
/** /**
* Returns matched abbreviation. * Returns the abbreviation with *lhs* in the given *mode*.
* *
* @param {mode} * @param {Mode} mode The mode of the abbreviation.
* @param {string} * @param {string} lhs The LHS of the abbreviation.
*/ */
get: function (mode, lhs) { get: function (mode, lhs) {
let abbrevs = this.abbrevs[mode]; let abbrevs = this.abbrevs[mode];
@@ -119,7 +119,11 @@ const Abbreviations = Module("abbreviations", {
}, },
/** /**
* Returns the abbreviation that matches the given text. * Returns the abbreviation for the given *mode* if *text* matches the
* abbreviation expansion criteria.
*
* @param {Mode} mode The mode to search.
* @param {string} text The string to test against the expansion criteria.
* *
* @returns {Abbreviation} * @returns {Abbreviation}
*/ */
@@ -131,7 +135,8 @@ const Abbreviations = Module("abbreviations", {
}, },
/** /**
* The list of the abbreviations merged from each modes. * @property {Abbreviation[]} The list of the abbreviations merged from
* each mode.
*/ */
get merged() { get merged() {
let result = []; let result = [];
@@ -160,7 +165,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 {Array} modes List of modes.
* @param {string} lhs The LHS of the abbreviation. * @param {string} lhs The LHS of the abbreviation.
*/ */
list: function (modes, lhs) { list: function (modes, lhs) {
@@ -182,9 +187,9 @@ const Abbreviations = Module("abbreviations", {
/** /**
* Remove the specified abbreviations. * Remove the specified abbreviations.
* *
* @param {Array} list of mode. * @param {Array} modes List of modes.
* @param {string} lhs of abbreviation. * @param {string} lhs The LHS of the abbreviation.
* @returns {boolean} did the deleted abbreviation exist? * @returns {boolean} Did the deleted abbreviation exist?
*/ */
remove: function (modes, lhs) { remove: function (modes, lhs) {
let result = false; let result = false;
@@ -199,9 +204,9 @@ const Abbreviations = Module("abbreviations", {
}, },
/** /**
* Removes all abbreviations specified *modes*. * Removes all abbreviations specified in *modes*.
* *
* @param {Array} list of mode. * @param {Array} modes List of modes.
*/ */
removeAll: function (modes) { removeAll: function (modes) {
for (let [, mode] in modes) { for (let [, mode] in modes) {