On Wednesday, May 6, 2015 at 6:17:37 AM UTC-5, Phillip Lord wrote:
>
> <richar...@posteo.de <javascript:>> writes: 
> > The goal of this project is to develop a comprehensive and extensible 
> > model for describing Clojure sources from an API perspective. I will 
> > also write a program that analyses Clojure sources according to this 
> > model and outputs data documenting their usage. This could be compared 
> > to Javadoc, but emitting data to be consumed by other tools instead of 
> > HTML. In order to foster adoption, I will provide extensive 
> > documentation, including examples of such consumer tools, and 
> > emphasize active communication with the community. ☙ 
>
> I would like to see a mechanism for structure in the clojure doc 
> strings. So, consider the second definition in core.clj. 
>

Defining any structure inside the docstring is out of scope for this 
project. That information will be put into the model by producers and can 
be used by any consumer (who might understand some such format), but I 
think defining that specific structure is not what we're talking about. 

However, arbitrary metadata (expressed as data) attached to vars etc is 
likely to be of interest, both known metadata tags and understanding how to 
be open to extensions.

Alex

-- 
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.

Reply via email to