From 520f8c8796fb80c08d4800a24e5f92dd3c05b63f Mon Sep 17 00:00:00 2001 From: Tom Faulhaber Date: Fri, 23 Jul 2010 08:03:28 -0700 Subject: Autodoc commit for master/f827ea5f, 1.1.x/d132c5f1 --- apply-macro-api.html | 4 +-- duck-streams-api.html | 42 ++++++++++++++-------------- http.agent-api.html | 42 ++++++++++++++-------------- http.connection-api.html | 6 ++-- index.html | 17 ++++++++---- io-api.html | 72 ++++++++++++++++++++++++------------------------ java-utils-api.html | 57 +++++++++++++++++++++----------------- 7 files changed, 127 insertions(+), 113 deletions(-) diff --git a/apply-macro-api.html b/apply-macro-api.html index 31e0377d..ff33505f 100644 --- a/apply-macro-api.html +++ b/apply-macro-api.html @@ -71,7 +71,7 @@ namespace.

Overview


 
-
+Deprecated since clojure-contrib version 1.2

 

 
Public Variables and Functions

 

@@ -92,7 +92,7 @@ apply.
 ;; Expands to:  (and true true false)
   
   
-  Source
+  Source
 

 
 
diff --git a/duck-streams-api.html b/duck-streams-api.html
index 2fe15ae8..22c914d1 100644
--- a/duck-streams-api.html
+++ b/duck-streams-api.html
@@ -118,7 +118,7 @@ Note: this is not really "duck typing" as implemented in languages
 like Ruby.  A better name would have been "do-what-I-mean-streams"
 or "just-give-me-a-stream", but ducks are funnier.
 
-
+Deprecated since clojure-contrib version 1.2

 

 
Public Variables and Functions

 

@@ -131,7 +131,7 @@ or "just-give-me-a-stream", but ducks are funnier.
 Defaults to false.  Use append-writer or append-spit.
   
   
-  Source
+  Source
 

   

   

@@ -142,7 +142,7 @@ Defaults to false.  Use append-writer or append-spit.
 copying streams.
   
   
-  Source
+  Source
 

   

   

@@ -152,7 +152,7 @@ copying streams.
   
Type object for a Java primitive byte array.

   
   
-  Source
+  Source
 

   

   

@@ -163,7 +163,7 @@ copying streams.
 Default is UTF-8.
   
   
-  Source
+  Source
 

   

   

@@ -174,7 +174,7 @@ Default is UTF-8.
   
Like spit but appends to file.

   
   
-  Source
+  Source
 

   

   

@@ -186,7 +186,7 @@ Default is UTF-8.
 that are already open.
   
   
-  Source
+  Source
 

   

   

@@ -204,7 +204,7 @@ Does not close any streams except those it opens itself
 Writing a File fails if the parent directory does not exist.
   
   
-  Source
+  Source
 

   

   

@@ -217,7 +217,7 @@ all / and \ with File/separatorChar.  Replaces ~ at the start of
 the path with the user.home system property.
   
   
-  Source
+  Source
 

   

   

@@ -228,7 +228,7 @@ the path with the user.home system property.
   
Creates all parent directories of file.

   
   
-  Source
+  Source
 

   

   

@@ -240,7 +240,7 @@ the path with the user.home system property.
 Note: In Java, you cannot change the current working directory.
   
   
-  Source
+  Source
 

   

   

@@ -252,7 +252,7 @@ Note: In Java, you cannot change the current working directory.
 closes the reader AFTER YOU CONSUME THE ENTIRE SEQUENCE.
   
   
-  Source
+  Source
 

   

   

@@ -272,7 +272,7 @@ Should be used inside with-open to ensure the Reader is properly
 closed.
   
   
-  Source
+  Source
 

   

   

@@ -283,7 +283,7 @@ closed.
   
Like clojure.core/slurp but opens f with reader.

   
   
-  Source
+  Source
 

   

   

@@ -295,7 +295,7 @@ closed.
 closes f.
   
   
-  Source
+  Source
 

   

   

@@ -308,7 +308,7 @@ a String, File, InputStream, or Reader.  If the argument is already
 a byte array, returns it.
   
   
-  Source
+  Source
 

   

   

