Community
Participate
Working Groups
I am working with 3.0 M5 and I doesn't ignore problem in Javadoc Tags: when I use @see, JDT gives problem for missing tags which are described in the Javadoc of the indicated method in the @see tag
Jacques, can you provide an example. Moving to JDT/Core since the provide the comment checker.
/** * @see org.eclipse.core.internal.events.InternalBuilder#build(int, java.util.Map, org.eclipse.core.runtime.IProgressMonitor) */ protected IProject[] build(int kind, Map args, IProgressMonitor monitor) throws CoreException I receive a missing tag for @return, kind, args, monitor and CoreException but this is already described through the @see.
We should allow to delegate Javadoc in the form of a unique @see tag which corresponds to an existing method (defined in superclass/interface) and matches the current selector and arguments. If so, then we shouldn't complain at all.
Fixed. Now, when a @see tags with a reference to a super method is done in Javadoc comment, then we do not report missing Javadoc errors for methods and constructors. Note that this reference may not be the only tag of the comment. Note also that invalid syntax or unresolved references are still always reported for @param and @throws tags if some of them are written in the comment additionaly to the @see super method reference. For example, while compiling following class: public class X implements Comparable { /** * @param x * @see java.lang.Comparable#compareTo(java.lang.Object) */ public int compareTo(Object o) { return 0; } } compiler will still complain on x in @param declaration as it is an invalid parameter name... Test cases added in tests.compiler.regression.JavadocTestMixed
Note that in /** * @see org.eclipse.core.internal.events.InternalBuilder#build(int, java.util.Map, org.eclipse.core.runtime.IProgressMonitor) */ there are really tags missing. Use a non-javadoc comment if you want to inherit the comment from the overridden method
Verified for 3.0M6. Work as described in comment 4.
