[clojure-contrib commit] r926 - Auto-documentation for contrib version r925

[codesite...@google.com]

Author: tomfaulhaber
Date: Tue Jun 9 10:55:43 2009
New Revision: 926

Modified:
wiki/ApiDocIndex.json
wiki/ApiDocIndex.wiki
wiki/HttpAgentApiDoc.wiki
wiki/OverviewOfContrib.wiki

Log:
Auto-documentation for contrib version r925

Modified: wiki/ApiDocIndex.json
==============================================================================
--- wiki/ApiDocIndex.json (original)
+++ wiki/ApiDocIndex.json Tue Jun 9 10:55:43 2009
@@ -2835,6 +2835,24 @@
"doc":
"Return the argument for which f yields the smallest value."},
{"source-url":
+ "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/http/agent.clj#51",
+ "wiki-url":
+ "http://code.google.com/p/clojure-contrib/wiki/ClojureContribHttpAgentApiDoc#http-agent",
+ "namespace":"clojure.contrib.http.agent",
+ "name":"http-agent",
+ "arglists":[["url", "&", "options"]],
+ "doc":
+ "Creates (and immediately returns) an Agent representing an HTTP\n
request running in a new thread.\n\n options are key/value
pairs:\n\n :method string\n\n The HTTP method name. Default is
\"GET\".\n\n :headers h\n\n HTTP headers, as a Map or a sequence of pairs
like \n ([key1,value1], [key2,value2]) Default is nil.\n\n :body b\n
\n HTTP request entity body, one of nil, String, byte[], InputStream,\n
Reader, or File. Default is nil.\n\n :connect-timeout int\n\n Timeout
value, in milliseconds, when opening a connection to the\n URL. Default
is zero, meaning no timeout.\n\n :read-timeout int\n\n Timeout value, in
milliseconds, when reading data from the\n connection. Default is zero,
meaning no timeout.\n\n :follow-redirects boolean\n\n If true, HTTP 3xx
redirects will be followed automatically. Default\n is true.\n "},
+ {"source-url":
+ "http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/http/agent.clj#114",
+ "wiki-url":
+ "http://code.google.com/p/clojure-contrib/wiki/ClojureContribHttpAgentApiDoc#response-headers-seq",
+ "namespace":"clojure.contrib.http.agent",
+ "name":"response-headers-seq",
+ "arglists":[["http-agnt"]],
+ "doc":
+ "Returns the HTTP response headers in order as a sequence of\n
[String,String] pairs. The first 'header' name may be null for the\n HTTP
status line."},
+ {"source-url":
"http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/http/connection.clj#21",
"wiki-url":
"http://code.google.com/p/clojure-contrib/wiki/ClojureContribHttpConnectionApiDoc#http-connection",

Modified: wiki/ApiDocIndex.wiki
==============================================================================
--- wiki/ApiDocIndex.wiki (original)
+++ wiki/ApiDocIndex.wiki Tue Jun 9 10:55:43 2009
@@ -332,6 +332,7 @@
[PprintApiDoc#*_html-compatible_* *html-compatible*]
var pprint.examples.xml If true, empty tags will have a space
before the ...
[PrxmlApiDoc#*_html-compatible_* *html-compatible*]
var prxml If true, empty tags will have a space
before the c...
[ErrorKitApiDoc#handle handle] function
error-kit Special form to be used inside a 'with-handler'. ...
+[HttpAgentApiDoc#http-agent http-agent] function
http.agent Creates (and immediately returns) an Agent represe...
[HttpConnectionApiDoc#http-connection http-connection]
function http.connection Opens an HttpURLConnection at the URL,
handled by ...
</pre>
==I==
@@ -565,6 +566,7 @@
[StrUtils2ApiDoc#replace-first replace-first] multimethod
str-utils2 Replaces the first instance of pattern in s with r...
[DatalogApiDoc#replace-relation replace-relation]
function datalog.database Add or replace a fully constructed relation
object...
[TestIsApiDoc#report report] multimethod
test-is Generic reporting function, may be overridden to p...
+[HttpAgentApiDoc#response-headers-seq response-headers-seq]
function http.agent Returns the HTTP response headers in order
as a se...
[DatalogApiDoc#return-rule-data return-rule-data]
function datalog.rules Returns an untypted rule that will be fully
printe...
[GraphApiDoc#reverse-graph reverse-graph] function
graph Given a directed graph, return another directed gr...
[DatalogApiDoc#reverse-map reverse-map] function
datalog.util Reverse the keys/values of a map.

Modified: wiki/HttpAgentApiDoc.wiki
==============================================================================
--- wiki/HttpAgentApiDoc.wiki (original)
+++ wiki/HttpAgentApiDoc.wiki Tue Jun 9 10:55:43 2009
@@ -19,3 +19,59 @@

==Public Variables and Functions==
+Shortcuts:
+[#http-agent http-agent] [#response-headers-seq response-headers-seq]
+
+----
+===http-agent===
+====function====
+<pre>
+Usage: *(_http-agent_ url & options)*
+</pre>
+<pre> Creates (and immediately returns) an Agent representing an HTTP
+request running in a new thread.
+
+options are key/value pairs:
+
+:method string
+
+The HTTP method name. Default is "GET".
+
+:headers h
+
+HTTP headers, as a Map or a sequence of pairs like
+(`[`key1,value1`]`, `[`key2,value2`]`) Default is nil.
+
+:body b
+
+HTTP request entity body, one of nil, String, byte`[``]`, InputStream,
+Reader, or File. Default is nil.
+
+:connect-timeout int
+
+Timeout value, in milliseconds, when opening a connection to the
+URL. Default is zero, meaning no timeout.
+
+:read-timeout int
+
+Timeout value, in milliseconds, when reading data from the
+connection. Default is zero, meaning no timeout.
+
+:follow-redirects boolean
+
+If true, HTTP 3xx redirects will be followed automatically. Default
+is true.
+</pre>
+
+[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/http/agent.clj#51
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=http-agent+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]
+----
+===response-headers-seq===
+====function====
+<pre>
+Usage: *(_response-headers-seq_ http-agnt)*
+</pre>
+<pre> Returns the HTTP response headers in order as a sequence of
+`[`String,String`]` pairs. The first 'header' name may be null for the
+HTTP status line.</pre>
+
+[http://code.google.com/p/clojure-contrib/source/browse/trunk/src/clojure/contrib/http/agent.clj#114
Source]
[http://www.google.com/codesearch?hl=en&lr=&q=response-headers-seq+package%3Ahttp%3A%2F%2Fclojure-contrib\.googlecode\.com&sbtn=Search
Search
for references in contrib]

Modified: wiki/OverviewOfContrib.wiki
==============================================================================
--- wiki/OverviewOfContrib.wiki (original)
+++ wiki/OverviewOfContrib.wiki Tue Jun 9 10:55:43 2009
@@ -343,6 +343,9 @@
API Overview [HttpAgentApiDoc here]

<pre> Agent-based asynchronous HTTP client.</pre>
+Public Variables and Functions:
+[HttpAgentApiDoc#http-agent http-agent]
[HttpAgentApiDoc#response-headers-seq response-headers-seq]
+
----
===http.connection===
API Overview [HttpConnectionApiDoc here]