@@ -319,7 +319,7 @@ a byte array, returns it.
   
Opens a PushbackReader on f, binds it to *in*, and evaluates body.

   
   
-  Source
+  Source
 

   

   

@@ -330,7 +330,7 @@ a byte array, returns it.
   
Like with-out-writer but appends to file.

   
   
-  Source
+  Source
 

   

   

@@ -342,7 +342,7 @@ a byte array, returns it.
 Anything printed within body will be written to f.
   
   
-  Source
+  Source
 

   

   

@@ -354,7 +354,7 @@ Anything printed within body will be written to f.
 writer, and automatically closed at the end of the sequence.
   
   
-  Source
+  Source
 

   

   

@@ -375,7 +375,7 @@ Should be used inside with-open to ensure the Writer is properly
 closed.
   
   
-  Source
+  Source
 

 
 
diff --git a/http.agent-api.html b/http.agent-api.html
index da59888a..886b628e 100644
--- a/http.agent-api.html
+++ b/http.agent-api.html
@@ -154,7 +154,7 @@ And you could write the response directly to a file like this:
                          (with-open [w (d/writer "/tmp/out")] 
                            (d/copy (stream agnt) w))))
 
-
+Deprecated since clojure-contrib version 1.2

 

 
Public Variables and Functions

 

@@ -169,7 +169,7 @@ body in a java.io.ByteArrayOutputStream, which can later be
 retrieved with the 'stream', 'string', and 'bytes' functions.
   
   
-  Source
+  Source
 

   

   

@@ -181,7 +181,7 @@ retrieved with the 'stream', 'string', and 'bytes' functions.
 nil if the content is not yet available.
   
   
-  Source
+  Source
 

   

   

@@ -192,7 +192,7 @@ nil if the content is not yet available.
   
Returns true if the HTTP response code was in the 400-499 range.

   
   
-  Source
+  Source
 

   

   

@@ -203,7 +203,7 @@ nil if the content is not yet available.
   
Returns true if the HTTP request/response has completed.

   
   
-  Source
+  Source
 

   

   

@@ -215,7 +215,7 @@ nil if the content is not yet available.
 the 500-599 range.
   
   
-  Source
+  Source
 

   

   

@@ -228,7 +228,7 @@ to keywords in all lower-case Header values are strings.  If a
 header appears more than once, only the last value is returned.
   
   
-  Source
+  Source
 

   

   

@@ -241,7 +241,7 @@ header appears more than once, only the last value is returned.
 HTTP status line.
   
   
-  Source
+  Source
 

   

   

@@ -299,7 +299,7 @@ response stream in a memory buffer.
 
   
   
-  Source
+  Source
 

   

   

@@ -311,7 +311,7 @@ response stream in a memory buffer.
 request, or nil if the response has not yet been received.
   
   
-  Source
+  Source
 

   

   

@@ -322,7 +322,7 @@ request, or nil if the response has not yet been received.
   
Returns the HTTP method name used by this HTTP agent, as a String.

   
   
-  Source
+  Source
 

   

   

@@ -337,7 +337,7 @@ redirects will be followed automatically and a the agent will never
 return a 3xx response code.
   
   
-  Source
+  Source
 

   

   

@@ -351,7 +351,7 @@ Note: if the request body was an InputStream or a Reader, it will no
 longer be usable.
   
   
-  Source
+  Source
 

   

   

@@ -362,7 +362,7 @@ longer be usable.
   
Returns the request headers specified for this HTTP agent.

   
   
-  Source
+  Source
 

   

   

@@ -373,7 +373,7 @@ longer be usable.
   
Returns the URI/URL requested by this HTTP agent, as a String.

   
   
-  Source
+  Source
 

   

   

@@ -386,7 +386,7 @@ agent; blocks until the HTTP request is completed.  The default
 handler function returns a ByteArrayOutputStream.
   
   
-  Source
+  Source
 

   

   

@@ -397,7 +397,7 @@ handler function returns a ByteArrayOutputStream.
   
Returns true if the HTTP response code was in the 500-599 range.

   
   
-  Source
+  Source
 

   

   

@@ -410,7 +410,7 @@ request, as an Integer, or nil if the status has not yet been
 received.
   
   
