Skip to content
Browse files

minor docs tweak

  • Loading branch information...
1 parent 7f73abe commit 0b1d9d46f339868f5112dde921fc5e85815b3c5f @cowboy committed Nov 17, 2009
Showing with 4 additions and 4 deletions.
  1. +1 −1 ba-linkify.js
  2. +1 −1 docs/files/ba-linkify-js.html
  3. +2 −2 docs/nd/Data/FileInfo.nd
  4. BIN docs/nd/Data/SymbolTable.nd
View
2 ba-linkify.js
@@ -47,7 +47,7 @@
//
// Usage:
//
-// > linkify( text [, options ] );
+// > var html = linkify( text [, options ] );
//
// Arguments:
//
View
2 docs/files/ba-linkify-js.html
@@ -23,7 +23,7 @@
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Functions"></a>Functions</h3></div></div>
-<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="linkify"></a>linkify</h3><div class=CBody><p>Turn text into linkified html.</p><h4 class=CHeading>Usage</h4><blockquote><pre>linkify( text [, options ] );</pre></blockquote><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>text</td><td class=CDLDescription>(String) Non-HTML text containing links to be parsed.</td></tr><tr><td class=CDLEntry>options</td><td class=CDLDescription>(Object) An optional object containing linkify parse options.</td></tr></table><h4 class=CHeading>Options</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>callback (Function)</td><td class=CDLDescription>If specified, this will be called once for each link- or non-link-chunk with two arguments, text and href.&nbsp; If the chunk is non-link, href will be omitted.&nbsp; If unspecified, the default linkification callback is used.</td></tr><tr><td class=CDLEntry>punct_regexp (RegExp)</td><td class=CDLDescription>A RegExp that will be used to trim trailing punctuation from links, instead of the default.&nbsp; If set to null, trailing punctuation will not be trimmed.</td></tr></table><h4 class=CHeading>Returns</h4><p>(String) An HTML string containing links.</p></div></div></div>
+<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="linkify"></a>linkify</h3><div class=CBody><p>Turn text into linkified html.</p><h4 class=CHeading>Usage</h4><blockquote><pre>var html = linkify( text [, options ] );</pre></blockquote><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>text</td><td class=CDLDescription>(String) Non-HTML text containing links to be parsed.</td></tr><tr><td class=CDLEntry>options</td><td class=CDLDescription>(Object) An optional object containing linkify parse options.</td></tr></table><h4 class=CHeading>Options</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>callback (Function)</td><td class=CDLDescription>If specified, this will be called once for each link- or non-link-chunk with two arguments, text and href.&nbsp; If the chunk is non-link, href will be omitted.&nbsp; If unspecified, the default linkification callback is used.</td></tr><tr><td class=CDLEntry>punct_regexp (RegExp)</td><td class=CDLDescription>A RegExp that will be used to trim trailing punctuation from links, instead of the default.&nbsp; If set to null, trailing punctuation will not be trimmed.</td></tr></table><h4 class=CHeading>Returns</h4><p>(String) An HTML string containing links.</p></div></div></div>
</div><!--Content-->
View
4 docs/nd/Data/FileInfo.nd
@@ -1,4 +1,4 @@
1.4
JavaScript
-/srv/projects/javascript-linkify/ba-linkify.js 1258420851 1 JavaScript Linkify: Process links in text!
-/srv/projects/javascript-linkify/ba-linkify.min.js 1258420870 0 /srv/projects/javascript-linkify/ba-linkify.min.js
+/srv/projects/javascript-linkify/ba-linkify.js 1258421513 1 JavaScript Linkify: Process links in text!
+/srv/projects/javascript-linkify/ba-linkify.min.js 1258421525 0 /srv/projects/javascript-linkify/ba-linkify.min.js
View
BIN docs/nd/Data/SymbolTable.nd
Binary file not shown.

0 comments on commit 0b1d9d4

Please sign in to comment.
Something went wrong with that request. Please try again.