Skip to content

Commit

Permalink
Rearranged namespace comments into docstrings and added missing licen…
Browse files Browse the repository at this point in the history
…se notices.

Signed-off-by: James Reeves <jreeves@weavejester.com>
  • Loading branch information
budu authored and weavejester committed May 16, 2009
1 parent 90344b8 commit ab9905d
Show file tree
Hide file tree
Showing 24 changed files with 55 additions and 97 deletions.
9 changes: 3 additions & 6 deletions src/compojure.clj
Expand Up @@ -6,13 +6,10 @@
;; terms of this license. You must not remove this notice, or any other, from
;; this software.

;; compojure:
;;
;; Convenience library that includes every compojure.* namespace. If you want
;; to access Compojure quickly, and don't care about having everything in one
;; namespace, just use or require 'compojure.

(ns compojure
"Convenience library that includes every compojure.* namespace. If you want
to access Compojure quickly, and don't care about having everything in one
namespace, just use or require 'compojure."
(:use compojure.ns-utils))

(immigrate
Expand Down
5 changes: 1 addition & 4 deletions src/compojure/control.clj
Expand Up @@ -6,11 +6,8 @@
;; terms of this license. You must not remove this notice, or any other, from
;; this software.

;; compojure.control:
;;
;; Various macros for controling program flow.

(ns compojure.control
"Various macros for controling program flow."
(:use clojure.contrib.seq-utils))

(defmacro return
Expand Down
5 changes: 1 addition & 4 deletions src/compojure/crypto.clj
Expand Up @@ -6,11 +6,8 @@
;; terms of this license. You must not remove this notice, or any other, from
;; this software.

;; compojure.crypto:
;;
;; Functions for cryptographically signing, verifying and encrypting data.

(ns compojure.crypto
"Functions for cryptographically signing, verifying and encrypting data."
(:use compojure.encodings)
(:import javax.crypto.Mac)
(:import javax.crypto.spec.SecretKeySpec)
Expand Down
5 changes: 1 addition & 4 deletions src/compojure/encodings.clj
Expand Up @@ -6,11 +6,8 @@
;; terms of this license. You must not remove this notice, or any other, from
;; this software.

;; compojure.encodings:
;;
;; Functions for encoding data.

(ns compojure.encodings
"Functions for encoding data."
(:use compojure.str-utils)
(:use clojure.contrib.duck-streams)
(:import java.net.URLEncoder)
Expand Down
5 changes: 1 addition & 4 deletions src/compojure/html.clj
Expand Up @@ -6,11 +6,8 @@
;; terms of this license. You must not remove this notice, or any other, from
;; this software.

;; compojure.html:
;;
;; Shortcut to include all compojure.http.* namespaces.

(ns compojure.html
"Shortcut to include all compojure.http.* namespaces."
(:use compojure.ns-utils))

(immigrate
Expand Down
5 changes: 1 addition & 4 deletions src/compojure/html/form_helpers.clj
Expand Up @@ -6,11 +6,8 @@
;; terms of this license. You must not remove this notice, or any other, from
;; this software.

;; compojure.html.form-helpers:
;;
;; Functions for generating HTML forms and input fields.

(ns compojure.html.form-helpers
"Functions for generating HTML forms and input fields."
(:use compojure.html.gen)
(:use compojure.control)
(:use compojure.str-utils)
Expand Down
9 changes: 3 additions & 6 deletions src/compojure/html/gen.clj
Expand Up @@ -6,13 +6,10 @@
;; terms of this license. You must not remove this notice, or any other, from
;; this software.

;; compojure.html.gen:
;;
;; A library for generating HTML output from a tree of vectors. The first item
;; of the vector is the tag name, the optional second item is a hash of
;; attributes, and the rest is the body of the tag.

(ns compojure.html.gen
"A library for generating HTML output from a tree of vectors. The first item
of the vector is the tag name, the optional second item is a hash of
attributes, and the rest is the body of the tag."
(:use compojure.str-utils)
(:use clojure.contrib.def))

Expand Down
5 changes: 1 addition & 4 deletions src/compojure/html/page_helpers.clj
Expand Up @@ -6,11 +6,8 @@
;; terms of this license. You must not remove this notice, or any other, from
;; this software.

;; compojure.html.page-helpers:
;;
;; Functions for generating document and header boilerplate.

(ns compojure.html.page-helpers
"Functions for generating document and header boilerplate."
(:use compojure.control)
(:use compojure.html.gen)
(:use compojure.str-utils)
Expand Down
7 changes: 2 additions & 5 deletions src/compojure/http.clj
Expand Up @@ -6,12 +6,9 @@
;; terms of this license. You must not remove this notice, or any other, from
;; this software.

;; compojure.http:
;;
;; Shortcut to include compojure.http.routes, compojure.http.helpers and
;; compojure.http.servlet.

(ns compojure.http
"Shortcut to include compojure.http.routes, compojure.http.helpers and
compojure.http.servlet."
(:use compojure.ns-utils))

(immigrate
Expand Down
5 changes: 1 addition & 4 deletions src/compojure/http/helpers.clj
Expand Up @@ -6,11 +6,8 @@
;; terms of this license. You must not remove this notice, or any other, from
;; this software.

;; compojure.http.helper:
;;
;; Helper functions for things like redirection, serving files, 404s, etc.

(ns compojure.http.helpers
"Helper functions for things like redirection, serving files, 404s, etc."
(:use compojure.encodings)
(:use compojure.str-utils)
(:use clojure.contrib.def)
Expand Down
7 changes: 2 additions & 5 deletions src/compojure/http/multipart.clj
Expand Up @@ -6,12 +6,9 @@
;; terms of this license. You must not remove this notice, or any other, from
;; this software.

;; compojure.http.multipart:
;;
;; Add multipart form handling to Compojure. Relies on the Apache Commons
;; FileUpload library.

(ns compojure.http.multipart
"Add multipart form handling to Compojure. Relies on the Apache Commons
FileUpload library."
(:use clojure.contrib.def)
(:use compojure.map-utils)
(:import org.apache.commons.fileupload.FileUpload)
Expand Down
5 changes: 1 addition & 4 deletions src/compojure/http/request.clj
Expand Up @@ -6,11 +6,8 @@
;; terms of this license. You must not remove this notice, or any other, from
;; this software.

;; compojure.http.request:
;;
;; Functions for pulling useful data out of a HTTP request map.

(ns compojure.http.request
"Functions for pulling useful data out of a HTTP request map."
(:use compojure.control)
(:use compojure.encodings)
(:use compojure.map-utils)
Expand Down
5 changes: 1 addition & 4 deletions src/compojure/http/response.clj
Expand Up @@ -6,11 +6,8 @@
;; terms of this license. You must not remove this notice, or any other, from
;; this software.

;; compojure.http.response:
;;
;; Parse a Compojure route return value into a HTTP response map.

(ns compojure.http.response
"Parse a Compojure route return value into a HTTP response map."
(:use clojure.contrib.def)
(:use compojure.http.helpers)
(:import clojure.lang.Fn)
Expand Down
9 changes: 3 additions & 6 deletions src/compojure/http/routes.clj
Expand Up @@ -6,13 +6,10 @@
;; terms of this license. You must not remove this notice, or any other, from
;; this software.

;; compojure.http.routes:
;;
;; Macros and functions for compiling routes in the form (method path & body)
;; into stand-alone functions that return the return value of the body, or the
;; keyword :next if they don't match.

(ns compojure.http.routes
"Macros and functions for compiling routes in the form (method path & body)
into stand-alone functions that return the return value of the body, or the
keyword :next if they don't match."
(:use compojure.http.request)
(:use compojure.http.response)
(:use compojure.http.session)
Expand Down
5 changes: 1 addition & 4 deletions src/compojure/http/servlet.clj
Expand Up @@ -6,11 +6,8 @@
;; terms of this license. You must not remove this notice, or any other, from
;; this software.

;; compojure.http.servlet:
;;
;; Functions for interfacing Compojure with the Java servlet standard.

(ns compojure.http.servlet
"Functions for interfacing Compojure with the Java servlet standard."
(:use compojure.http.routes)
(:use compojure.http.request)
(:import java.io.File)
Expand Down
5 changes: 1 addition & 4 deletions src/compojure/http/session.clj
Expand Up @@ -6,11 +6,8 @@
;; terms of this license. You must not remove this notice, or any other, from
;; this software.

;; compojure.http.session:
;;
;; Functions for creating and updating HTTP sessions.

(ns compojure.http.session
"Functions for creating and updating HTTP sessions."
(:use compojure.str-utils)
(:use compojure.http.helpers)
(:use compojure.http.request)
Expand Down
7 changes: 2 additions & 5 deletions src/compojure/map_utils.clj
Expand Up @@ -6,11 +6,8 @@
;; terms of this license. You must not remove this notice, or any other, from
;; this software.

;; compojure.seq-utils
;;
;; Utility functions for manipulating maps

(ns compojure.map-utils)
(ns compojure.map-utils
"functions for manipulating maps.")

(defn assoc-vec
"Associate a key with a value. If the key already exists in the map, create a
Expand Down
8 changes: 8 additions & 0 deletions src/compojure/ns_utils.clj
@@ -1,3 +1,11 @@
;; Copyright (c) James Reeves. All rights reserved.
;; The use and distribution terms for this software are covered by the Eclipse
;; Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php) which
;; can be found in the file epl-v10.html at the root of this distribution. By
;; using this software in any fashion, you are agreeing to be bound by the
;; terms of this license. You must not remove this notice, or any other, from
;; this software.

(ns compojure.ns-utils)

(defn immigrate
Expand Down
5 changes: 1 addition & 4 deletions src/compojure/server/common.clj
Expand Up @@ -6,11 +6,8 @@
;; terms of this license. You must not remove this notice, or any other, from
;; this software.

;; compojure.server.common
;;
;; Common functions for implementing compojure server wrapper.

(ns compojure.server.common
"Common functions for implementing compojure server wrapper."
(:import java.net.URL))

(defn get-host-and-path
Expand Down
7 changes: 2 additions & 5 deletions src/compojure/server/grizzly.clj
Expand Up @@ -6,12 +6,9 @@
;; terms of this license. You must not remove this notice, or any other, from
;; this software.

;; compojure.server.grizzly
;;
;; Clojure interface to start an embedded Grizzly server. To compile, use:
;; ant -Dwith.grizzly

(ns compojure.server.grizzly
"Clojure interface to start an embedded Grizzly server. To compile, use:
ant -Dwith.grizzly"
(:use compojure.control)
(:use compojure.server.common)
(:import com.sun.grizzly.http.embed.GrizzlyWebServer)
Expand Down
5 changes: 1 addition & 4 deletions src/compojure/server/jetty.clj
Expand Up @@ -6,11 +6,8 @@
;; terms of this license. You must not remove this notice, or any other, from
;; this software.

;; compojure.jetty:
;;
;; Clojure interface to start an embedded Jetty server.

(ns compojure.server.jetty
"Clojure interface to start an embedded Jetty server."
(:use compojure.control)
(:use compojure.server.common)
(:import org.mortbay.jetty.Server)
Expand Down
5 changes: 1 addition & 4 deletions src/compojure/str_utils.clj
Expand Up @@ -6,11 +6,8 @@
;; terms of this license. You must not remove this notice, or any other, from
;; this software.

;; compojure.str-utils:
;;
;; Utility functions for manipulating strings

(ns compojure.str-utils
"Utility functions for manipulating strings."
(:use clojure.contrib.seq-utils)
(:use clojure.contrib.str-utils)
(:import clojure.lang.Named))
Expand Down
11 changes: 8 additions & 3 deletions src/compojure/validation.clj
@@ -1,8 +1,13 @@
;; compojure.validation
;;
;; Functions for validating form parameters.
;; Copyright (c) James Reeves. All rights reserved.
;; The use and distribution terms for this software are covered by the Eclipse
;; Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php) which
;; can be found in the file epl-v10.html at the root of this distribution. By
;; using this software in any fashion, you are agreeing to be bound by the
;; terms of this license. You must not remove this notice, or any other, from
;; this software.

(ns compojure.validation
"Functions for validating form parameters."
(:use compojure.control)
(:use compojure.html.form-helpers)
(:use compojure.html.page-helpers)
Expand Down
8 changes: 8 additions & 0 deletions src/compojure/validation/predicates.clj
@@ -1,3 +1,11 @@
;; Copyright (c) James Reeves. All rights reserved.
;; The use and distribution terms for this software are covered by the Eclipse
;; Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php) which
;; can be found in the file epl-v10.html at the root of this distribution. By
;; using this software in any fashion, you are agreeing to be bound by the
;; terms of this license. You must not remove this notice, or any other, from
;; this software.

(ns compojure.validation.predicates
(:use compojure.str-utils))

Expand Down

0 comments on commit ab9905d

Please sign in to comment.