Clojure

Update URLs in javadoc.clj

Details

  • Type: Defect Defect
  • Status: Open Open
  • Priority: Minor Minor
  • Resolution: Unresolved
  • Affects Version/s: Release 1.7, Release 1.8
  • Fix Version/s: None
  • Component/s: None
  • Labels:
    None
  • Patch:
    Code
  • Approval:
    Prescreened

Description

javadoc.clj contains javadoc base urls for the jdk and several popular open source libraries. Most of these urls are broken.

For example, create a project with the following dependencies:

[org.clojure/clojure "1.8.0"]
[commons-codec "1.10"]
[commons-io "2.4"]
[commons-lang "2.6"]
[org.apache.commons/commons-lang3 "3.4"]
[com.google.guava/guava "19.0"]

And then try the following javadoc checks:

(javadoc java.lang.AutoCloseable)
(javadoc java.util.function.Function)
(javadoc org.apache.commons.codec.Decoder)
(javadoc org.apache.commons.io.IOUtils)
(javadoc org.apache.commons.lang.ArrayUtils)
(javadoc org.apache.commons.lang3.ArrayUtils)
(javadoc com.google.common.collect.BiMap)

Fixes:

  • Update jdk javadoc urls and explicitly include 1.6, 1.7, and 1.8, falling back to 1.8 (most common in use right now)
  • Update commons-codec javadoc url
  • Update commons-io javadoc url
  • Update commons-lang javadoc url (not that commons-lang last release was 2.6)
  • Add commons-lang3 javadoc url (the 3+ version of commons-lang changed the base package name)
  • Add guava javadoc url (another very common Java library)

Patch: clj-1398.patch

Activity

Hide
Andy Fingerhut added a comment -

Eli, thanks for the patches. It appears that you are not currently on the list of Clojure contributors here: http://clojure.org/contributing

It is the policy of the Clojure team only to incorporate patches submitted by people who have signed and submitted a Clojure CA. Were you interested in doing that?

Show
Andy Fingerhut added a comment - Eli, thanks for the patches. It appears that you are not currently on the list of Clojure contributors here: http://clojure.org/contributing It is the policy of the Clojure team only to incorporate patches submitted by people who have signed and submitted a Clojure CA. Were you interested in doing that?
Hide
Eli Lindsey added a comment -

> It is the policy of the Clojure team only to incorporate patches submitted by people who have signed and submitted a Clojure CA. Were you interested in doing that?

Yup! I mailed off the CA to Rich on Wednesday when this was filed; should be arriving shortly.

Show
Eli Lindsey added a comment - > It is the policy of the Clojure team only to incorporate patches submitted by people who have signed and submitted a Clojure CA. Were you interested in doing that? Yup! I mailed off the CA to Rich on Wednesday when this was filed; should be arriving shortly.
Hide
Eli Lindsey added a comment -

Just to note - Clojure CA went through and I'm listed on the contributors page now.

Show
Eli Lindsey added a comment - Just to note - Clojure CA went through and I'm listed on the contributors page now.
Alex Miller made changes -
Field Original Value New Value
Approval Triaged [ 10120 ]
Hide
Alex Miller added a comment -

I squashed the patches and made some minor modifications in the jdk urls. Patch attribution retained.

Show
Alex Miller added a comment - I squashed the patches and made some minor modifications in the jdk urls. Patch attribution retained.
Alex Miller made changes -
Affects Version/s Release 1.8 [ 10254 ]
Priority Trivial [ 5 ] Minor [ 4 ]
Issue Type Enhancement [ 4 ] Defect [ 1 ]
Attachment clj-1398.patch [ 15420 ]
Description Three minor fixes/enhancements to javadoc.clj:

0001 corrects the URLs for apache commons javadoc (the ones used in javadoc.clj no longer resolve).
0002 adds javadoc lookup for guava and apache commons lang3.
0003 adds javadoc lookup for jdk8.

(Note: contributor agreement is in the mail)
javadoc.clj contains javadoc base urls for the jdk and several popular open source libraries. Most of these urls are broken.

For example, create a project with the following dependencies:

{code}
[org.clojure/clojure "1.8.0"]
[commons-codec "1.10"]
[commons-io "2.4"]
[commons-lang "2.6"]
[org.apache.commons/commons-lang3 "3.4"]
[com.google.guava/guava "19.0"]
{code}

And then try the following javadoc checks:

{code}
(javadoc java.lang.AutoCloseable)
(javadoc java.util.function.Function)
(javadoc org.apache.commons.codec.Decoder)
(javadoc org.apache.commons.io.IOUtils)
(javadoc org.apache.commons.lang.ArrayUtils)
(javadoc org.apache.commons.lang3.ArrayUtils)
(javadoc com.google.common.collect.BiMap)
{code}

*Fixes:*

* Update jdk javadoc urls and explicitly include 1.6, 1.7, and 1.8, falling back to 1.8 (most common in use right now)
* Update commons-codec javadoc url
* Update commons-io javadoc url
* Update commons-lang javadoc url (not that commons-lang last release was 2.6)
* Add commons-lang3 javadoc url (the 3+ version of commons-lang changed the base package name)
* Add guava javadoc url (another very common Java library)

*Patch:* clj-1398.patch
Approval Triaged [ 10120 ] Prescreened [ 10220 ]
Hide
Alex Miller added a comment -

Thanks Bozhidar - I expect this will get updated for Clojure 1.9.

On the note in the change in method urls, the clojure.java.javadoc/javadoc function only builds urls to classes, not to methods, so I don't think that note has any impact on the patch.

Show
Alex Miller added a comment - Thanks Bozhidar - I expect this will get updated for Clojure 1.9. On the note in the change in method urls, the clojure.java.javadoc/javadoc function only builds urls to classes, not to methods, so I don't think that note has any impact on the patch.

People

Vote (9)
Watch (2)

Dates

  • Created:
    Updated: