New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SummaryJavadoc: need special processing of inheritDoc tag #3908

Closed
romani opened this Issue Mar 3, 2017 · 5 comments

Comments

Projects
None yet
4 participants
@romani
Member

romani commented Mar 3, 2017

taken from #3014

$ cat config.xml 
<!DOCTYPE module PUBLIC
          "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
          "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<module name="Checker">
    <module name="TreeWalker">
        <module name="SummaryJavadoc">
        </module>
    </module>
</module>

$ cat Test.java 
public class Test extends Exception {

    /**
      * {@inheritDoc} */
    public String toString(){
        return "";
    }
}

$ java -jar checkstyle-7.6-all.jar -c config.xml Test.java 
Starting audit...
[ERROR] /home/rivanov/nfs/tests/Test.java:3: First sentence of Javadoc is incomplete (period is missing) or not present. [SummaryJavadoc]
Audit done.
Checkstyle ends with 1 errors.

Expected no error.

generated javadoc html is:

Method Detail

    toString

    public java.lang.String toString()

    Overrides:
        toString in class java.lang.Throwable


@ljacqu

This comment has been minimized.

Show comment
Hide comment
@ljacqu

ljacqu Mar 4, 2017

Contributor

Extending this finding, it would be interesting to have a configuration option to skip this check for certain fragments. Specifically, I'm interested in enabling this check but for trivial getters I want to allow just having a concise @return blabla javadoc:

/**
 * @return the category the article belongs to
 */
 public Category getCategory() {
   return category;
 }
Contributor

ljacqu commented Mar 4, 2017

Extending this finding, it would be interesting to have a configuration option to skip this check for certain fragments. Specifically, I'm interested in enabling this check but for trivial getters I want to allow just having a concise @return blabla javadoc:

/**
 * @return the category the article belongs to
 */
 public Category getCategory() {
   return category;
 }
@rnveach

This comment has been minimized.

Show comment
Hide comment
@rnveach

rnveach Mar 5, 2017

Member

@ljacqu Create a new issue as this is only this one is for only dealing with inheritDoc tag.

Member

rnveach commented Mar 5, 2017

@ljacqu Create a new issue as this is only this one is for only dealing with inheritDoc tag.

@sagar-shah94

This comment has been minimized.

Show comment
Hide comment
@sagar-shah94

sagar-shah94 Mar 5, 2017

Contributor

I am on it

Contributor

sagar-shah94 commented Mar 5, 2017

I am on it

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 5, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 5, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 5, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 5, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 5, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 5, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 5, 2017

@romani

This comment has been minimized.

Show comment
Hide comment
@romani

romani Mar 5, 2017

Member

@ljacqu , in new issue please start to define what is " trivial getters " . In my experience, setter/getter detection is hard and tricky, so definition of this term should be strict.

Member

romani commented Mar 5, 2017

@ljacqu , in new issue please start to define what is " trivial getters " . In my experience, setter/getter detection is hard and tricky, so definition of this term should be strict.

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 7, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 7, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 8, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 8, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 8, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 12, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 12, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 12, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 12, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 12, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 17, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 17, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 17, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 18, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 18, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 18, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 18, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 18, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 18, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 18, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 18, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 18, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 19, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 19, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 20, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 20, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 20, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 21, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 22, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 22, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 23, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 23, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 23, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 23, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 24, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 25, 2017

romani added a commit that referenced this issue Mar 25, 2017

@romani romani added the bug label Mar 25, 2017

@romani romani added this to the 7.7 milestone Mar 25, 2017

@romani

This comment has been minimized.

Show comment
Hide comment
@romani

romani Mar 25, 2017

Member

fix is merged

Member

romani commented Mar 25, 2017

fix is merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment