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

Add "use" in Spring API documentation (Javadoc) [SPR-15427] #19988

Closed
spring-issuemaster opened this issue Apr 10, 2017 · 3 comments
Closed

Add "use" in Spring API documentation (Javadoc) [SPR-15427] #19988

spring-issuemaster opened this issue Apr 10, 2017 · 3 comments

Comments

@spring-issuemaster
Copy link
Collaborator

@spring-issuemaster spring-issuemaster commented Apr 10, 2017

Logan Mauzaize opened SPR-15427 and commented

With Javadoc, you can generate usage pages (class, package, ...) which help to discover the API.

Example : https://docs.oracle.com/javase/8/docs/api/index.html?java/util/function/class-use/Predicate.html


Affects: 5.0 M5

Issue Links:

  • #21709 Generate "Use" pages in aggregated Spring API documentation (Javadoc)

Referenced from: commits 42420a2

@spring-issuemaster

This comment has been minimized.

Copy link
Collaborator Author

@spring-issuemaster spring-issuemaster commented Apr 10, 2017

Sam Brannen commented

It looks like passing the -use flag for Standard Doclet Options should do the trick.

-use

Includes one Use page for each documented class and package. The page describes what packages, classes, methods, constructors and fields use any API of the specified class or package. Given class C, things that use class C would include subclasses of C, fields declared as C, methods that return C, and methods and constructors with parameters of type C. For example, you can look at the Use page for the String type. Because the getName method in the java.awt.Font class returns type String, the getName method uses String and so the getName method appears on the Use page for String.This documents only uses of the API, not the implementation. When a method uses String in its implementation, but does not take a string as an argument or return a string, that is not considered a use of String.To access the generated Use page, go to the class or package and click the Use link in the navigation bar.

@spring-issuemaster

This comment has been minimized.

Copy link
Collaborator Author

@spring-issuemaster spring-issuemaster commented Apr 10, 2017

Sam Brannen commented

Resolved in 42420a2

@spring-issuemaster

This comment has been minimized.

Copy link
Collaborator Author

@spring-issuemaster spring-issuemaster commented Apr 10, 2017

Sam Brannen commented

Unfortunately Gradle does not document how to set the -use flag: https://discuss.gradle.org/t/javadoc-use-flag/22282

But it is in fact supported, and with a little digging (i.e., extensive Googling) I was able to figure out how to set that flag within the Gradle javadoc task. ;-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.