Liking cljdoc? Tell your friends :D

lucid.publish.collect.reference


collect-referencesclj

(collect-references {:keys [articles project] :as interim} name)

collects all :reference tags of within an article

(let [project (project/project) project (assoc project :lookup (project/file-lookup project)) elems (parse/parse-file "test/documentation/lucid_publish.clj" project) bundle {:articles {"lucid-publish" {:elements elems}} :references {} :project project}] (-> (collect-references bundle "lucid-publish") :references keys)) => '(lucid.publish.theme)

collects all `:reference` tags of within an article

(let [project (project/project)
      project (assoc project :lookup (project/file-lookup project))
      elems   (parse/parse-file "test/documentation/lucid_publish.clj" project)
      bundle  {:articles {"lucid-publish" {:elements elems}}
               :references {}
               :project project}]
  (-> (collect-references bundle "lucid-publish")
      :references
     keys))
=> '(lucid.publish.theme)
raw docstring

find-import-namespacesclj

(find-import-namespaces lookup ns)

finds forms with (ns/import ...)

(find-import-namespaces (project/file-lookup (project/project)) 'lucid.publish) => '(lucid.publish.theme)

finds forms with `(ns/import ...)`

(find-import-namespaces (project/file-lookup (project/project))
                        'lucid.publish)
=> '(lucid.publish.theme)
raw docstring

reference-namespacesclj

(reference-namespaces references lookup namespaces)

finds the referenced vars in the namespace

(-> (reference-namespaces {} (project/file-lookup (project/project)) '[lucid.core.asm]) (get 'lucid.core.asm) keys sort) => '(dynamic-loader load-class path->classname to-bytes unload-class)

finds the referenced vars in the namespace

 (-> (reference-namespaces {}
                           (project/file-lookup (project/project))
                           '[lucid.core.asm])
     (get 'lucid.core.asm)
     keys
     sort)
=> '(dynamic-loader load-class path->classname to-bytes unload-class)
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close