diff --git a/common/content/bookmarks.js b/common/content/bookmarks.js index 1c46405b..7d16638b 100644 --- a/common/content/bookmarks.js +++ b/common/content/bookmarks.js @@ -187,8 +187,8 @@ const Bookmarks = Module("bookmarks", { // [keyword, helptext, url] getKeywords: function getKeywords() bookmarkcache.keywords, - // full search string including engine name as first word in @param text - // if @param useDefSearch is true, it uses the default search engine + // full search string including engine name as first word in *text* + // if *useDefSearch* is true, it uses the default search engine // @returns the url for the search string // if the search also requires a postData, [url, postData] is returned getSearchURL: function getSearchURL(text, useDefsearch) { diff --git a/common/content/buffer.js b/common/content/buffer.js index 4459de7f..6f797f84 100644 --- a/common/content/buffer.js +++ b/common/content/buffer.js @@ -832,7 +832,7 @@ const Buffer = Module("buffer", { // find the currently focused frame index // TODO: If the window is a frameset then the first _frame_ should be - // focused. Since this is not the current FF behaviour, + // focused. Since this is not the current FF behavior, // we initialize current to -1 so the first call takes us to the // first frame. let current = frames.indexOf(document.commandDispatcher.focusedWindow); diff --git a/common/content/commandline.js b/common/content/commandline.js index 557f8f55..7918cabe 100644 --- a/common/content/commandline.js +++ b/common/content/commandline.js @@ -577,7 +577,7 @@ const CommandLine = Module("commandline", { }, /** - * Display a multiline message. + * Display a multi-line message. * * @param {string} str * @param {string} highlightGroup @@ -752,7 +752,7 @@ const CommandLine = Module("commandline", { }, /** - * Get a multiline input from a user, up to but not including the line + * Get a multi-line input from a user, up to but not including the line * which matches the given regular expression. Then execute the * callback with that string as a parameter. * @@ -915,7 +915,7 @@ const CommandLine = Module("commandline", { }, /** - * Handle events when we are in multiline output mode, these come from + * Handle events when we are in multi-line output mode, these come from * dactyl when modes.extended & modes.MULTILINE_OUTPUT and also from * #dactyl-multiline-output in the XUL. * @@ -1120,7 +1120,7 @@ const CommandLine = Module("commandline", { }, /** - * Update or remove the multiline output widget's "MORE" prompt. + * Update or remove the multi-line output widget's "MORE" prompt. * * @param {boolean} force If true, "-- More --" is shown even if we're * at the end of the output. @@ -1269,7 +1269,7 @@ const CommandLine = Module("commandline", { } // search the history for the first item matching the current - // commandline string + // command-line string while (true) { this.index += diff; if (this.index < 0 || this.index > this.store.length) { diff --git a/common/content/dactyl.js b/common/content/dactyl.js index a1e919df..f4c33efe 100644 --- a/common/content/dactyl.js +++ b/common/content/dactyl.js @@ -225,7 +225,7 @@ const Dactyl = Module("dactyl", { * Outputs a plain message to the command line. * * @param {string} str The message to output. - * @param {number} flags These control the multiline message behaviour. + * @param {number} flags These control the multi-line message behavior. * See {@link CommandLine#echo}. */ echo: function echo(str, flags) { @@ -237,7 +237,7 @@ const Dactyl = Module("dactyl", { * Outputs an error message to the command line. * * @param {string} str The message to output. - * @param {number} flags These control the multiline message behaviour. + * @param {number} flags These control the multi-line message behavior. * See {@link CommandLine#echo}. */ echoerr: function echoerr(str, flags) { @@ -265,7 +265,7 @@ const Dactyl = Module("dactyl", { * @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. - * @param {number} flags These control the multiline message behaviour. + * @param {number} flags These control the multi-line message behavior. * See {@link CommandLine#echo}. */ echomsg: function (str, verbosity, flags) { diff --git a/common/content/dactyl.xul b/common/content/dactyl.xul index 59c78d92..52d784b8 100644 --- a/common/content/dactyl.xul +++ b/common/content/dactyl.xul @@ -1,11 +1,12 @@ - + --> " to push onto the event * queue. If you want "<" to be taken literally, prepend it with a @@ -343,7 +343,7 @@ const Events = Module("events", { * maps to , maps to A * << maps to * - * is preserved, as in vim, to allow untypeable key-combinations + * is preserved, as in Vim, to allow untypeable key-combinations * in macros. * * canonicalKeys(canonicalKeys(x)) == canonicalKeys(x) for all values @@ -463,8 +463,6 @@ const Events = Module("events", { * Converts the specified event to a string in dactyl key-code * notation. Returns null for an unknown event. * - * E.g. pressing ctrl+n would result in the string "". - * * @param {Event} event * @returns {string} */ @@ -503,7 +501,6 @@ const Events = Module("events", { // (i.e., cntrl codes 27--31) // --- // For more information, see: - // [*] Vimp FAQ: http://vimperator.org/trac/wiki/Pentadactyl/FAQ#WhydoesntC-workforEscMacOSX // [*] Referenced mailing list msg: http://www.mozdev.org/pipermail/pentadactyl/2008-May/001548.html // [*] Mozilla bug 416227: event.charCode in keypress handler has unexpected values on Mac for Ctrl with chars in "[ ] _ \" // https://bugzilla.mozilla.org/show_bug.cgi?query_format=specific&order=relevance+desc&bug_status=__open__&id=416227 @@ -516,7 +513,7 @@ const Events = Module("events", { // if your fancy keyboard permits such things), but // these mappings are probably pathological ( // certainly is on Windows), and so it is probably - // harmless to remove the has("Darwin") if desired. + // harmless to remove the util.OS.isMacOSX if desired. // else if (util.OS.isMacOSX && event.ctrlKey && charCode >= 27 && charCode <= 31) { if (charCode == 27) { // [Ctrl-Bug 1/5] the bug @@ -531,7 +528,7 @@ const Events = Module("events", { key = String.fromCharCode(charCode); if (!/^[a-z0-9]$/i.test(key) && key in this._key_code) { - // a named charcode key ( and ) space can be shifted, must be forced + // a named charCode key ( and ) space can be shifted, must be forced if ((key.match(/^\s$/) && event.shiftKey) || event.dactylShift) modifier += "S-"; @@ -769,7 +766,7 @@ const Events = Module("events", { }, // this keypress handler gets always called first, even if e.g. - // the commandline has focus + // the command-line has focus // TODO: ...help me...please... onKeyPress: function onKeyPress(event) { function isEscape(key) key == "" || key == ""; @@ -787,7 +784,7 @@ const Events = Module("events", { return null; if (modes.isRecording) { - if (key == "q" && !modes.mainMode.input) { // TODO: should not be hardcoded + if (key == "q" && !modes.mainMode.input) { // TODO: should not be hard-coded modes.isRecording = false; dactyl.log("Recorded " + this._currentMacro + ": " + this._macros.get(this._currentMacro, {}).keys, 9); dactyl.echomsg("Recorded macro '" + this._currentMacro + "'");