Re: Codox: an API doc generator for Clojure

2012-01-04 Thread Fogus
> It might be an idea to figure out some standard syntax we could use, > like Markdown, that could be used for formatting docstrings. My vote is for Markdown as well. -- You received this message because you are subscribed to the Google Groups "Clojure" group. To post to this group, send email t

Re: Codox: an API doc generator for Clojure

2011-12-27 Thread Tom Faulhaber
Hi All, This makes me feel quite embarrassed that autodoc hasn't seen a release for non-core/contrib projects in so long. I apologize for that. (Insert all the usual "life has been crazy... " caveats here.) I hate seeing smart people having to recreate stuff just cause it's taking me a long time t

Re: Codox: an API doc generator for Clojure

2011-12-27 Thread Stefan Kamphausen
Hi, On Tuesday, December 27, 2011 1:18:52 PM UTC+1, James Reeves wrote: > > It might be an idea to figure out some standard syntax we could use, > like Markdown, that could be used for formatting docstrings. > IMHO the missing homoiconicity of docstrings in all flavors of Lisp that I worked with

Re: Codox: an API doc generator for Clojure

2011-12-27 Thread Laurent PETIT
Hello, Is it in your roadmap to provide links to source code of the functions ? I know this is a border line feature between codox/autodoc and marginalia, but it could be proven useful, even for API documentation (no API is perfectly documented) 2011/12/26 James Reeves > Hi folks, > > In order

Re: Codox: an API doc generator for Clojure

2011-12-27 Thread James Reeves
On 26 December 2011 21:23, Gert Verhoog wrote: > Question: One of my ns docstrings is a fair amount of text which is rendered > as a really long line (because codox puts it inside a ... > element). How would you deal with longer documentation strings? Would I need > to insert manual line breaks

Re: Codox: an API doc generator for Clojure

2011-12-26 Thread Meikel Brandmeyer
Hi, Am 26.12.2011 um 22:23 schrieb Gert Verhoog: > Question: One of my ns docstrings is a fair amount of text which is rendered > as a really long line (because codox puts it inside a ... > element). How would you deal with longer documentation strings? Would I need > to insert manual line bre

Re: Codox: an API doc generator for Clojure

2011-12-26 Thread Gert Verhoog
I love it, thanks, and I got it running in about 10 seconds: lein install plugin codox 0.3.1 lein doc Question: One of my ns docstrings is a fair amount of text which is rendered as a really long line (because codox puts it inside a ... element). How would you deal with longer documentation str

Re: Codox: an API doc generator for Clojure

2011-12-26 Thread Shantanu Kumar
+1 This is pretty neat! (I too couldn't get Autodoc working in the past several months.) Regards, Shantanu On Dec 26, 10:29 pm, James Reeves wrote: > Hi folks, > > In order to generate the documentation for Ring and Compojure, I > created Codox after being unable to get Autodoc working. > > Codo