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

dactyl.open: An attempt at correcting the *urls* argument documentation.

Browse Source
This commit is contained in:
Štěpán Němec
2012-03-14 00:08:58 +01:00
parent 7479e92d39
commit 915ac1aaf1
1 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
common/content/dactyl.js
View File

@@ -887,11 +887,15 @@ var Dactyl = Module("dactyl", XPCOM(Ci.nsISupportsWeakReference, ModuleBase), {
* Opens one or more URLs. Returns true when load was initiated, or * Opens one or more URLs. Returns true when load was initiated, or
* false on error. * false on error.
* *
* @param {string|object|Array} urls A representation of the URLs to open. May be * @param {string|Array} urls A representation of the URLs to open.
* either a string, which will be passed to * A string will be passed to {@link Dactyl#parseURLs}. An array may
* {@link Dactyl#parseURLs}, an array in the same format as * contain elements of the following forms:
* would be returned by the same, or an object as returned by *
* {@link DOM#formData}. * • {string} A URL to open.
* • {[string, string]} Pair of a URL and POST data.
* • {object} Object compatible with those returned by
* {@link DOM#formData}.
*
* @param {object} params A set of parameters specifying how to open the * @param {object} params A set of parameters specifying how to open the
* URLs. The following properties are recognized: * URLs. The following properties are recognized:
* *