Skip to:

  1. Skip to Jira Navigation
  2. Skip to Side Navigation
  3. Skip to Main Content

Javadoc for public Java API

Description

Publish javadoc for http://dev.clojure.org/jira/browse/CLJ-1188.

  • Add javadoc for public API classes (Clojure and IFn)

  • Add ant build target to generate the javadoc

  • Publish javadoc to the clojure project github pages (will be done manually)

Patch: clj-1190-3.diff (javadoc updates and a new Ant target)

Screened by: Stuart Halloway

Updated by: Alex Miller (moved clojure.api.API to clojure.java.api.Clojure and tweaked one example per Rich's suggestion)

Environment

None

Attachments

3

Activity

Show:

Alex Miller December 7, 2013 at 10:24 PM

Oh, I'm misreading the comment history, you just changed the patch field. Carry on.

Alex Miller December 7, 2013 at 10:23 PM

In this case, it looks like you didn't leave the old one so I'm not even sure what's different?

Alex Miller December 7, 2013 at 10:22 PM

Andy, please let me know before modifying screened patches as they need to be re-screened.

Alex Miller December 5, 2013 at 4:58 PM

At Stu's request, I made the updates from our prior conversation, namely:
1) Moved clojure.api.API to clojure.java.api.Clojure and updated all references.
2) Made the example change suggested by Rich to avoid creating and invoking the var in one step.

Rich Hickey November 22, 2013 at 4:37 PM

We should never show things like (lookup and simultaneously use var):

because people will put that in a loop.

Also, API.var seems like a lot of CAPS. I understand that's proper Java conventions but maybe we need to pick another name?

Completed

Details

Assignee

Reporter

Labels

Approval

Ok

Patch

Code

Priority

Fix versions

Created April 3, 2013 at 12:51 PM
Updated January 11, 2014 at 1:16 PM
Resolved January 11, 2014 at 1:16 PM