diff options
author | Tom Faulhaber <git_net@infolace.com> | 2010-11-26 18:41:24 -0800 |
---|---|---|
committer | Tom Faulhaber <git_net@infolace.com> | 2010-11-26 18:46:57 -0800 |
commit | 37fba7ef6697b2e46db7d38b463dba81d3b1c4e7 (patch) | |
tree | b75d10d332718524ca9e19d0b93c5b31a5365ab9 | |
parent | d3f22c50f9502abf4d1343a0c9819bff47b3e055 (diff) |
Moved the documentation into the namespace doc string so that autodoc will pick it up.
-rw-r--r-- | modules/priority-map/src/main/clojure/clojure/contrib/priority_map.clj | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/modules/priority-map/src/main/clojure/clojure/contrib/priority_map.clj b/modules/priority-map/src/main/clojure/clojure/contrib/priority_map.clj index 5f01e5d2..57bf4c12 100644 --- a/modules/priority-map/src/main/clojure/clojure/contrib/priority_map.clj +++ b/modules/priority-map/src/main/clojure/clojure/contrib/priority_map.clj @@ -4,12 +4,9 @@ ;; by Mark Engelberg (mark.engelberg@gmail.com) ;; July 16, 2010 -(ns clojure.contrib.priority-map - (:use clojure.test) - (:import clojure.lang.MapEntry java.util.Map clojure.lang.PersistentTreeMap)) - -(comment -"A priority map is very similar to a sorted map, but whereas a sorted map produces a +(ns + ^{:author "Mark Engelberg", + :doc "A priority map is very similar to a sorted map, but whereas a sorted map produces a sequence of the entries sorted by key, a priority map produces the entries sorted by value. In addition to supporting all the functions a sorted map supports, a priority map can also be thought of as a queue of [item priority] pairs. To support usage as @@ -145,7 +142,10 @@ bottleneck in your program. All in all, I hope you will find priority maps to be an easy-to-use and useful addition to Clojure's assortment of built-in maps (hash-map and sorted-map). -") +"} + clojure.contrib.priority-map + (:use clojure.test) + (:import clojure.lang.MapEntry java.util.Map clojure.lang.PersistentTreeMap)) ; Note that the plan is to eventually support subseq, but this will require ; some changes to core: |