Bug 166365 - [javadoc] severity level of malformed javadoc comments did not work properly
Summary: [javadoc] severity level of malformed javadoc comments did not work properly
Status: VERIFIED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 3.2.1   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.3 M4   Edit
Assignee: Frederic Fusier CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2006-11-30 11:59 EST by Leif Hanack CLA
Modified: 2006-12-12 07:26 EST (History)
0 users

See Also:


Attachments
show that to much errors are found (134.20 KB, image/jpeg)
2006-11-30 12:10 EST, Leif Hanack CLA
no flags Details
Proposed patch (14.43 KB, patch)
2006-12-01 13:06 EST, Frederic Fusier CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Leif Hanack CLA 2006-11-30 11:59:32 EST
Build ID: M20060921-0945

Steps To Reproduce:
1) 
create a class with the some method each a different access scope:

    /**
     * @return
     */
    private String getSomePrivate() {
        return "SomePrivate";
    }

    /**
     * @return
     */
    protected String getSomeProtected() {
        return "SomeProtected";
    }

    /**
     * @return
     */
    String getSomeDefault() {
        return "SomeDefault";
    }

    /**
     * @return
     */
    String getSomePublic() {
        return "SomePublic";
    }

2)
Changing the preferences of Preferences > Java > Compiler > Javadoc > Malformed Javadoc Comments severity level ERROR and visibility to PUBLIC (see screenshot)

3) apply changes

4) even the default, protected and private method javadoc comments are marked as error (see screenshot)


More information:
using project specific settings/preferences did not change this.
Comment 1 Leif Hanack CLA 2006-11-30 12:10:41 EST
Created attachment 54797 [details]
show that to much errors are found

show an example of the wrong detection of malformed javadoc comments. as shown in the preferences dialog, the visibility is set to PUBLIC, therefore default, protected and private should not throw an error.
Comment 2 Frederic Fusier CLA 2006-12-01 07:40:53 EST
Missing text in @return cannot be considered as a syntax error (which are always reported whatever the visibility level see bug 77602 comment 1) => I agree we have to hide this warning according to member visibility...
Comment 3 Frederic Fusier CLA 2006-12-01 13:06:53 EST
Created attachment 54908 [details]
Proposed patch
Comment 4 Frederic Fusier CLA 2006-12-01 16:48:38 EST
Released for 3.3 M4 in HEAD stream.
Comment 5 David Audel CLA 2006-12-12 07:26:53 EST
Verified for 3.3M4 with I20061212-0010.