Re: Documenting Clojure Code

2009-01-31 Thread Mark McGranaghan
Daniel, Last night I updated clj-doc so that it should run without problems: if you're willing to try it out I'd be willing to fix any problems that you come up against and let me know about. At this point there are still rough edges that I want to fix and features that I want to add (see the TOD

Re: Documenting Clojure Code

2009-01-30 Thread Daniel E. Renfer
Mark, Glad to see you are putting some more work into clj-doc again. I tried compiling it a couple weeks ago, and after I downloaded the 4 or 5 libraries it depended on and fixed some of the references to code that had been moved, I got an exception when I tried running it. I gave up after that.

Re: Documenting Clojure Code

2009-01-30 Thread Mark McGranaghan
Hi Kevin, You should try clj-doc: http://github.com/mmcgrana/clj-doc clj-doc generates HTML API documentation that is searchable via JavaScript and includes source snippets for the code that defined each var. I update clj-doc tonight to include example docs, just clone my clj-doc repo and open

Re: Documenting Clojure Code

2009-01-30 Thread Kevin Albrecht
Using #^{:doc ...} documents the code, but are there any tools out there for creating HTML API documentation from the documented code? Stephen C. Gilardi wrote: >         (def >           #^{:doc "a nice description here"} >           myvar >           (hash-map :a 1 :b 3)) --~--~-~--~--

Re: Documenting Clojure Code

2009-01-30 Thread Stephen C. Gilardi
On Jan 30, 2009, at 4:49 PM, bOR_ wrote: (def myvar ; cant do a nice " "description here, even though hash-maps can stand in for functions. (hash-map :a 1 :b 3)) clojure.contrib.def/defvar offers some help with that: - clojure.contrib.def/defvar

Re: Documenting Clojure Code

2009-01-30 Thread Meikel Brandmeyer
Hi, Am 30.01.2009 um 22:49 schrieb bOR_: (def myvar ; cant do a nice " "description here, even though hash-maps can stand in for functions. (hash-map :a 1 :b 3)) Currently only (def #^{:doc "A Foo"} foo ...) is possible. Alternatively clojure.contrib.def/defvar: (defvar foo (hash-map :a :

Re: Documenting Clojure Code

2009-01-30 Thread bOR_
Related. (defn myfunc "a nice description here" [coll] (apply + coll)) but no (def myvar ; cant do a nice " "description here, even though hash-maps can stand in for functions. (hash-map :a 1 :b 3)) On Jan 30, 10:42 pm, Kevin Albrecht wrote: > How are people generating HTML or text docu

Documenting Clojure Code

2009-01-30 Thread Kevin Albrecht
How are people generating HTML or text documentation from their Clojure code? --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups "Clojure" group. To post to this group, send email to clojure@googlegroups.com To unsubscri