Fork me on GitHub
#cljdoc
<
2019-10-16
>
borkdude13:10:39

out of curiosity: does cljdoc also show javadocs for java sources in clojure projects?

borkdude13:10:47

I'm working on a Java API for one of my projects

martinklepsch13:10:59

@borkdude not in scope, sorry!

borkdude13:10:35

can probably hack around that by generating some markdown from javadoc or something

martinklepsch13:10:14

Happy to discuss if you feel there’s a strong case for it but my intuition is that cost/benefit just doesn’t make much sense given the average Clojure library

borkdude13:10:42

you might be right

martinklepsch13:10:51

Generating documentation to markdown files 👌 😄 Boot does that too, worked pretty well

borkdude13:10:24

or I'll just informally create an example. Java people have IDEs 😜

😂 4
wilkerlucio17:10:31

@martinklepsch hello 🙂 I was having the wish to have some attribute documentation on cljdoc, in that I mean, having a section of the docs dedicated to talk about the keywords with spec information, this could include: 1. list of qualified keywords are used in the project (maybe even those without spec) 2. describe specs for keywords that have it 3. using data from fspec / fdef it could generate a list of functions where that keyword is mentioned I have done something similar for Pathom (https://wilkerlucio.github.io/pathom/v2/pathom/2.2.0/connect/exploration.html). what do you think about having something like this in cljdoc?

jaihindhreddy13:10:18

Could also have inline example generation for specced stuff.

seancorfield21:10:30

@wilkerlucio Couldn't you just write that up in the doc folder in your repo?

seancorfield21:10:52

Oh, you specifically want it auto-generated from the source?

seancorfield21:10:48

I'm not sure how valuable auto-generated data would be -- I would expect it to need more curation?