Community
Participate
Working Groups
Bug 47132 and bug 46976 claim to have fixed this problem, but I believe that it still exists under Mac OS X using Eclipse 3.0M6. When the preferences are set to 'Problems in JavaDoc: warning' and 'Include missing JavaDoc tags in public types, methods and fields' are set, I get warnings when I have an overriden method: /* * (non-JavaDoc) * @see java.lang.Object#toString() */ public String toString() { ... } then I get the warning. Ideally, I want to be able to set up Eclipse so that when I have a /missing/ JavaDoc tag, then it generates a warning, but when I have an overridden method (like toString()), I can just have a /* (non- JavaDoc) */ type identifier that disables the warning for that method. Bug 46976 fixed the problem by being able to turn the warning off, which IMHO is useful but not the fix to the problem, which is it should be able to check for other missing JavaDoc methods, but not ones with an 'ignore me' comment. My suggestion would be that the warning searches for missing *comments* above a method, type, or field, and not just whether they are JavaDoc or non-JavaDoc comments. (Perhaps this could be given a separate configuration at some point later, but not necessarily required.) Note that Eclipse projects will invariably have a lot of /* */ comments above overriden methods that are desirable to inherit the JavaDoc, but (new) method w/o a comment should be detected by this option. Mac OS X.3.2 using Eclipse 3.0M6 (build 200311211210) Suspect this problem is OS independent, but leaving Mac/MacOSX above for now.
Not sure that this will be adressed for 3.0... *** This bug has been marked as a duplicate of 44300 ***
This isn't a duplicate; either it is a new bug, or one of the other bugs needs to be reopened to highlight it. Closing it a duplicate without reopening one of the other bugs is not a solution. Please either leave this bug open, or mark it as a duplicate and re-open one of the other ones, because it is still a bug and still present.
My mistake; will add comments to 44300 instead. *** This bug has been marked as a duplicate of 44300 ***