Hey Richard, Yep, it’s exactly how you’ve described. The main emphasis is on writing documentation that can be verified through tests and so if the api changes, then the documentation can be fixed accordingly.
The grenada project looks to be very ambitious in it’s scope and yeah, it’ll be amazing to have a hoogle-like search engine for clojure. btw… is datadoc a grenada thing or a java thing? Chris > Hi Chris, > > you can download a Datadoc JAR from > https://clojars.org/repo/org/clojars/rmoehn/clojure/1.7.0+003/clojure-1.7.0+003-datadoc.jar > and have a look at its contents. It's pretty bare-bones right now. > > Hydrox looks good! (As do your other libraries. – I hadn't had them on my > radar at all until now.) It appears to be a cool new tack on documentation > for me. A more expressive alternative to Codox, Autodoc & co. Correct me if I > oversimplify. What I've developed is a universal container for data about > Clojure code. You could store Hydrox data in it for distribution and > digestion by other tools. After the end of the GSoC my schedule is in a state > confusion, but as soon as this has abated I will have a closer look at Hydrox > and also include it in my comparison > (https://github.com/clj-grenada/grenada-spec#comparison). > > Regarding the documentation problem (as I see it): Hydrox and Grenada could > be parts of the solution. Still lacking are conventions for the structure of > Clojure libraries and documentation, a unified approach to API documentation > (as opposed to people putting Codox or Autodoc on github.io or private pages > or nothing at all) and a dedicated search engine for Clojure libraries. > > I would love to continue working on those things (and Grenada), but first I > have to wait for feedback from Alex Miller, who was my GSoC mentor, and then > I need to find some funding. > > Richard > > -- > 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 > Note that posts from new members are moderated - please be patient with your > first post. > 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 > <http://groups.google.com/group/clojure?hl=en> > --- > You received this message because you are subscribed to a topic in the Google > Groups "Clojure" group. > To unsubscribe from this topic, visit > https://groups.google.com/d/topic/clojure/TTO5AfqXXf4/unsubscribe > <https://groups.google.com/d/topic/clojure/TTO5AfqXXf4/unsubscribe>. > To unsubscribe from this group and all its topics, send an email to > clojure+unsubscr...@googlegroups.com > <mailto:clojure+unsubscr...@googlegroups.com>. > For more options, visit https://groups.google.com/d/optout > <https://groups.google.com/d/optout>. -- 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 Note that posts from new members are moderated - please be patient with your first post. 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 --- You received this message because you are subscribed to the Google Groups "Clojure" group. To unsubscribe from this group and stop receiving emails from it, send an email to clojure+unsubscr...@googlegroups.com. For more options, visit https://groups.google.com/d/optout.
