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

Fix some munged documentation.

Browse Source
This commit is contained in:
Doug Kearns
2009-11-10 18:27:32 +11:00
parent 11a6c03c71
commit e04cc5dd33
3 changed files with 29 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
common/content/commandline.js
View File

@@ -484,7 +484,7 @@ const CommandLine = Module("commandline", {
* @default "Normal" * @default "Normal"
* @param {number} flags Changes the behavior as follows: * @param {number} flags Changes the behavior as follows:
* commandline.APPEND_TO_MESSAGES - Causes message to be added to the * commandline.APPEND_TO_MESSAGES - Causes message to be added to the
* messages this._history, and shown by :messages. * messages history, and shown by :messages.
* commandline.FORCE_SINGLELINE - Forbids the command from being * commandline.FORCE_SINGLELINE - Forbids the command from being
* pushed to the MOW if it's too long or of there are already * pushed to the MOW if it's too long or of there are already
* status messages being shown. * status messages being shown.
@@ -957,8 +957,7 @@ const CommandLine = Module("commandline", {
}, },
/** /**
* Changes the height of the this._multilineOutputWidget to fit in the * Changes the height of the message window to fit in the available space.
* available space.
* *
* @param {boolean} open If true, the widget will be opened if it's not * @param {boolean} open If true, the widget will be opened if it's not
* already so. * already so.
@@ -989,10 +988,10 @@ const CommandLine = Module("commandline", {
} }
}, { }, {
/** /**
* A class for managing the this._history of an inputField. * A class for managing the history of an input field.
* *
* @param {HTMLInputElement} inputField * @param {HTMLInputElement} inputField
* @param {string} mode The mode for which we need this._history. * @param {string} mode The mode for which we need history.
*/ */
History: Class("History", { History: Class("History", {
init: function (inputField, mode) { init: function (inputField, mode) {
@@ -1002,7 +1001,7 @@ const CommandLine = Module("commandline", {
this.reset(); this.reset();
}, },
/** /**
* Reset the this._history index to the first entry. * Reset the history index to the first entry.
*/ */
reset: function () { reset: function () {
this.index = null; this.index = null;
@@ -1032,7 +1031,7 @@ const CommandLine = Module("commandline", {
return false; return false;
}, },
/** /**
* Removes any private data from this this._history. * Removes any private data from this history.
*/ */
sanitize: function (timespan) { sanitize: function (timespan) {
let range = [0, Number.MAX_VALUE]; let range = [0, Number.MAX_VALUE];
@@ -1055,7 +1054,7 @@ const CommandLine = Module("commandline", {
}, },
/** /**
* Move forward or backward in this._history. * Move forward or backward in history.
* *
* @param {boolean} backward Direction to move. * @param {boolean} backward Direction to move.
* @param {boolean} matchCurrent Search for matches starting * @param {boolean} matchCurrent Search for matches starting
@@ -1105,7 +1104,7 @@ const CommandLine = Module("commandline", {
}), }),
/** /**
* A class for tab this._completions on an input field. * A class for tab completions on an input field.
* *
* @param {Object} input * @param {Object} input
*/ */
@@ -1708,7 +1707,7 @@ const ItemList = Class("ItemList", {
}, },
/** /**
* Uses the entries in "items" to this._fill the listbox and does incremental * Uses the entries in "items" to fill the listbox and does incremental
* filling to speed up things. * filling to speed up things.
* *
* @param {number} offset Start at this index and show options["maxitems"]. * @param {number} offset Start at this index and show options["maxitems"].

10
common/content/editor.js
View File

@@ -547,11 +547,11 @@ const Editor = Module("editor", {
}, },
/** /**
* Returns all this._abbreviations matching <b>filter</b> and <b>lhs</b>. * Returns all abbreviations matching <b>filter</b> and <b>lhs</b>.
* *
* @param {string} filter The mode filter. * @param {string} filter The mode filter.
* @param {string} lhs The LHS of the abbreviation. * @param {string} lhs The LHS of the abbreviation.
* @returns {Array} The matching this._abbreviations [mode, lhs, rhs] * @returns {Array} The matching abbreviations [mode, lhs, rhs]
* @see #addAbbreviation * @see #addAbbreviation
*/ */
getAbbreviations: function (filter, lhs) { getAbbreviations: function (filter, lhs) {
@@ -562,7 +562,7 @@ const Editor = Module("editor", {
}, },
/** /**
* Lists all this._abbreviations matching <b>filter</b> and <b>lhs</b>. * Lists all abbreviations matching <b>filter</b> and <b>lhs</b>.
* *
* @param {string} filter The mode filter. * @param {string} filter The mode filter.
* @param {string} lhs The LHS of the abbreviation. * @param {string} lhs The LHS of the abbreviation.
@@ -585,7 +585,7 @@ const Editor = Module("editor", {
}, },
/** /**
* Deletes all this._abbreviations matching <b>filter</b> and <b>lhs</b>. * Deletes all abbreviations matching <b>filter</b> and <b>lhs</b>.
* *
* @param {string} filter The mode filter. * @param {string} filter The mode filter.
* @param {string} lhs The LHS of the abbreviation. * @param {string} lhs The LHS of the abbreviation.
@@ -629,7 +629,7 @@ const Editor = Module("editor", {
}, },
/** /**
* Removes all this._abbreviations matching <b>filter</b>. * Removes all abbreviations matching <b>filter</b>.
* *
* @param {string} filter The mode filter. * @param {string} filter The mode filter.
* @see #addAbbreviation * @see #addAbbreviation

28
common/content/hints.js
View File

@@ -106,12 +106,13 @@ const Hints = Module("hints", {
* Get a hint for "input", "textarea" and "select". * Get a hint for "input", "textarea" and "select".
* *
* Tries to use <label>s if possible but does not try to guess that a * Tries to use <label>s if possible but does not try to guess that a
* neighbouring element might look like a label. Only called by this._generate(). * neighbouring element might look like a label. Only called by
* {@link #_generate}.
* *
* If it finds a hint it returns it, if the hint is not the caption of the * If it finds a hint it returns it, if the hint is not the caption of the
* element it will return showText=true. * element it will return showText=true.
* *
* @param {Object} elem The element used to this._generate hint text. * @param {Object} elem The element used to generate hint text.
* @param {Document} doc The containing document. * @param {Document} doc The containing document.
* *
* @returns [text, showText] * @returns [text, showText]
@@ -165,7 +166,7 @@ const Hints = Module("hints", {
/** /**
* Gets the actual offset of an imagemap area. * Gets the actual offset of an imagemap area.
* *
* Only called by this._generate(). * Only called by {@link #_generate}.
* *
* @param {Object} elem The <area> element. * @param {Object} elem The <area> element.
* @param {number} leftPos The left offset of the image. * @param {number} leftPos The left offset of the image.
@@ -242,9 +243,10 @@ const Hints = Module("hints", {
/** /**
* Generate the hints in a window. * Generate the hints in a window.
* *
* Pushes the hints into the this._pageHints object, but does not display them. * Pushes the hints into the pageHints object, but does not display them.
* *
* @param {Window} win The window,defaults to window.content. * @param {Window} win The window for which to generate hints.
* @default window.content
*/ */
_generate: function (win) { _generate: function (win) {
if (!win) if (!win)
@@ -343,7 +345,7 @@ const Hints = Module("hints", {
}, },
/** /**
* Display the hints in this._pageHints that are still valid. * Display the hints in pageHints that are still valid.
*/ */
_showHints: function () { _showHints: function () {
@@ -414,7 +416,7 @@ const Hints = Module("hints", {
}, },
/** /**
* Remove all hints from the document, and this._reset the completions. * Remove all hints from the document, and reset the completions.
* *
* Lingers on the active hint briefly to confirm the selection to the user. * Lingers on the active hint briefly to confirm the selection to the user.
* *
@@ -537,10 +539,10 @@ const Hints = Module("hints", {
}, },
/** /**
* Get the this._hintMatcher according to user preference. * Get the hintMatcher according to user preference.
* *
* @param {string} this._hintString The currently typed hint. * @param {string} hintString The currently typed hint.
* @returns {this._hintMatcher} * @returns {hintMatcher}
*/ */
_hintMatcher: function (hintString) { //{{{ _hintMatcher: function (hintString) { //{{{
/** /**
@@ -555,7 +557,7 @@ const Hints = Module("hints", {
/** /**
* Get a hint matcher for hintmatching=contains * Get a hint matcher for hintmatching=contains
* *
* The this._hintMatcher expects the user input to be space delimited and it * The hintMatcher expects the user input to be space delimited and it
* returns true if each set of characters typed can be found, in any * returns true if each set of characters typed can be found, in any
* order, in the link. * order, in the link.
* *
@@ -573,9 +575,9 @@ const Hints = Module("hints", {
} //}}} } //}}}
/** /**
* Get a this._hintMatcher for hintmatching=firstletters|wordstartswith * Get a hintMatcher for hintmatching=firstletters|wordstartswith
* *
* The this._hintMatcher will look for any division of the user input that * The hintMatcher will look for any division of the user input that
* would match the first letters of words. It will always only match * would match the first letters of words. It will always only match
* words in order. * words in order.
* *