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 example/index.html in your browser to see what
the docs look like.

In my update I also made it easier to generate docs for your own sets
of libs: check out the README and let me know if you have any
questions/problems.

I've had clj-doc on hold for a little while as I've been waiting for
various documentation-related features to find their way into core,
especially the ns docstrings. Now that we have most of those (though
(def foo "docstring" :bar) is noticeably missing) I'm going to be
working more on clj-doc.

Hope you find it useful,
- Mark McGranaghan

On Fri, Jan 30, 2009 at 7:31 PM, Kevin Albrecht <onlya...@gmail.com> wrote:
>
> 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))
>
> >
>

--~--~---------~--~----~------------~-------~--~----~
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 unsubscribe from this group, send email to 
clojure+unsubscr...@googlegroups.com
For more options, visit this group at 
http://groups.google.com/group/clojure?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to