diff options
author | Tom Faulhaber <git_net@infolace.com> | 2010-04-30 16:19:00 -0700 |
---|---|---|
committer | Tom Faulhaber <git_net@infolace.com> | 2010-04-30 16:19:00 -0700 |
commit | 4a3f270f93c687ec29f9cdd178f22b9fd3d82e37 (patch) | |
tree | cbe8efecfd3a0aab290cb6b7c2eec2135385d52a /string-api.html | |
parent | ae92eda353beed7ff5ee07ea80491d7c7bca110c (diff) |
Manual autodoc update (mostly whitespace diffs caused by new tags, not yet used).
Diffstat (limited to 'string-api.html')
-rw-r--r-- | string-api.html | 146 |
1 files changed, 110 insertions, 36 deletions
diff --git a/string-api.html b/string-api.html index 462ba24b..ecf6b012 100644 --- a/string-api.html +++ b/string-api.html @@ -140,6 +140,8 @@ by <span id="author">Unknown</span><br /> </pre><pre> </pre><h2>Overview</h2> <pre id="namespace-docstr"></pre> + + <br /> <h2>Public Variables and Functions</h2> <div id="var-entry"> @@ -164,7 +166,9 @@ data structures; they will be rendered as with str. Example: (str {:foo :bar}) ;;=> "{:foo :bar}" (as-str {:foo :bar}) ;;=> "{:foo :bar}" </pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L298" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -173,7 +177,9 @@ Example: <pre id="var-usage">Usage: (blank? s) </pre> <pre id="var-docstr">True if s is nil, empty, or contains only whitespace.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L102" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -183,7 +189,9 @@ Example: </pre> <pre id="var-docstr">Returns s without the last n characters. Returns an empty string if n is greater than the length of s.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L122" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -193,7 +201,9 @@ if n is greater than the length of s.</pre> </pre> <pre id="var-docstr">Converts first character of the string to upper-case, all other characters to lower-case.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L260" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -203,7 +213,9 @@ characters to lower-case.</pre> </pre> <pre id="var-docstr">Removes all trailing newline \n or return \r characters from string. Note: String.trim() is similar and faster.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L233" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -213,7 +225,9 @@ string. Note: String.trim() is similar and faster.</pre> </pre> <pre id="var-docstr">Removes the last character of string, does nothing on a zero-length string.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L224" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -223,7 +237,9 @@ string.</pre> </pre> <pre id="var-docstr">Returns a sequence of integer Unicode code points in s. Handles Unicode supplementary characters (above U+FFFF) correctly.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L77" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -236,7 +252,9 @@ Unicode supplementary characters (above U+FFFF) correctly.</pre> Repeatedly executes body, with name bound to each character in string. Does NOT handle Unicode supplementary characters (above U+FFFF).</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L37" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -249,7 +267,9 @@ U+FFFF).</pre> Repeatedly executes body, with name bound to the integer code point of each Unicode character in the string. Handles Unicode supplementary characters (above U+FFFF) correctly.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L53" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -259,7 +279,9 @@ supplementary characters (above U+FFFF) correctly.</pre> </pre> <pre id="var-docstr">Drops first n characters from s. Returns an empty string if n is greater than the length of s.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L114" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -270,7 +292,9 @@ greater than the length of s.</pre> <pre id="var-docstr">Returns a new String by applying cmap (a function or a map) to each character in s. If cmap returns nil, the original character is added to the output unchanged.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L90" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -279,7 +303,9 @@ added to the output unchanged.</pre> <pre id="var-usage">Usage: (get s i) </pre> <pre id="var-docstr">Gets the i'th character in string.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L356" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -289,7 +315,9 @@ added to the output unchanged.</pre> </pre> <pre id="var-docstr">Filters elements of coll by a regular expression. The String representation (with str) of each element is tested with re-find.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L292" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -299,7 +327,9 @@ representation (with str) of each element is tested with re-find.</pre> </pre> <pre id="var-docstr">Returns a string of all elements in coll, separated by separator. Like Perl's join.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L218" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -308,7 +338,9 @@ separator. Like Perl's join.</pre> <pre id="var-usage">Usage: (lower-case s) </pre> <pre id="var-docstr">Converts string to all lower-case.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L335" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -317,7 +349,9 @@ separator. Like Perl's join.</pre> <pre id="var-usage">Usage: (ltrim s) </pre> <pre id="var-docstr">Removes whitespace from the left side of string.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L269" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -327,7 +361,9 @@ separator. Like Perl's join.</pre> </pre> <pre id="var-docstr">Apply f to each element of coll, concatenate all results into a String.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L285" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -343,7 +379,9 @@ string matches. For example: (partition #"[a-z]+" "abc123def") returns: ("" "abc" "123" "def")</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L197" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -352,7 +390,9 @@ returns: ("" "abc" "123" "def")</pre> <pre id="var-usage">Usage: (repeat n s) </pre> <pre id="var-docstr">Returns a new String containing s repeated n times.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L137" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -362,7 +402,9 @@ returns: ("" "abc" "123" "def")</pre> </pre> <pre id="var-docstr">Replaces all matches of re in s with the result of (f (re-groups the-match)).</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L162" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -371,7 +413,9 @@ returns: ("" "abc" "123" "def")</pre> <pre id="var-usage">Usage: (replace-char a b s) </pre> <pre id="var-docstr">Replaces all instances of character a with character b in s.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L152" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -381,7 +425,9 @@ returns: ("" "abc" "123" "def")</pre> </pre> <pre id="var-docstr">Replace first match of re in s with the result of (f (re-groups the-match)).</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L185" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -390,7 +436,9 @@ returns: ("" "abc" "123" "def")</pre> <pre id="var-usage">Usage: (replace-first-re re replacement s) </pre> <pre id="var-docstr">Replace first match of re in s.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L180" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -399,7 +447,9 @@ returns: ("" "abc" "123" "def")</pre> <pre id="var-usage">Usage: (replace-first-str a b s) </pre> <pre id="var-docstr">Replace first occurance of substring a with b in s.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L175" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -408,7 +458,9 @@ returns: ("" "abc" "123" "def")</pre> <pre id="var-usage">Usage: (replace-re re replacement s) </pre> <pre id="var-docstr">Replaces all matches of re with replacement in s.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L157" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -417,7 +469,9 @@ returns: ("" "abc" "123" "def")</pre> <pre id="var-usage">Usage: (replace-str a b s) </pre> <pre id="var-docstr">Replaces all instances of substring a with b in s.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L147" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -426,7 +480,9 @@ returns: ("" "abc" "123" "def")</pre> <pre id="var-usage">Usage: (reverse s) </pre> <pre id="var-docstr">Returns s with its characters reversed.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L142" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -435,7 +491,9 @@ returns: ("" "abc" "123" "def")</pre> <pre id="var-usage">Usage: (rtrim s) </pre> <pre id="var-docstr">Removes whitespace from the right side of string.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L274" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -446,7 +504,9 @@ returns: ("" "abc" "123" "def")</pre> </pre> <pre id="var-docstr">Splits string on a regular expression. Optional argument limit is the maximum number of splits.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L340" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -455,7 +515,9 @@ the maximum number of splits.</pre> <pre id="var-usage">Usage: (split-lines s) </pre> <pre id="var-docstr">Splits s on \n or \r\n.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L279" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -464,7 +526,9 @@ the maximum number of splits.</pre> <pre id="var-usage">Usage: (substring? substring s) </pre> <pre id="var-docstr">True if s contains the substring.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L351" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -476,7 +540,9 @@ the maximum number of splits.</pre> Handles Unicode supplementary characters correctly. Uses the locale-sensitive String.toUpperCase() and String.toLowerCase() methods.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L242" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -485,7 +551,9 @@ methods.</pre> <pre id="var-usage">Usage: (tail n s) </pre> <pre id="var-docstr">Returns the last n characters of s.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L130" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -494,7 +562,9 @@ methods.</pre> <pre id="var-usage">Usage: (take n s) </pre> <pre id="var-docstr">Take first n characters from s, up to the length of s.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L107" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -503,7 +573,9 @@ methods.</pre> <pre id="var-usage">Usage: (trim s) </pre> <pre id="var-docstr">Removes whitespace from both ends of string.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L346" id="var-source">Source</a> + + + </div><div id="var-entry"> <br /> <hr /> @@ -512,7 +584,9 @@ methods.</pre> <pre id="var-usage">Usage: (upper-case s) </pre> <pre id="var-docstr">Converts string to all upper-case.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/bacf49256673242bb7ce09b9f5983c27163e5bfc/src/main/clojure/clojure/contrib/string.clj#L330" id="var-source">Source</a> + + + </div> |