add codox.

Author: Yannick Scherer

project.clj

@@ -10,8 +10,10 @@
                  [potemkin "0.3.11"]]
   :profiles {:dev {:dependencies [[midje "1.6.3" :exclusions [joda-time]]
                                   [joda-time "2.5"]]
-                   :plugins [[lein-midje "3.1.3"]]
-                   :exclusions [org.clojure/clojure]}
+                   :plugins [[lein-midje "3.1.3"]
+                             [codox "0.8.10"]]
+                   :exclusions [org.clojure/clojure]
+                   :codox {:defaults {:doc/format :markdown}}}
              :1.5 {:dependencies [[org.clojure/clojure "1.5.1"]]}
              :1.6 {:dependencies [[org.clojure/clojure "1.6.0"]]}}
   :aliases {"all" ["with-profile" "dev,1.5:dev,1.6"]

src/rewrite_clj/node.clj

@@ -1,4 +1,6 @@
-(ns rewrite-clj.node
+(ns
+  ^{:added "0.4.0"}
+  rewrite-clj.node
   (:require [rewrite-clj.node
              coerce
              comment
@@ -99,7 +101,7 @@
 
 ;; ## Value
 
-(defn value
+(defn ^{:deprecated "0.4.0"} value
   "DEPRECATED: Get first child as a pair of tag/sexpr (if inner node),
    or just the node's own sexpr. (use explicit analysis of `children`
    `child-sexprs` instead) "

src/rewrite_clj/node/coerce.clj

@@ -1,4 +1,4 @@
-(ns rewrite-clj.node.coerce
+(ns ^:no-doc rewrite-clj.node.coerce
   (:require [potemkin :refer [defprotocol+]]
             [rewrite-clj.node
              comment forms integer keyword

src/rewrite_clj/node/comment.clj

@@ -1,4 +1,4 @@
-(ns rewrite-clj.node.comment
+(ns ^:no-doc rewrite-clj.node.comment
   (:require [rewrite-clj.node.protocols :as node]))
 
 ;; ## Node

src/rewrite_clj/node/forms.clj

@@ -1,4 +1,4 @@
-(ns rewrite-clj.node.forms
+(ns ^:no-doc rewrite-clj.node.forms
   (:require [rewrite-clj.node.protocols :as node]))
 
 ;; ## Node
@@ -36,5 +36,7 @@
 ;; ## Constructor
 
 (defn forms-node
+  "Create top-level node wrapping multiple children
+   (equals an implicit `do` on the top-level)."
   [children]
   (->FormsNode children))

src/rewrite_clj/node/indent.clj

@@ -1,4 +1,4 @@
-(ns rewrite-clj.node.indent
+(ns ^:no-doc rewrite-clj.node.indent
   (:require [rewrite-clj.node
              [protocols :as node]
              [whitespace :as ws]]

src/rewrite_clj/node/integer.clj

@@ -1,4 +1,4 @@
-(ns rewrite-clj.node.integer
+(ns ^:no-doc rewrite-clj.node.integer
   (:require [rewrite-clj.node.protocols :as node]))
 
 ;; ## Node

src/rewrite_clj/node/keyword.clj

@@ -1,4 +1,4 @@
-(ns rewrite-clj.node.keyword
+(ns ^:no-doc rewrite-clj.node.keyword
   (:require [rewrite-clj.node.protocols :as node]))
 
 ;; ## Node
@@ -34,6 +34,9 @@
 ;; ## Constructor
 
 (defn keyword-node
+  "Create node representing a keyword. If `namespaced?` is given as `true`
+   a keyword à la `::x` (i.e. namespaced to the current namespace) is
+   generated."
   [k & [namespaced?]]
   {:pre [(keyword? k)]}
   (assert (or (not namespaced?) (not (namespace k)))

src/rewrite_clj/node/meta.clj

@@ -1,4 +1,4 @@
-(ns rewrite-clj.node.meta
+(ns ^:no-doc rewrite-clj.node.meta
   (:require [rewrite-clj.node
              [protocols :as node]
              [whitespace :as ws]]))
@@ -35,13 +35,16 @@
 ;; ## Constructor
 
 (defn meta-node
+  "Create node representing a form and its metadata."
   ([children]
    (node/assert-sexpr-count children 2)
    (->MetaNode :meta "^" children))
   ([metadata data]
    (meta-node [metadata (ws/spaces 1) data])))
 
 (defn raw-meta-node
+  "Create node representing a form and its metadata using the
+   `#^` prefix."
   ([children]
    (node/assert-sexpr-count children 2)
    (->MetaNode :meta* "#^" children))

src/rewrite_clj/node/protocols.clj

@@ -1,4 +1,6 @@
-(ns rewrite-clj.node.protocols
+(ns
+  ^{:added "0.4.0"}
+  rewrite-clj.node.protocols
   (:require [potemkin :refer [defprotocol+]]
             [clojure.string :as string]))
 
@@ -34,12 +36,12 @@
        (remove printable-only?)
        (map sexpr)))
 
-(defn sum-lengths
+(defn ^:no-doc sum-lengths
   "Sum up lengths of the given nodes."
   [nodes]
   (reduce + (map length nodes)))
 
-(defn concat-strings
+(defn ^:no-doc concat-strings
   "Convert nodes to strings and concatenate them."
   [nodes]
   (reduce str (map string nodes)))
@@ -77,7 +79,7 @@
 
 ;; ## Print Helper
 
-(defn node->string
+(defn ^:no-doc node->string
   [node]
   (let [n (str (if (printable-only? node)
                  (pr-str (string node))
@@ -88,21 +90,21 @@
              (str " " n))]
     (format "<%s:%s>" (name (tag node)) n')))
 
-(defmacro make-printable!
+(defmacro ^:no-doc make-printable!
   [class]
   `(defmethod print-method ~class
      [node# w#]
      (.write w# (node->string node#))))
 
 ;; ## Helpers
 
-(defn assert-sexpr-count
+(defn ^:no-doc assert-sexpr-count
   [nodes c]
   (assert
     (= (count (sexprs nodes)) c)
     (format "can only contain %d non-whitespace form%s."
             c (if (= c 1) "" "s"))))
 
-(defn assert-single-sexpr
+(defn ^:no-doc assert-single-sexpr
   [nodes]
   (assert-sexpr-count nodes 1))