P2
There are several minor documentation issues with the javadoc reference page.
The latest can be found here -> http://st-doc.us.oracle.com/id_common/review/docbuilder/html/E61612_04/javadoc.htm#GUID-9D532574-1CDB-4D30-99F3-A308DCAEE55F
On the Standard doclet options, it is -html4, not -html14
Also make sure to say that -html4 is the default if not used.
On the Non-standard Options Provided by the Standard doclet, there is issues with:
- -Xdoclintgroup : Enables groupchecks
There is spaces missing at two locations
- -Xdoclint all,-group : Enables all checks exceptgroup checks
There is a space missing in one location
- On the following paragraph about the HTML group, there are some issues
html : Detects high-level HTML issues, such as putting block elements inside inline elements, or not closing elements that require an end tag. The rules are derived from the HTML 4 Specification and HTML 5 Specification for -html 4 and -html 5 respectively. This type of check enables the javadoc command to detect HTML issues that many browsers might accept, create accessible web pages , and increases the semantic value of web pages. The following HTML options are supported:
-html 4: Generates HTML 4 output.
-html 5: Generates HTML 5 output.
Issues with the above paragraph section.
1 - please remove all spaces between -html and 4 or -html and 5.
2 - please mention in the parameter that rules are derived from the standard doclet -html option used, if none of -html4 or -html5 is used.
3 - you don't need the text 'The following HTML options are supported: -html 4... -html 5....', it is redundant, it's already mentioned in the standard doclet option.
4 - remove the Note: that mentions -html4 is the default, it is not in the right place, the default has to be documented in the Standard Doclet option section.
The latest can be found here -> http://st-doc.us.oracle.com/id_common/review/docbuilder/html/E61612_04/javadoc.htm#GUID-9D532574-1CDB-4D30-99F3-A308DCAEE55F
On the Standard doclet options, it is -html4, not -html14
Also make sure to say that -html4 is the default if not used.
On the Non-standard Options Provided by the Standard doclet, there is issues with:
- -Xdoclintgroup : Enables groupchecks
There is spaces missing at two locations
- -Xdoclint all,-group : Enables all checks exceptgroup checks
There is a space missing in one location
- On the following paragraph about the HTML group, there are some issues
html : Detects high-level HTML issues, such as putting block elements inside inline elements, or not closing elements that require an end tag. The rules are derived from the HTML 4 Specification and HTML 5 Specification for -html 4 and -html 5 respectively. This type of check enables the javadoc command to detect HTML issues that many browsers might accept, create accessible web pages , and increases the semantic value of web pages. The following HTML options are supported:
-html 4: Generates HTML 4 output.
-html 5: Generates HTML 5 output.
Issues with the above paragraph section.
1 - please remove all spaces between -html and 4 or -html and 5.
2 - please mention in the parameter that rules are derived from the standard doclet -html option used, if none of -html4 or -html5 is used.
3 - you don't need the text 'The following HTML options are supported: -html 4... -html 5....', it is redundant, it's already mentioned in the standard doclet option.
4 - remove the Note: that mentions -html4 is the default, it is not in the right place, the default has to be documented in the Standard Doclet option section.