diff --git a/src/smeagol/include.clj b/src/smeagol/include.clj index 41aaf99..8f8a017 100644 --- a/src/smeagol/include.clj +++ b/src/smeagol/include.clj @@ -1,4 +1,6 @@ -(ns smeagol.include +(ns ^{:doc "Functions related to the include of markdown-paged in a given markdown." + :author "Michael Jerger"} + smeagol.include (:require [clojure.string :as cs] [schema.core :as s] diff --git a/src/smeagol/include/indent.clj b/src/smeagol/include/indent.clj index 6967d19..f92a69c 100644 --- a/src/smeagol/include/indent.clj +++ b/src/smeagol/include/indent.clj @@ -1,4 +1,8 @@ -(ns smeagol.include.indent +(ns ^{:doc "Functions related to the include of markdown-paged - handling the +list & heading indents of includes. This namespaces is implementation detail for +smeagol.include and not inteded for direct usage." + :author "Michael Jerger"} + smeagol.include.indent (:require [clojure.string :as cs] [schema.core :as s])) diff --git a/src/smeagol/include/parse.clj b/src/smeagol/include/parse.clj index 2212e0d..0016252 100644 --- a/src/smeagol/include/parse.clj +++ b/src/smeagol/include/parse.clj @@ -1,4 +1,8 @@ -(ns smeagol.include.parse +(ns ^{:doc "Functions related to the include of markdown-paged - parsing of +include links. This namespaces is implementation detail for +smeagol.include and not inteded for direct usage." + :author "Michael Jerger"} + smeagol.include.parse (:require [schema.core :as s])) diff --git a/src/smeagol/include/resolve.clj b/src/smeagol/include/resolve.clj index 13a67ce..95b0ec2 100644 --- a/src/smeagol/include/resolve.clj +++ b/src/smeagol/include/resolve.clj @@ -1,4 +1,8 @@ -(ns smeagol.include.resolve +(ns ^{:doc "Functions related to the include of markdown-paged - providing +a plugable load-content componet. This namespaces is implementation detail for +smeagol.include and not inteded for direct usage." + :author "Michael Jerger"} + smeagol.include.resolve (:require [schema.core :as s] [com.stuartsierra.component :as component]))