Beginning to add namespace documentation for all namespaces.

8 files changed, 45 insertions, 8 deletions

diff --git a/src/clojure/contrib/agent_utils.clj b/src/clojure/contrib/agent_utils.clj
index ef377d25..a8c718c6 100644
--- a/src/clojure/contrib/agent_utils.clj
+++ b/src/clojure/contrib/agent_utils.clj
@@ -12,7 +12,12 @@
 
 ;; note to other contrib members: feel free to add to this lib
 
-(ns clojure.contrib.agent-utils)
+(ns
+    #^{:author "Cheistophe Grande",
+       :doc "Miscellaneous agent utilities
+ (note to other contrib members: feel free to add to this lib)",
+}
+  clojure.contrib.agent-utils)
 
 (defmacro capture-and-send
  "Capture the current value of the specified vars and rebind 
diff --git a/src/clojure/contrib/auto_agent.clj b/src/clojure/contrib/auto_agent.clj
index 1d9275a7..0734cc65 100644
--- a/src/clojure/contrib/auto_agent.clj
+++ b/src/clojure/contrib/auto_agent.clj
@@ -26,7 +26,20 @@
 
 
 
-(ns clojure.contrib.auto-agent
+(ns 
+  #^{:author "Stuart Sierra",
+     :doc "This is superficially similar to Ken Tilton's \"Cells\" library for
+Common Lisp.  But Cells is single-threaded and synchronous.  This
+version is built on Clojure agents, so it is multi-threaded and
+asynchronous.
+
+An auto-agent is an agent whose value is the result of an
+expression.  That expression can include other mutable Clojure
+types -- agents, atoms, and refs -- dereferenced with \"deref\" or
+\"@\".  Whenever one of those derefernced things changes, the
+auto-agent will be automatically updated to reflect the new value.
+"}  
+  clojure.contrib.auto-agent
   (:use [clojure.contrib.walk :only (macroexpand-all)]
         [clojure.contrib.test-is :only (deftest- is)]))
 
diff --git a/src/clojure/contrib/classpath.clj b/src/clojure/contrib/classpath.clj
index e78686f5..a5a1a6d3 100644
--- a/src/clojure/contrib/classpath.clj
+++ b/src/clojure/contrib/classpath.clj
@@ -12,7 +12,10 @@
 ;; remove this notice, or any other, from this software.
 
 
-(ns clojure.contrib.classpath
+(ns 
+  #^{:author "Stuart Sierra",
+     :doc "Utilities for dealing with the JVM's classpath"}
+  clojure.contrib.classpath
   (:require [clojure.contrib.jar :as jar])
   (:import (java.io File)
            (java.util.jar JarFile)))
diff --git a/src/clojure/contrib/combinatorics.clj b/src/clojure/contrib/combinatorics.clj
index 35cca059..5b46c235 100644
--- a/src/clojure/contrib/combinatorics.clj
+++ b/src/clojure/contrib/combinatorics.clj
@@ -61,7 +61,11 @@ On my own computer, I use versions of all these algorithms that return sequences
 )

 

 

-(ns clojure.contrib.combinatorics)

+(ns

+  #^{:author "Mark Engelberg",

+     :doc "Efficient, functional algorithms for generating lazy

+sequences for common combinatorial functions. (See the source code for a longer description.)"}

+  clojure.contrib.combinatorics)

 

 (defn- index-combinations

   [n cnt]

diff --git a/src/clojure/contrib/command_line.clj b/src/clojure/contrib/command_line.clj
index a323ee69..96f10ac5 100644
--- a/src/clojure/contrib/command_line.clj
+++ b/src/clojure/contrib/command_line.clj
@@ -8,7 +8,10 @@
 
 ; Process command-line arguments according to a given cmdspec
 
-(ns clojure.contrib.command-line
+(ns 
+    #^{:author "Chris Houser", 
+       :doc "Process command-line arguments according to a given cmdspec"}
+    clojure.contrib.command-line
     (:require (clojure.contrib [seq-utils :as su]))
     (:use     (clojure.contrib [str-utils :only (str-join)])))
 
diff --git a/src/clojure/contrib/cond.clj b/src/clojure/contrib/cond.clj
index 1fd90eb8..0ae8ca06 100644
--- a/src/clojure/contrib/cond.clj
+++ b/src/clojure/contrib/cond.clj
@@ -11,7 +11,9 @@
 ;;  scgilardi (gmail)
 ;;  2 October 2008
 
-(ns clojure.contrib.cond)
+(ns #^{:author "Stephen C. Gilardi"
+       :doc "Extensions to the basic cond function."} 
+  clojure.contrib.cond)
 
 (defmacro cond-let
   "Takes a binding-form and a set of test/expr pairs. Evaluates each test
diff --git a/src/clojure/contrib/condt.clj b/src/clojure/contrib/condt.clj
index 41c421a5..fbd76cc0 100644
--- a/src/clojure/contrib/condt.clj
+++ b/src/clojure/contrib/condt.clj
@@ -22,7 +22,10 @@
 ;; December 15, 2008: original version, named "condp"
 
 
-(ns clojure.contrib.condt
+(ns 
+    #{:author "Stuart Sierra"
+      :doc "Generic case-like macro using template expressions"}
+    clojure.contrib.condt
     (:require clojure.contrib.template))
 
 (defmacro condt
diff --git a/src/clojure/contrib/core.clj b/src/clojure/contrib/core.clj
index 6ce8c6e0..e5fe7c78 100644
--- a/src/clojure/contrib/core.clj
+++ b/src/clojure/contrib/core.clj
@@ -12,7 +12,11 @@
 
 ;; note to other contrib members: feel free to add to this lib
 
-(ns clojure.contrib.core
+(ns
+  #^{:author "Laurent Petit (and others)"
+     :doc "Functions/macros variants of the ones that can be found in clojure.core 
+ (note to other contrib members: feel free to add to this lib)"}
+  clojure.contrib.core
   (:use clojure.contrib.def))
 
 (defmacro- defnilsafe [docstring non-safe-name nil-safe-name]