More documentation headers

9 files changed, 61 insertions, 10 deletions

diff --git a/src/clojure/contrib/dataflow.clj b/src/clojure/contrib/dataflow.clj
index a87ef357..b23a7231 100644
--- a/src/clojure/contrib/dataflow.clj
+++ b/src/clojure/contrib/dataflow.clj
@@ -14,7 +14,10 @@
 ;;  Created 10 March 2009
 
 
-(ns clojure.contrib.dataflow
+(ns
+  #^{:author "Jeffrey Straszheim",
+     :doc "A library to support a dataflow model of state"}
+  clojure.contrib.dataflow
   (:use [clojure.set :only (union intersection difference)])
   (:use [clojure.contrib.graph :only (directed-graph
                                       reverse-graph
diff --git a/src/clojure/contrib/datalog.clj b/src/clojure/contrib/datalog.clj
index b72381b7..ebc52cf0 100644
--- a/src/clojure/contrib/datalog.clj
+++ b/src/clojure/contrib/datalog.clj
@@ -17,7 +17,11 @@
 ;;; Please see the example.clj file in the datalog folder
 
 
-(ns clojure.contrib.datalog
+(ns 
+  #^{:author "Jeffrey Straszheim",
+     :doc "A Clojure implementation of Datalog"
+     :see-also ["DatalogOverview"]} 
+  clojure.contrib.datalog
   (:use clojure.contrib.datalog.rules
         clojure.contrib.datalog.softstrat
         clojure.contrib.datalog.database)
diff --git a/src/clojure/contrib/def.clj b/src/clojure/contrib/def.clj
index 9310d367..b7716dc0 100644
--- a/src/clojure/contrib/def.clj
+++ b/src/clojure/contrib/def.clj
@@ -14,7 +14,11 @@
 ;;  scgilardi (gmail)
 ;;  17 May 2008
 
-(ns clojure.contrib.def)
+(ns 
+  #^{:author "Stephen C. Gilardi",
+    :doc "def.clj provides variants of def that make including doc strings and
+making private definitions more succinct."} 
+  clojure.contrib.def)
 
 (defmacro defvar
   "Defines a var with an optional intializer and doc string"
diff --git a/src/clojure/contrib/duck_streams.clj b/src/clojure/contrib/duck_streams.clj
index b9bcfda8..8f57e67d 100644
--- a/src/clojure/contrib/duck_streams.clj
+++ b/src/clojure/contrib/duck_streams.clj
@@ -43,7 +43,19 @@
 
 
 
-(ns clojure.contrib.duck-streams
+(ns 
+  #^{:author "Stuart Sierra",
+     :doc "This file defines \"duck-typed\" I/O utility functions for Clojure.
+           The 'reader' and 'writer' functions will open and return an
+           instance of java.io.BufferedReader and java.io.PrintWriter,
+           respectively, for a variety of argument types -- filenames as
+           strings, URLs, java.io.File's, etc.  'reader' even works on http
+           URLs.
+
+           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."} 
+    clojure.contrib.duck-streams
     (:import 
      (java.io Reader InputStream InputStreamReader PushbackReader
               BufferedReader File PrintWriter OutputStream
diff --git a/src/clojure/contrib/error_kit.clj b/src/clojure/contrib/error_kit.clj
index 3c6df4c9..0d5ea8e5 100644
--- a/src/clojure/contrib/error_kit.clj
+++ b/src/clojure/contrib/error_kit.clj
@@ -11,7 +11,13 @@
 ; Please contact Chouser if you have any suggestions for better names
 ; or API adjustments.
 
-(ns clojure.contrib.error-kit
+(ns 
+  #^{:author "Chris Houser",
+     :doc "EXPERIMENTAL
+System for defining and using custom errors
+Please contact Chouser if you have any suggestions for better names
+or API adjustments."} 
+  clojure.contrib.error-kit
   (:use [clojure.contrib.def :only (defvar defvar-)]
         [clojure.contrib.stacktrace :only (root-cause)]))
 
diff --git a/src/clojure/contrib/except.clj b/src/clojure/contrib/except.clj
index ec180438..df5e9748 100644
--- a/src/clojure/contrib/except.clj
+++ b/src/clojure/contrib/except.clj
@@ -15,7 +15,12 @@
 ;;  scgilardi (gmail)
 ;;  Created 07 July 2008
 
-(ns clojure.contrib.except
+(ns 
+  #^{:author "Stephen C. Gilardi",
+     :doc "Provides functions that make it easy to specify the class and message
+when throwing an Exception or Error. The optional message is formatted
+using clojure/format."} 
+  clojure.contrib.except
   (:import (clojure.lang Reflector)))
 
 (declare throwable)
diff --git a/src/clojure/contrib/fcase.clj b/src/clojure/contrib/fcase.clj
index 7c1aff51..31be58df 100644
--- a/src/clojure/contrib/fcase.clj
+++ b/src/clojure/contrib/fcase.clj
@@ -22,7 +22,17 @@
 ;; inclusion of "condp" in clojure.core as of Clojure SVN rev. 1180.
 
 
-(ns clojure.contrib.fcase)
+(ns 
+  #^{:author "Stuart Sierra",
+     :doc "This file defines a generic \"case\" macro called \"fcase\" which takes
+the equality-testing function as an argument.  It also defines a
+traditional \"case\" macro that tests using \"=\" and variants that
+test for regular expressions and class membership.
+
+
+Note (December 23, 2008): This library has been supplanted by the
+inclusion of \"condp\" in clojure.core as of Clojure SVN rev. 1180."} 
+  clojure.contrib.fcase)
 
 
 (defmacro fcase
diff --git a/src/clojure/contrib/find_namespaces.clj b/src/clojure/contrib/find_namespaces.clj
index 2964d61f..ded33f2a 100644
--- a/src/clojure/contrib/find_namespaces.clj
+++ b/src/clojure/contrib/find_namespaces.clj
@@ -12,7 +12,10 @@
 ;; remove this notice, or any other, from this software.
 
 
-(ns clojure.contrib.find-namespaces
+(ns 
+  #^{:author "Stuart Sierra",
+     :doc "Search for ns declarations in dirs, JARs, or CLASSPATH"} 
+  clojure.contrib.find-namespaces
   (:require [clojure.contrib.classpath :as cp]
             [clojure.contrib.jar :as jar])
   (import (java.io File FileReader BufferedReader PushbackReader
diff --git a/src/clojure/contrib/gen_html_docs.clj b/src/clojure/contrib/gen_html_docs.clj
index 28db5b32..d88a9c77 100644
--- a/src/clojure/contrib/gen_html_docs.clj
+++ b/src/clojure/contrib/gen_html_docs.clj
@@ -41,7 +41,11 @@
 ;; * Add license statement
 ;; * Remove the whojure dependency
 
-(ns clojure.contrib.gen-html-docs
+(ns 
+  #^{:author "Craig Andera",
+     :doc "Generates a single HTML page that contains the documentation for
+one or more Clojure libraries."} 
+  clojure.contrib.gen-html-docs
   (:require [clojure.contrib.duck-streams :as duck-streams])
   (:use [clojure.contrib seq-utils str-utils repl-utils def prxml])
   (:import [java.lang Exception]
@@ -537,4 +541,4 @@ emits the generated HTML to the path named by path."
      'clojure.contrib.test-contrib.str-utils
      'clojure.contrib.zip-filter.xml
      ]))
-  )
\ No newline at end of file
+  )