Community
Participate
Working Groups
| To: Brian Young/OTT/OTI@OTI, Dave Thomson/OTT/OTI@OTI, | Erich Gamma/ZRH/OTI@OTI, Greg Adams/OTT/OTI@OTI, Jeff | McAffer/OTT/OTI@OTI, John Wiegand/MIN/OTI@OTI, Kevin | Haaland/OTT/OTI@OTI, Kevin McGuire/OTT/OTI@OTI, Mike | Wilson/OTT/OTI@OTI, klicnik@ca.ibm.com | cc: Jim des Rivieres/OTT/OTI@OTI Date: 08:54:43 PM Yesterday Subject: 2.0 - Problems with Javadoc - JDT (only) What is it Here is part of the information I mentioned in today's call. It is flagged by an NL checking tool (CHKPII) but it is general problem issues with our javadoc and not NL specific. It generated wads of other info which I have tried to filter out and make it easier to spot your pieces. Some web browsers (e.g. IE) are tolerant of these errors, others (i.e. netscape 6 on linux) are less tolerant but I can't see us stop shipping on these. What you need to 1) Create pr for your pieces 2) Fix it -- we need to fix these problems in the 2.0 stream although I suspect some teams may want to address this sooner if its easier. Where can you find the tool Misc -> NL Tools -> chkpii & run it on *.htm Ask BrianY if you need a hand running it. When fixed Please let releng know when you have fixed your problems. Note: The above does not include pde or jdt. They will be in separate files. /Greg NOTES: VK (8/24/01 12:05:30 PM) result of CHKPII run. Ignore the CHARSET problems (should be handled in doclet) ORG\ECLIPSE\HELP\ ICONTEXT.HTML HTML-40 833 Missing META tag. Required CHARSET value must be defined in this file. IHELP.HTML HTML-40 813 Invalid HTML symbol: <. Line: 73 813 Invalid HTML symbol: >. Line: 73 833 Missing META tag. Required CHARSET value must be defined in this file. IHELPTOPIC.HTML HTML-40 833 Missing META tag. Required CHARSET value must be defined in this file. PACKAGE-FRAME.HTML HTML-40 833 Missing META tag. Required CHARSET value must be defined in this file. PACKAGE-SUMMARY.HTML HTML-40 833 Missing META tag. Required CHARSET value must be defined in this file. PACKAGE-TREE.HTML HTML-40 833 Missing META tag. Required CHARSET value must be defined in this file. PACKAGE-USE.HTML HTML-40 833 Missing META tag. Required CHARSET value must be defined in this file.
I will correct java docs comments.
Fixed public comments in javadoc for non internal packages. Ensured package.html is provided. Ran Doc Check doclet on these classes. Generated javadoc and ran IBM's chkpii tool. No more problems.