aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/sonar-squid-java-plugin/test-resources/rules/UndocumentedApi.java
blob: 729a0a7fe8961c6f119ecf24e4f421d42816d500 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
/**
 * no violation, because documented
 */
class UndocumentedApi {
  private String key;

  public UndocumentedApi() { // no violation, because empty constructor
  }

  public UndocumentedApi(String key) { // violation
    this.key = key;
  }

  public void run() { // violation
  }

  public interface InnerUndocumentedInterface { // violation
  }

  /**
   * no violation, because documented
   */
  public void run2() {
  }

  public void setKey(String key) { // no violation, because setter
    this.key = key;
  }

  public String getKey() { // no violation, because getter
    return key;
  }

  @Override
  public String toString() { // no violation, because method with override annotation
    return key;
  }

}