Hi Timur,

The problem with JavaDoc is that it's a source-level attribute, so in order
to be used from a Java editor the editor would have to understand Clojure.
This is actually possible in Cursive - as far as I'm aware no other system
does this right now. The other aspect would be generating JavaDoc HTML when
offline documentation is produced - I don't know if the javadoc tool is
extensible in order to allow this.

However the bigger issue is that most of the elements exposed to Java don't
support any documentation. definterface, gen-class, deftype & defrecord do
not. defprotocol does, but the interface generated from the protocol is
really an implementation detail, I don't think it's intended to be used for
interop. Some new commenting convention would need to be developed.

For all these reasons, I generally recommend defining your interop
interfaces in Java and just implementing them in Clojure.

Cheers,
Colin

On 19 May 2015 at 21:41, Timur <timurha...@gmail.com> wrote:

> Hi everyone,
>
> Is it possible to add JavaDocs to Clojure so that it can support Java
> programmers. For instance a JavaDoc to a protocol or to an interface
> defined in Clojure which is later on read by a Java developer?
>
> Regards,
>
> Timur
>
> --
> 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.
>

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