-  Source
+  Source
 

   

   

@@ -426,7 +426,7 @@ If the default handler function was used, this function returns a
 ByteArrayInputStream on the buffered response body.
   
   
-  Source
+  Source
 

   

   

@@ -443,7 +443,7 @@ headers, or clojure.contrib.io/*default-encoding* if it is
 not specified.
   
   
-  Source
+  Source
 

   

   

@@ -454,7 +454,7 @@ not specified.
   
Returns true if the HTTP response code was in the 200-299 range.

   
   
-  Source
+  Source
 

 
 
diff --git a/http.connection-api.html b/http.connection-api.html
index b59838af..f25651b6 100644
--- a/http.connection-api.html
+++ b/http.connection-api.html
@@ -73,7 +73,7 @@ namespace.
 
Overview

 
Low-level HTTP client API around HttpURLConnection

 
-
+Deprecated since clojure-contrib version 1.2

 

 
Public Variables and Functions

 

@@ -86,7 +86,7 @@ namespace.
   
Opens an HttpURLConnection at the URL, handled by as-url.

   
   
-  Source
+  Source
 

   

   

@@ -96,7 +96,7 @@ namespace.
   
Transmits a request entity body.

   
   
-  Source
+  Source
 

 
 
diff --git a/index.html b/index.html
index 450f5a79..4b453cb5 100644
--- a/index.html
+++ b/index.html
@@ -484,7 +484,7 @@ accumulators.
   Detailed API documentation

   

   
-  
+  Deprecated since clojure-contrib version 1.2

   
   Public variables and functions:
   apply-macro 

@@ -850,7 +850,7 @@ Note: this is not really "duck typing" as implemented in languages
 like Ruby.  A better name would have been "do-what-I-mean-streams"
 or "just-give-me-a-stream", but ducks are funnier.
   
-  
+  Deprecated since clojure-contrib version 1.2

   
   Public variables and functions:
   *append-to-writer* *buffer-size* *byte-array-type* *default-encoding* append-spit append-writer copy file-str make-parents pwd read-lines reader slurp* spit to-byte-array with-in-reader with-out-append-writer with-out-writer write-lines writer 

@@ -1107,7 +1107,7 @@ And you could write the response directly to a file like this:
                          (with-open [w (d/writer "/tmp/out")] 
                            (d/copy (stream agnt) w))))
   
-  
+  Deprecated since clojure-contrib version 1.2

   
   Public variables and functions:
   buffer-bytes bytes client-error? done? error? headers headers-seq http-agent message method redirect? request-body request-headers request-uri result server-error? status stream string success? 

@@ -1120,7 +1120,7 @@ And you could write the response directly to a file like this:
   Detailed API documentation

   
Low-level HTTP client API around HttpURLConnection

   
-  
+  Deprecated since clojure-contrib version 1.2

   
   Public variables and functions:
   http-connection send-request-entity 

@@ -1194,7 +1194,14 @@ Design goals:
 Feedback welcome!
 
 If something in this module violates the principle of least surprise, please 
-let me (Stu) and the Clojure community know via the mailing list.
+let me (Stu) and the Clojure community know via the mailing list.
+Contributors:
+
+Stuart Halloway
+Stephen C. Gilardi
+Shawn Hoover
+Perry Trolard
+Stuart Sierra
   
   
   
diff --git a/io-api.html b/io-api.html
index b10f80af..6ef6dd72 100644
--- a/io-api.html
+++ b/io-api.html
@@ -147,7 +147,7 @@ Defaults to false.  Instead of binding this var directly, use append-writer,
 append-output-stream or append-spit.
   
   
-  Source
+  Source
 

   

   

@@ -158,7 +158,7 @@ append-output-stream or append-spit.
 copying streams.
   
   
-  Source
+  Source
 

   

   

@@ -168,7 +168,7 @@ copying streams.
   
Type object for a Java primitive byte array.

   
   
-  Source
+  Source
 

   

   

@@ -178,7 +178,7 @@ copying streams.
   
Type object for a Java primitive char array.

   
   
-  Source
+  Source
 

   

   

@@ -189,7 +189,7 @@ copying streams.
 Default is UTF-8.
   
   
-  Source
+  Source
 

   

   

@@ -200,8 +200,8 @@ Default is UTF-8.
   
Like output-stream but opens file for appending.  Does not work on streams
 that are already open.

   
-  
-  Source
+  Deprecated since clojure-contrib version 1.2

+  Source
 

   

   

@@ -211,8 +211,8 @@ that are already open.
 
   
Like spit but appends to file.

   
-  
-  Source
+  Deprecated since clojure-contrib version 1.2

+  Source
 

   

   

@@ -223,8 +223,8 @@ that are already open.
   
Like writer but opens file for appending.  Does not work on streams
 that are already open.

   
-  
-  Source
+  Deprecated since clojure-contrib version 1.2

+  Source
 

   

   

@@ -234,8 +234,8 @@ that are already open.
 
   
Coerces argument (URL, URI, or String) to a java.net.URL.

   
-  
-  Source
+  Deprecated since clojure-contrib version 1.2

+  Source
 

   

   

@@ -252,8 +252,8 @@ Does not close any streams except those it opens itself
 
 Writing a File fails if the parent directory does not exist.
   
-  
-  Source
+  Deprecated since clojure-contrib version 1.2

+  Source
 

   

   

@@ -264,7 +264,7 @@ Writing a File fails if the parent directory does not exist.
   
Delete file f. Raise an exception if it fails unless silently is true.

   
   
-  Source
+  Source
 

   

   

@@ -276,7 +276,7 @@ Writing a File fails if the parent directory does not exist.
 Raise an exception if any deletion fails unless silently is true.
   
   
-  Source
+  Source
 

   

   

@@ -288,8 +288,8 @@ Raise an exception if any deletion fails unless silently is true.
 
   
Returns a java.io.File from string or file args.

   
-  
-  Source
+  Deprecated since clojure-contrib version 1.2

+  Source
 

   

   

@@ -302,7 +302,7 @@ all / and \ with File/separatorChar.  Replaces ~ at the start of
 the path with the user.home system property.
   
   
-  Source
+  Source
 

   

   

@@ -336,7 +336,7 @@ closed.
   
Creates all parent directories of file.

   
   
-  Source
+  Source
 

   

   

@@ -370,8 +370,8 @@ properly closed.
   
Returns current working directory as a String.  (Like UNIX 'pwd'.)
 Note: In Java, you cannot change the current working directory.

   
-  
-  Source
+  Deprecated since clojure-contrib version 1.2

+  Source
 

   

   

@@ -383,7 +383,7 @@ Note: In Java, you cannot change the current working directory.
 closes the reader AFTER YOU CONSUME THE ENTIRE SEQUENCE.
   
   
-  Source
+  Source
 

   

   

@@ -420,8 +420,8 @@ closed.
   
Interpret a String or java.io.File as a relative path string. 
 Building block for clojure.contrib.java/file.

   
-  
-  Source
+  Deprecated since clojure-contrib version 1.2

+  Source
 

   

   

@@ -431,8 +431,8 @@ Building block for clojure.contrib.java/file.
 
   
Like clojure.core/slurp but opens f with reader.

   
-  
-  Source
+  Deprecated since clojure-contrib version 1.2

+  Source
 

   

   

@@ -443,8 +443,8 @@ Building block for clojure.contrib.java/file.
   
Opposite of slurp.  Opens f with writer, writes content, then
 closes f.

   
-  
-  Source
+  Deprecated since clojure-contrib version 1.2

+  Source
 

   

   

@@ -457,7 +457,7 @@ a String, File, InputStream, or Reader.  If the argument is already
 a byte array, returns it.
   
   
-  Source
+  Source
 

   

   

@@ -468,7 +468,7 @@ a byte array, returns it.
   
Opens a PushbackReader on f, binds it to *in*, and evaluates body.

   
   
-  Source
+  Source
 

   

   

@@ -478,8 +478,8 @@ a byte array, returns it.
 
   
Like with-out-writer but appends to file.

   
-  
-  Source
+  Deprecated since clojure-contrib version 1.2

+  Source
 

   

   

@@ -491,7 +491,7 @@ a byte array, returns it.
 Anything printed within body will be written to f.
   
   
-  Source
+  Source
 

   

   

@@ -503,7 +503,7 @@ Anything printed within body will be written to f.
 writer, and automatically closed at the end of the sequence.
   
   
-  Source
+  Source
 

   

   

diff --git a/java-utils-api.html b/java-utils-api.html
index 13c94e87..ce6f4464 100644
--- a/java-utils-api.html
+++ b/java-utils-api.html
@@ -115,7 +115,14 @@ Design goals:
 Feedback welcome!
 
 If something in this module violates the principle of least surprise, please 
-let me (Stu) and the Clojure community know via the mailing list.
+let me (Stu) and the Clojure community know via the mailing list.
+Contributors:
+
+Stuart Halloway
+Stephen C. Gilardi
+Shawn Hoover
+Perry Trolard
+Stuart Sierra
 
 
 

@@ -130,8 +137,8 @@ let me (Stu) and the Clojure community know via the mailing list.
 for clojure.contrib.java-utils/file, which you should prefer
 in most cases.
   
-  
-  Source
+  Deprecated since clojure-contrib version 1.2

+  Source
 

   

   

@@ -143,7 +150,7 @@ in most cases.
 Uses as-str to convert both keys and values into strings.
   
   
-  Source
+  Source
 

   

   

@@ -167,8 +174,8 @@ Example:
    (str {:foo :bar})     ;;=> "{:foo :bar}"
    (as-str {:foo :bar})  ;;=> "{:foo :bar}" 
   
-  
-  Source
+  Deprecated since clojure-contrib version 1.2

+  Source
 

   

   

@@ -178,8 +185,8 @@ Example:
 
   
Coerces argument (URL, URI, or String) to a java.net.URL.

   
-  
-  Source
+  Deprecated since clojure-contrib version 1.2

+  Source
 

   

   

@@ -189,8 +196,8 @@ Example:
 
   
Delete file f. Raise an exception if it fails unless silently is true.

   
-  
-  Source
+  Deprecated since clojure-contrib version 1.2

+  Source
 

   

   

@@ -201,8 +208,8 @@ Example:
   
Delete file f. If it's a directory, recursively delete all its contents.
 Raise an exception if any deletion fails unless silently is true.

   
-  
-  Source
+  Deprecated since clojure-contrib version 1.2

+  Source
 

   

   

@@ -214,8 +221,8 @@ Raise an exception if any deletion fails unless silently is true.
 
   
Returns a java.io.File from string or file args.

   
-  
-  Source
+  Deprecated since clojure-contrib version 1.2

+  Source
 

   

   

@@ -227,7 +234,7 @@ Raise an exception if any deletion fails unless silently is true.
   
Get a system property.

   
   
-  Source
+  Source
 

   

   

@@ -238,7 +245,7 @@ Raise an exception if any deletion fails unless silently is true.
   
Read properties from file-able.

   
   
-  Source
+  Source
 

   

   

@@ -248,8 +255,8 @@ Raise an exception if any deletion fails unless silently is true.
   
Interpret a String or java.io.File as a relative path string. 
 Building block for clojure.contrib.java-utils/file.

   
-  
-  Source
+  Deprecated since clojure-contrib version 1.2

+  Source
 

   

   

@@ -260,7 +267,7 @@ Building block for clojure.contrib.java-utils/file.
   
Set some system properties. Nil clears a property.

   
   
-  Source
+  Source
 

   

   

@@ -270,8 +277,8 @@ Building block for clojure.contrib.java-utils/file.
 
   
Access to private or protected field.

   
-  
-  Source
+  Deprecated since clojure-contrib version 1.2

+  Source
 

   

   

@@ -284,8 +291,8 @@ params is a vector of class which correspond to the arguments to the method
 obj is nil for static methods, the instance object otherwise
 the method name is given as a symbol or a keyword (something Named)
   
-  
-  Source
+  Deprecated since clojure-contrib version 1.2

+  Source
 

   

   

@@ -300,7 +307,7 @@ sets the properties back to their original values. Values of nil are
 translated to a clearing of the property.
   
   
-  Source
+  Source
 

   

   

@@ -312,7 +319,7 @@ translated to a clearing of the property.
   
Write properties to file-able.

   
   
-  Source
+  Source
 

 
 
-- 
cgit v1.2.3-18-g5258