JavaDocInspector


1   /*
2    * Hammurapi
3    * Automated Java code review system. 
4    * Copyright (C) 2004  Hammurapi Group
5    *
6    * This program is free software; you can redistribute it and/or modify
7    * it under the terms of the GNU General Public License as published by
8    * the Free Software Foundation; either version 2 of the License, or
9    *  (at your option) any later version.
10   *
11   * This program is distributed in the hope that it will be useful,
12   * but WITHOUT ANY WARRANTY; without even the implied warranty of
13   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   * GNU General Public License for more details.
15   *
16   * You should have received a copy of the GNU General Public License
17   * along with this program; if not, write to the Free Software
18   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19   *
20   * URL: http://www.hammurapi.org
21   * e-Mail: support@hammurapi.biz
22   */
23  
24  package org.hammurapi.inspectors;
25  
26  import java.io.File  ;
27  import java.io.FileWriter  ;
28  import java.io.IOException  ;
29  
30  import org.hammurapi.InspectorBase;
31  
32  import com.pavelvlasov.jsel.CompilationUnit;
33  import com.pavelvlasov.jsel.Field;
34  import com.pavelvlasov.jsel.javadoc.JavaDoc;
35  
36  /**
37   * @author Pavel Vlasov 
38   * @version $Revision: 1.4 $
39   */
40  public class JavaDocInspector extends InspectorBase {
41      public void visit(Field field) {
42          if (field.getModifiers().contains("public") || field.getModifiers().contains("protected")) {
43              JavaDoc javaDoc=field.getJavaDoc();
44              if (javaDoc==null) {
45                  context.reportViolation(field);
46              } 
47  
48              //TODO Check if JavaDoc is empty - no description
49              
50              //TODO Check that all tags have descriptions
51              
52              //TODO For operations (methods and constructors) check that @param tags correspond to operation parameters
53              
54              //TODO For operations check that @throw tags correspond to throws clause. There can be @throw for not listed
55              //runtime exceptions (see below)
56              
57              //TODO For non-void methods check that @return tag is present and is not blank
58              
59              //TODO For operations scan operation body for "throw new ..." and check if exception being thrown is listed in @throw tags          
60          }
61      }
62      
63      private ThreadLocal   modified=new ThreadLocal  ();
64      
65      public void leave(CompilationUnit compilationUnit) throws IOException   {
66          if (Boolean.TRUE.equals(modified.get())) {
67              // Output dir is hardcoded to fixes
68              File   root=new File  ("fixes");
69              File   out=new File  (root, compilationUnit.getRelativeName());
70              out.getParentFile().mkdirs();
71              FileWriter   writer=new FileWriter  (out);
72              try {
73                  compilationUnit.save(writer);
74              } finally {
75                  writer.close();
76              }
77          }
78      }
79  }
80
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags