Clojure

Javadoc for public Java API

Details

  • Type: Enhancement Enhancement
  • Status: Closed Closed
  • Priority: Critical Critical
  • Resolution: Completed
  • Affects Version/s: None
  • Fix Version/s: Release 1.6
  • Component/s: None
  • Labels:
  • Patch:
    Code
  • Approval:
    Ok

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)

  1. clj-1190.patch
    23/Oct/13 8:47 PM
    1 kB
    Alex Miller
  2. clj-1190-2.diff
    23/Oct/13 10:47 PM
    6 kB
    Alex Miller
  3. clj-1190-3.diff
    05/Dec/13 10:54 AM
    17 kB
    Alex Miller

Activity

Alex Miller made changes -
Field Original Value New Value
Approval Vetted [ 10003 ]
Alex Miller made changes -
Labels documentation
Alex Miller made changes -
Priority Minor [ 4 ] Critical [ 2 ]
Alex Miller made changes -
Assignee Alex Miller [ alexmiller ]
Alex Miller made changes -
Attachment cljjdoc.zip [ 12379 ]
Alex Miller made changes -
Attachment clj-1190.patch [ 12381 ]
Alex Miller made changes -
Attachment clj-1190-2.diff [ 12382 ]
Alex Miller made changes -
Description We should publish javadoc for http://dev.clojure.org/jira/browse/CLJ-1188.

* make sure to publish on the the public API classes and interfaces
* if IFn remains part of public interface, find javadoc control knob to disable including the nested interfaces dealing with primitives
* automate publishing the docs somewhere (javadoc.clojure.org?)

This ticket should wait until CLJ-1188 is ok'ed.
We should publish javadoc for http://dev.clojure.org/jira/browse/CLJ-1188.

* make sure to publish on the the public API classes and interfaces
* if IFn remains part of public interface, find javadoc control knob to disable including the nested interfaces dealing with primitives
* automate publishing the docs somewhere (javadoc.clojure.org?)

This ticket should wait until CLJ-1188 is ok'ed.

*Patch:* clj-1190-2.diff (javadoc updates and a new Ant target)
Alex Miller made changes -
Attachment cljjdoc.zip [ 12379 ]
Stuart Halloway made changes -
Approval Vetted [ 10003 ] Screened [ 10004 ]
Alex Miller made changes -
Description We should publish javadoc for http://dev.clojure.org/jira/browse/CLJ-1188.

* make sure to publish on the the public API classes and interfaces
* if IFn remains part of public interface, find javadoc control knob to disable including the nested interfaces dealing with primitives
* automate publishing the docs somewhere (javadoc.clojure.org?)

This ticket should wait until CLJ-1188 is ok'ed.

*Patch:* clj-1190-2.diff (javadoc updates and a new Ant target)
We should publish javadoc for http://dev.clojure.org/jira/browse/CLJ-1188.

* make sure to publish on the the public API classes and interfaces
* if IFn remains part of public interface, find javadoc control knob to disable including the nested interfaces dealing with primitives
* automate publishing the docs somewhere (javadoc.clojure.org?)

This ticket should wait until CLJ-1188 is ok'ed.

*Patch:* clj-1190-2.diff (javadoc updates and a new Ant target)
*Screened by:* Stuart Halloway
Rich Hickey made changes -
Approval Screened [ 10004 ] Incomplete [ 10006 ]
Alex Miller made changes -
Assignee Alex Miller [ alexmiller ] Stuart Halloway [ stu ]
Alex Miller made changes -
Attachment clj-1190-3.diff [ 12509 ]
Alex Miller made changes -
Approval Incomplete [ 10006 ] Screened [ 10004 ]
Description We should publish javadoc for http://dev.clojure.org/jira/browse/CLJ-1188.

* make sure to publish on the the public API classes and interfaces
* if IFn remains part of public interface, find javadoc control knob to disable including the nested interfaces dealing with primitives
* automate publishing the docs somewhere (javadoc.clojure.org?)

This ticket should wait until CLJ-1188 is ok'ed.

*Patch:* clj-1190-2.diff (javadoc updates and a new Ant target)
*Screened by:* Stuart Halloway
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)
Andy Fingerhut made changes -
Patch Code [ 10001 ]
Rich Hickey made changes -
Approval Screened [ 10004 ] Ok [ 10007 ]
Stuart Halloway made changes -
Resolution Completed [ 1 ]
Status Open [ 1 ] Closed [ 6 ]

People

Vote (0)
Watch (1)

Dates

  • Created:
    Updated:
    Resolved: