yogsototh/marginalia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Doc changes

Browse source
This commit is contained in:
zkim 2010-12-22 01:18:17 -07:00
parent a644f74a82
commit b5d4154aa3
1 changed files with 11 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
src/marginalia/core.clj
View file

@ -13,6 +13,8 @@
(def *divider-text* "\n;;DIVIDER\n") (def *divider-text* "\n;;DIVIDER\n")
(def *divider-html* #"\n*<span class=\"c[1]?\">;;DIVIDER</span>\n*") (def *divider-html* #"\n*<span class=\"c[1]?\">;;DIVIDER</span>\n*")
;; ## File System Utilities
(defn ls (defn ls
[path] [path]
(let [file (java.io.File. path)] (let [file (java.io.File. path)]
@ -22,7 +24,6 @@
[path])))) [path]))))
(defn mkdir [path] (defn mkdir [path]
"Creates a directory identified by `path`."
(.mkdirs (io/file path))) (.mkdirs (io/file path)))
(defn ensure-directory! [path] (defn ensure-directory! [path]
@ -40,7 +41,7 @@
(map #(.getAbsolutePath %)))) (map #(.getAbsolutePath %))))
;; # Project Info Parsing ;; ## Project Info Parsing
;; Marginalia will parse info out of your project.clj to display in ;; Marginalia will parse info out of your project.clj to display in
;; the generated html file's header. ;; the generated html file's header.
;; ;;
@ -76,8 +77,8 @@
"There was a problem reading the project definition from " "There was a problem reading the project definition from "
path))))))) path)))))))
(defn usage []
(println "marginalia <src1> ... <src-n>")) ;; ## Source File Analysis
;; This line should be replaced ;; This line should be replaced
;; and this one too! ;; and this one too!
@ -187,6 +188,9 @@
{:ns ns {:ns ns
:groups groups})) :groups groups}))
;; ## Ouput Generation
(defn uberdoc! [output-file-name files-to-analyze] (defn uberdoc! [output-file-name files-to-analyze]
"Generates an uberdoc html file from 3 pieces of information: "Generates an uberdoc html file from 3 pieces of information:
@ -200,6 +204,8 @@
(map path-to-doc files-to-analyze))] (map path-to-doc files-to-analyze))]
(spit output-file-name source))) (spit output-file-name source)))
;; ## External Interface (command-line, lein, cake, etc)
(defn format-sources [sources] (defn format-sources [sources]
(if (nil? sources) (if (nil? sources)
(find-clojure-file-paths "./src") (find-clojure-file-paths "./src")
@ -235,7 +241,7 @@
;; # Example Usage ;; # Example Usage
(comment (comment
;; What would happen if you ran <insert command line example here> ;; Command line example
(-main ["./src/marginalia/core.clj" "./src/marginalia/html.clj"]) (-main ["./src/marginalia/core.clj" "./src/marginalia/html.clj"])
;; This will find all marginalia source files, and then generate an uberdoc. ;; This will find all marginalia source files, and then generate an uberdoc.