summaryrefslogtreecommitdiff
path: root/repl-utils-api.html
diff options
context:
space:
mode:
authorTom Faulhaber <git_net@infolace.com>2010-04-30 16:19:00 -0700
committerTom Faulhaber <git_net@infolace.com>2010-04-30 16:19:00 -0700
commit4a3f270f93c687ec29f9cdd178f22b9fd3d82e37 (patch)
treecbe8efecfd3a0aab290cb6b7c2eec2135385d52a /repl-utils-api.html
parentae92eda353beed7ff5ee07ea80491d7c7bca110c (diff)
Manual autodoc update (mostly whitespace diffs caused by new tags, not yet used).
Diffstat (limited to 'repl-utils-api.html')
-rw-r--r--repl-utils-api.html54
1 files changed, 44 insertions, 10 deletions
diff --git a/repl-utils-api.html b/repl-utils-api.html
index 704ff26c..70497adb 100644
--- a/repl-utils-api.html
+++ b/repl-utils-api.html
@@ -100,6 +100,8 @@ by <span id="author">Chris Houser, Christophe Grand, Stephen Gilardi, Michel Sal
</pre><pre>
</pre><h2>Overview</h2>
<pre id="namespace-docstr">Utilities meant to be used interactively at the REPL</pre>
+
+
<br />
<h2>Public Variables and Functions</h2>
<div id="var-entry">
@@ -110,6 +112,8 @@ by <span id="author">Chris Houser, Christophe Grand, Stephen Gilardi, Michel Sal
<pre id="var-usage"></pre>
<pre id="var-docstr">Ref to a list of local paths for Javadoc-generated HTML
files.</pre>
+
+
<a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/repl_utils/javadoc.clj#L18" id="var-source">Source</a>
</div><div id="var-entry">
<br />
@@ -119,6 +123,8 @@ files.</pre>
<pre id="var-usage"></pre>
<pre id="var-docstr">Ref to a map from package name prefixes to URLs for remote
Javadocs.</pre>
+
+
<a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/repl_utils/javadoc.clj#L28" id="var-source">Source</a>
</div><div id="var-entry">
<br />
@@ -131,7 +137,9 @@ Javadocs.</pre>
<pre id="var-docstr">Add the given thread to break-threads so that it will be stopped
any time the user presses Ctrl-C. Calls start-handling-break for
you. Adds the current thread if none is given.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/4f9a78d13217a8de4c29221d74aca0a67cec8c1a/src/main/clojure/clojure/contrib/repl_utils.clj#L162" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -140,6 +148,8 @@ you. Adds the current thread if none is given.</pre>
<pre id="var-usage">Usage: (add-local-javadoc path)
</pre>
<pre id="var-docstr">Adds to the list of local Javadoc paths.</pre>
+
+
<a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/repl_utils/javadoc.clj#L43" id="var-source">Source</a>
</div><div id="var-entry">
<br />
@@ -150,6 +160,8 @@ you. Adds the current thread if none is given.</pre>
</pre>
<pre id="var-docstr">Adds to the list of remote Javadoc URLs. package-prefix is the
beginning of the package name that has docs at this URL.</pre>
+
+
<a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/repl_utils/javadoc.clj#L48" id="var-source">Source</a>
</div><div id="var-entry">
<br />
@@ -161,7 +173,9 @@ beginning of the package name that has docs at this URL.</pre>
<pre id="var-docstr">Given a regular expression or stringable thing, return a seq of
all definitions in all currently-loaded namespaces that match the
str-or-pattern.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/4f9a78d13217a8de4c29221d74aca0a67cec8c1a/src/main/clojure/clojure/contrib/repl_utils.clj#L128" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -169,7 +183,9 @@ str-or-pattern.</pre>
<span id="var-type">var</span><br />
<pre id="var-usage"></pre>
<pre id="var-docstr">Threads to stop when Ctrl-C is pressed. See 'add-break-thread!'</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/4f9a78d13217a8de4c29221d74aca0a67cec8c1a/src/main/clojure/clojure/contrib/repl_utils.clj#L143" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -184,7 +200,9 @@ not type info can be determined at compile-time.
Example: (expression-info '(+ (int 5) (float 10)))
Returns: {:class float, :primitive? true}</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/4f9a78d13217a8de4c29221d74aca0a67cec8c1a/src/main/clojure/clojure/contrib/repl_utils.clj#L175" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -194,6 +212,8 @@ Returns: {:class float, :primitive? true}</pre>
</pre>
<pre id="var-docstr">Searches for a URL for the given class name. Tries
*local-javadocs* first, then *remote-javadocs*. Returns a string.</pre>
+
+
<a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/repl_utils/javadoc.clj#L54" id="var-source">Source</a>
</div><div id="var-entry">
<br />
@@ -209,7 +229,9 @@ it can't find the source. For most REPL usage, 'source' is more
convenient.
Example: (get-source 'filter)</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/4f9a78d13217a8de4c29221d74aca0a67cec8c1a/src/main/clojure/clojure/contrib/repl_utils.clj#L97" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -219,6 +241,8 @@ Example: (get-source 'filter)</pre>
</pre>
<pre id="var-docstr">Opens a browser window displaying the javadoc for the argument.
Tries *local-javadocs* first, then *remote-javadocs*.</pre>
+
+
<a href="http://github.com/richhickey/clojure-contrib/blob/2ede388a9267d175bfaa7781ee9d57532eb4f20f/src/main/clojure/clojure/contrib/repl_utils/javadoc.clj#L74" id="var-source">Source</a>
</div><div id="var-entry">
<br />
@@ -229,7 +253,9 @@ Tries *local-javadocs* first, then *remote-javadocs*.</pre>
</pre>
<pre id="var-docstr">Loads the specified namespace and invokes its "main" function with
optional args. ns-name is not evaluated.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/4f9a78d13217a8de4c29221d74aca0a67cec8c1a/src/main/clojure/clojure/contrib/repl_utils.clj#L200" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -239,7 +265,9 @@ optional args. ns-name is not evaluated.</pre>
</pre>
<pre id="var-docstr">Loads the specified namespace and invokes its "main" function with
optional args.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/4f9a78d13217a8de4c29221d74aca0a67cec8c1a/src/main/clojure/clojure/contrib/repl_utils.clj#L193" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -264,7 +292,9 @@ predicate will be passed a single argument, a map that includes the
all the properies of the member object as translated by 'bean'.
Examples: (show Integer) (show []) (show String 23) (show String "case")</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/4f9a78d13217a8de4c29221d74aca0a67cec8c1a/src/main/clojure/clojure/contrib/repl_utils.clj#L59" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -277,7 +307,9 @@ This requires that the symbol resolve to a Var defined in a
namespace for which the .clj is in the classpath.
Example: (source filter)</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/4f9a78d13217a8de4c29221d74aca0a67cec8c1a/src/main/clojure/clojure/contrib/repl_utils.clj#L119" id="var-source">Source</a>
+
+
+
</div><div id="var-entry">
<br />
<hr />
@@ -287,7 +319,9 @@ Example: (source filter)</pre>
</pre>
<pre id="var-docstr">Register INT signal handler. After calling this, Ctrl-C will cause
all break-threads to be stopped. See 'add-break-thread!'</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/4f9a78d13217a8de4c29221d74aca0a67cec8c1a/src/main/clojure/clojure/contrib/repl_utils.clj#L147" id="var-source">Source</a>
+
+
+
</div>