add doc to namespaces

This commit is contained in:
jem 2018-05-22 16:59:43 +02:00
parent 535465c362
commit 3668b26df1
4 changed files with 18 additions and 4 deletions

View file

@ -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 (:require
[clojure.string :as cs] [clojure.string :as cs]
[schema.core :as s] [schema.core :as s]

View file

@ -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 (:require
[clojure.string :as cs] [clojure.string :as cs]
[schema.core :as s])) [schema.core :as s]))

View file

@ -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 (:require
[schema.core :as s])) [schema.core :as s]))

View file

@ -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 (:require
[schema.core :as s] [schema.core :as s]
[com.stuartsierra.component :as component])) [com.stuartsierra.component :as component]))