-
Bug
-
Resolution: Fixed
-
P2
-
9
-
b162
-
Verified
Issue | Fix Version | Assignee | Priority | Status | Resolution | Resolved In Build |
---|---|---|---|---|---|---|
JDK-8177598 | 10 | Bhavesh Patel | P2 | Resolved | Fixed | b04 |
Classes with long method signatures disturb the normally neat layout of the Method Summary table for the class javadoc.
For example, 2 new methods with long parameters were recently added to javax.net.ssl.SSLSocket:
http://download.java.net/java/jdk9/docs/api/javax/net/ssl/SSLSocket.html#method.summary
Notice how the Description column in the Method Summary table has been squeezed.
From Jon Gibbons:
FWIW, IMO, the signature should be allowed to wrap, possibly using normal spaces after each comma in the parameter list, and possibly a non-breaking space between the parameter type and parameter name.
For example, 2 new methods with long parameters were recently added to javax.net.ssl.SSLSocket:
http://download.java.net/java/jdk9/docs/api/javax/net/ssl/SSLSocket.html#method.summary
Notice how the Description column in the Method Summary table has been squeezed.
From Jon Gibbons:
FWIW, IMO, the signature should be allowed to wrap, possibly using normal spaces after each comma in the parameter list, and possibly a non-breaking space between the parameter type and parameter name.
- backported by
-
JDK-8177598 Long method signatures disturb Method Summary table
-
- Resolved
-
- relates to
-
JDK-8248903 Javadoc: Don't use "Zero Width Space" (U+200B)
-
- Closed
-