From 915ac1aaf14fc1ed3a8e5a452709b8aed61ba3db Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=A0t=C4=9Bp=C3=A1n=20N=C4=9Bmec?= Date: Wed, 14 Mar 2012 00:08:58 +0100 Subject: [PATCH] dactyl.open: An attempt at correcting the *urls* argument documentation. --- common/content/dactyl.js | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/common/content/dactyl.js b/common/content/dactyl.js index 1ccc1bda..17f68aed 100644 --- a/common/content/dactyl.js +++ b/common/content/dactyl.js @@ -887,11 +887,15 @@ var Dactyl = Module("dactyl", XPCOM(Ci.nsISupportsWeakReference, ModuleBase), { * Opens one or more URLs. Returns true when load was initiated, or * false on error. * - * @param {string|object|Array} urls A representation of the URLs to open. May be - * either a string, which will be passed to - * {@link Dactyl#parseURLs}, an array in the same format as - * would be returned by the same, or an object as returned by - * {@link DOM#formData}. + * @param {string|Array} urls A representation of the URLs to open. + * A string will be passed to {@link Dactyl#parseURLs}. An array may + * contain elements of the following forms: + * + * • {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 * URLs. The following properties are recognized: *