API files in javax.xml.bind need to be updated for references to JLS with editions/hyperlinks · Issue #824 · javaee/jaxb-v2 (original) (raw)
This repository was archived by the owner on Feb 5, 2019. It is now read-only.
This repository was archived by the owner on Feb 5, 2019. It is now read-only.
Description
Following files have references to JLS with specific editions or hyperlinks to the specification:
./xml/bind/JAXBContext.html:http://java.sun.com/docs/books/jls">S 7.4.1.1 "Package Annotations" in Java Language Specification, 3rd Edition
Following is the expected intent:
- Any reference to The Java Language Specification or The Java Virtual Machine Specification in any part of the Java SE API documentation (including javadoc) must not be followed by an edition name such as "Second Edition" or "Third Edition".
- Any reference to these specifications (either as a whole, or to individual sections) must not be a hyperlink. Web hosting for these specifications in Java SE 7 has not yet been approved.
- Any plain-text reference to a section number/name is OK now and in future. Sections are extremely likely, though not guaranteed, to be stable over time. Please refer to the 2011 Maintenance Reviews of JSR 901 and JSR 924 for current section info.
FYI: There will be a "Java SE 7 Edition" of both specifications. It is implicit in API documentation for Java SE 7 that the corresponding language/VM spec is the Java SE 7 Edition. When web hosting is known, javadoc can hyperlink directly to the language/VM spec edition which is contemporaneous with the javadoc, without needing to name an edition.