Permalink
Browse files

minor documentation fix

  • Loading branch information...
cowboy committed Jul 24, 2010
1 parent 4a1e51c commit 4b13171375ae86efd5315ebe3b15694a7a206965
@@ -27,11 +27,11 @@
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jQuery.param.querystring"></a>jQuery.<wbr>param.<wbr>querystring</h3><div class=CBody><p>Retrieve the query string from a URL or if no arguments are passed, the current window.location.</p><h4 class=CHeading>Usage</h4><blockquote><pre>jQuery.param.querystring( [ url ] );</pre></blockquote><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>url</td><td class=CDLDescription>(String) A URL containing query string params to be parsed.&nbsp; If url is not passed, the current window.location is used.</td></tr></table><h4 class=CHeading>Returns</h4><p>(String) The parsed query string, with any leading &ldquo;?&rdquo; removed.</p></div></div></div>
-<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jQuery.param.querystring(build_url)"></a>jQuery.<wbr>param.<wbr>querystring (build url)</h3><div class=CBody><p>Merge a URL, with or without pre-existing query string params, plus any object, params string or URL containing query string params into a new URL.</p><h4 class=CHeading>Usage</h4><blockquote><pre>jQuery.param.querystring( url, params [, merge_mode ] );</pre></blockquote><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>url</td><td class=CDLDescription>(String) A valid URL for params to be merged into.&nbsp; This URL may contain a query string and/or fragment (hash).</td></tr><tr><td class=CDLEntry>params</td><td class=CDLDescription>(String) A params string or URL containing query string params to be merged into url.</td></tr><tr><td class=CDLEntry>params</td><td class=CDLDescription>(Object) A params object to be merged into url.</td></tr><tr><td class=CDLEntry>merge_mode</td><td class=CDLDescription>(Number) Merge behavior defaults to 0 if merge_mode is not specified, and is as-follows:</td></tr></table><ul><li>0: params in the params argument will override any query string params in url.</li><li>1: any query string params in url will override params in the params argument.</li><li>2: params argument will completely replace any query string in url.</li></ul><h4 class=CHeading>Returns</h4><p>(String) Either a params string with urlencoded data or a URL with a urlencoded query string in the format &lsquo;a=b&amp;c=d&amp;e=f&rsquo;.</p></div></div></div>
+<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jQuery.param.querystring(build_url)"></a>jQuery.<wbr>param.<wbr>querystring (build url)</h3><div class=CBody><p>Merge a URL, with or without pre-existing query string params, plus any object, params string or URL containing query string params into a new URL.</p><h4 class=CHeading>Usage</h4><blockquote><pre>jQuery.param.querystring( url, params [, merge_mode ] );</pre></blockquote><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>url</td><td class=CDLDescription>(String) A valid URL for params to be merged into.&nbsp; This URL may contain a query string and/or fragment (hash).</td></tr><tr><td class=CDLEntry>params</td><td class=CDLDescription>(String) A params string or URL containing query string params to be merged into url.</td></tr><tr><td class=CDLEntry>params</td><td class=CDLDescription>(Object) A params object to be merged into url.</td></tr><tr><td class=CDLEntry>merge_mode</td><td class=CDLDescription>(Number) Merge behavior defaults to 0 if merge_mode is not specified, and is as-follows:</td></tr></table><ul><li>0: params in the params argument will override any query string params in url.</li><li>1: any query string params in url will override params in the params argument.</li><li>2: params argument will completely replace any query string in url.</li></ul><h4 class=CHeading>Returns</h4><p>(String) A URL with a urlencoded query string in the format &lsquo;?a=b&amp;c=d&amp;e=f&rsquo;.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jQuery.param.fragment"></a>jQuery.<wbr>param.<wbr>fragment</h3><div class=CBody><p>Retrieve the fragment (hash) from a URL or if no arguments are passed, the current window.location.</p><h4 class=CHeading>Usage</h4><blockquote><pre>jQuery.param.fragment( [ url ] );</pre></blockquote><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>url</td><td class=CDLDescription>(String) A URL containing fragment (hash) params to be parsed.&nbsp; If url is not passed, the current window.location is used.</td></tr></table><h4 class=CHeading>Returns</h4><p>(String) The parsed fragment (hash) string, with any leading &ldquo;#&rdquo; removed.</p></div></div></div>
-<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jQuery.param.fragment(build_url)"></a>jQuery.<wbr>param.<wbr>fragment (build url)</h3><div class=CBody><p>Merge a URL, with or without pre-existing fragment (hash) params, plus any object, params string or URL containing fragment (hash) params into a new URL.</p><h4 class=CHeading>Usage</h4><blockquote><pre>jQuery.param.fragment( url, params [, merge_mode ] );</pre></blockquote><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>url</td><td class=CDLDescription>(String) A valid URL for params to be merged into.&nbsp; This URL may contain a query string and/or fragment (hash).</td></tr><tr><td class=CDLEntry>params</td><td class=CDLDescription>(String) A params string or URL containing fragment (hash) params to be merged into url.</td></tr><tr><td class=CDLEntry>params</td><td class=CDLDescription>(Object) A params object to be merged into url.</td></tr><tr><td class=CDLEntry>merge_mode</td><td class=CDLDescription>(Number) Merge behavior defaults to 0 if merge_mode is not specified, and is as-follows:</td></tr></table><ul><li>0: params in the params argument will override any fragment (hash) params in url.</li><li>1: any fragment (hash) params in url will override params in the params argument.</li><li>2: params argument will completely replace any query string in url.</li></ul><h4 class=CHeading>Returns</h4><p>(String) Either a params string with urlencoded data or a URL with a urlencoded fragment (hash) in the format &lsquo;a=b&amp;c=d&amp;e=f&rsquo;.</p></div></div></div>
+<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jQuery.param.fragment(build_url)"></a>jQuery.<wbr>param.<wbr>fragment (build url)</h3><div class=CBody><p>Merge a URL, with or without pre-existing fragment (hash) params, plus any object, params string or URL containing fragment (hash) params into a new URL.</p><h4 class=CHeading>Usage</h4><blockquote><pre>jQuery.param.fragment( url, params [, merge_mode ] );</pre></blockquote><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>url</td><td class=CDLDescription>(String) A valid URL for params to be merged into.&nbsp; This URL may contain a query string and/or fragment (hash).</td></tr><tr><td class=CDLEntry>params</td><td class=CDLDescription>(String) A params string or URL containing fragment (hash) params to be merged into url.</td></tr><tr><td class=CDLEntry>params</td><td class=CDLDescription>(Object) A params object to be merged into url.</td></tr><tr><td class=CDLEntry>merge_mode</td><td class=CDLDescription>(Number) Merge behavior defaults to 0 if merge_mode is not specified, and is as-follows:</td></tr></table><ul><li>0: params in the params argument will override any fragment (hash) params in url.</li><li>1: any fragment (hash) params in url will override params in the params argument.</li><li>2: params argument will completely replace any query string in url.</li></ul><h4 class=CHeading>Returns</h4><p>(String) A URL with a urlencoded fragment (hash) in the format &lsquo;#a=b&amp;c=d&amp;e=f&rsquo;.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jQuery.param.fragment.noEscape"></a>jQuery.<wbr>param.<wbr>fragment.<wbr>noEscape</h3><div class=CBody><p>Specify characters that will be left unescaped when fragments are created or merged using <a href="#jQuery.param.fragment" class=LFunction id=link19 onMouseOver="ShowTip(event, 'tt1', 'link19')" onMouseOut="HideTip('tt1')">jQuery.param.fragment</a>, or when the fragment is modified using <a href="#jQuery.bbq.pushState" class=LFunction id=link20 onMouseOver="ShowTip(event, 'tt2', 'link20')" onMouseOut="HideTip('tt2')">jQuery.bbq.pushState</a>.&nbsp; This option only applies to serialized data object fragments, and not set-as-string fragments.&nbsp; Does not affect the query string.&nbsp; Defaults to &ldquo;,/&rdquo; (comma, forward slash).</p><p>Note that this is considered a purely aesthetic option, and will help to create URLs that &ldquo;look pretty&rdquo; in the address bar or bookmarks, without affecting functionality in any way.&nbsp; That being said, be careful to not unescape characters that are used as delimiters or serve a special purpose, such as the &ldquo;#?&amp;=+&rdquo; (octothorpe, question mark, ampersand, equals, plus) characters.</p><h4 class=CHeading>Usage</h4><blockquote><pre>jQuery.param.fragment.noEscape( [ chars ] );</pre></blockquote><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>chars</td><td class=CDLDescription>(String) The characters to not escape in the fragment.&nbsp; If unspecified, defaults to empty string (escape all characters).</td></tr></table><h4 class=CHeading>Returns</h4><p>Nothing.</p></div></div></div>
Binary file not shown.
View
@@ -1,4 +1,4 @@
1.4
JavaScript
-/srv/projects/jquery-bbq/jquery.ba-bbq.min.js 1266412842 0 /srv/projects/jquery-bbq/jquery.ba-bbq.min.js
-/srv/projects/jquery-bbq/jquery.ba-bbq.js 1266412756 1 jQuery BBQ: Back Button & Query Library
+/srv/projects/jquery-bbq-dev/jquery.ba-bbq.js 1269346756 1 jQuery BBQ: Back Button & Query Library
+/srv/projects/jquery-bbq-dev/jquery.ba-bbq.min.js 1279979679 0 /srv/projects/jquery-bbq-dev/jquery.ba-bbq.min.js
Binary file not shown.
Binary file not shown.
View
Binary file not shown.
View
@@ -189,8 +189,7 @@
//
// Returns:
//
- // (String) Either a params string with urlencoded data or a URL with a
- // urlencoded query string in the format 'a=b&c=d&e=f'.
+ // (String) A URL with a urlencoded query string in the format '?a=b&c=d&e=f'.
// Method: jQuery.param.fragment
//
@@ -238,8 +237,7 @@
//
// Returns:
//
- // (String) Either a params string with urlencoded data or a URL with a
- // urlencoded fragment (hash) in the format 'a=b&c=d&e=f'.
+ // (String) A URL with a urlencoded fragment (hash) in the format '#a=b&c=d&e=f'.
function jq_param_sub( is_fragment, get_func, url, params, merge_mode ) {
var result,

0 comments on commit 4b13171

Please sign in to comment.