Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JavaDocs are hard to read with fully qualified names for java.lang, java.util and other non-Spring classes [SPR-5734] #10404

Closed
spring-projects-issues opened this issue May 8, 2009 · 2 comments
Labels
type: documentation A documentation task type: enhancement A general enhancement
Milestone

Comments

@spring-projects-issues
Copy link
Collaborator

Thomas Risberg opened SPR-5734 and commented

JavaDocs are hard to read with fully qualified names for java.lang, java.util and other non-Spring classes


Affects: 3.0 M3

Referenced from: commits 54c768d

@spring-projects-issues
Copy link
Collaborator Author

Mark Pollack commented

The javadoc option noqualifier, for example

noqualifier="java.:com.sun."

will remove this...so one gets

<T> Future<T> submit(Callable<T> task)

instead of

<T> java.util.concurrent.Future<T> submit(java.util.concurrent.Callable<T> task)

I've put an issue to Ben to include this in an update to the build infrastructure.

@spring-projects-issues
Copy link
Collaborator Author

nebhale commented

I didn't update spring-build with the noqualifier content. Instead, I update the spring-framework build to be more like the 2.5 version where external types were javadoc linked.

You can see the update I made in the build-spring-framework/build.xml file. I simply copied the list from the 2.5 build, but it is incorrect and incomplete in places. Someone should go back and update the links that are there for the new dependencies.

@spring-projects-issues spring-projects-issues added type: documentation A documentation task type: enhancement A general enhancement labels Jan 11, 2019
@spring-projects-issues spring-projects-issues added this to the 3.0 M4 milestone Jan 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation task type: enhancement A general enhancement
Projects
None yet
Development

No branches or pull requests

1 participant