View Javadoc
1   package com.google.checkstyle.test.chapter7javadoc.rule72thesummaryfragment;
2   
3   /** A {@code Foo. Foo} is a simple Javadoc. Some javadoc. */
4   class InputIncorrectSummaryFragment {
5   
6     // violation below 'First sentence of Javadoc is missing an ending period.'
7     /** As of JDK 1.1, replaced by {@link #setBounds(int,int,int,int)} */
8     void foo3() {}
9   
10    // violation below 'Summary javadoc is missing.'
11    /**
12     * @throws Exception if a problem occurs
13     */
14    void foo4() throws Exception {}
15  
16    /** An especially short bit of Javadoc. */
17    void foo5() {}
18  
19    /** An especially short bit of Javadoc. */
20    void foo6() {}
21  
22    /** Some Javadoc. */
23    public static final byte NUL = 0;
24  
25    // violation below 'Summary javadoc is missing.'
26    /** <a href="mailto:vlad@htmlbook.ru"/> */
27    class InnerInputCorrectJavaDocParagraphCheck {
28  
29      // violation below 'First sentence of Javadoc is missing an ending period.'
30      /** foooo@foooo */
31      public static final byte NUL = 0;
32  
33      /** Some java@doc. */
34      public static final byte NUL_2 = 0;
35  
36      // violation below 'Forbidden summary fragment.'
37      /** This method returns some javadoc. Some javadoc. */
38      boolean emulated() {
39        return false;
40      }
41  
42      // violation below 'Summary javadoc is missing.'
43      /** <a href="mailto:vlad@htmlbook.ru"/> */
44      void foo2() {}
45  
46      // violation below 'Summary javadoc is missing.'
47      /**
48       * @return the customer ID some javadoc.
49       */
50      int geId() {
51        return 666;
52      }
53  
54      /** As of JDK 1.1, replaced by {@link #setBounds(int,int,int,int)}. */
55      void foo3() {}
56  
57      // violation below 'Summary javadoc is missing.'
58      /**
59       * @throws Exception if a problem occurs
60       */
61      void foo4() throws Exception {}
62  
63      /** An especially short bit of Javadoc. */
64      void foo5() {}
65  
66      /** An especially short bit of Javadoc. */
67      void foo6() {}
68    }
69  
70    // violation below 'Forbidden summary fragment.'
71    /** A {@code InnerInputCorrectJavaDocParagraphCheck} is a simple code. */
72    InnerInputCorrectJavaDocParagraphCheck anon =
73        new InnerInputCorrectJavaDocParagraphCheck() {
74  
75          /** Some Javadoc. */
76          public static final byte NUL = 0;
77  
78          /** Some Javadoc. */
79          void emulated(String s) {}
80  
81          /** As of JDK 1.1, replaced by {@link #setBounds(int,int,int,int)}. */
82          void foo3() {}
83  
84          // violation below 'Summary javadoc is missing.'
85          /**
86           * @throws Exception if a problem occurs
87           */
88          void foo4() throws Exception {}
89  
90          /** An especially short bit of Javadoc. */
91          void foo5() {}
92  
93          /** An especially short bit of Javadoc. */
94          void foo6() {}
95        };
96  }