Community
Participate
Working Groups
20031015 The warnings for problems in javadoc tags say: 'Annotation: xxx' I would suggest to not use 'Annotation' (already used my the editor e.g. Java -> Editor -> Annotations' for something different. 'Javadoc tags' seems to me the better description.
Annotation also describes the new metadata facility. See JSR175. We might have some problems for the naming of the ast classes.
All classes, method, fields names which contain 'annotation' will be changed. 'annotation' will be replaced by 'javadoc' with corresponding character case. Also all comments which will be changed to avoid confusion...
Of course also replace 'Annotation: ....' in problems description with 'Javadoc: ...'. As some problem descriptions already contain 'javadoc': Annotation: Unexpected javadoc entry Annotation: Missing javadoc entry for parameter {0} Annotation: Duplicate entry for parameter Annotation: Missing javadoc entry for return type Annotation: Duplicate entry for return type Annotation: Missing javadoc entry for declared exception {0} Annotation: Duplicate entry for thrown exception Annotation: Missing javadoc comment for public declaration they will be replaced with following ones: Javadoc: Unexpected tag Javadoc: Missing tag for parameter {0} Javadoc: Duplicate tag for parameter Javadoc: Missing tag for return type Javadoc: Duplicate tag for return type Javadoc: Missing tag for declared exception {0} Javadoc: Duplicate tag for thrown exception Javadoc: Missing comment for public declaration For all other description, only 'Annotation:' prefix will be changed to 'Javadoc:'
Martin, Please note that due to conflict with Annotation JDK 1.5 grammar, ids for optional compiler problem to signal problems with javadoc will be changed. New definitions for these options will be: COMPILER / Reporting Invalid Javadoc Comment - option id: "org.eclipse.jdt.core.compiler.problem.invalidJavadoc" COMPILER / Reporting Missing Javadoc Comment - option id: "org.eclipse.jdt.core.compiler.problem.missingJavadoc" How can we synchronize this change?
If you can make me a new jdt.core drop as soon as you released the changes, then I can adapt to it immediatly as well. BTW: I wouldn't qualify everything with 'Javadoc:', the other error messages don't do that either. Just write 'Missing Javadoc tag', 'Missing Javadoc comment for public declaration'
Fixed. No specific test cases added, only rerun those already existing. Martin, I let prefix 'Javadoc:' in problems description as this kind of problems are really specific for the compiler: they are not really against the code but in comments... This is really useful as we use some of 'standard' compiler problem description (not found, not visible, etc...) while resolving bindings for references and we want to distinguish them easily from those which are in the code (warning/error levels are not enough to do this distinction).
Verified.
