KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > spoon > examples > analysis > processing > DocProcessor


1 package spoon.examples.analysis.processing;
2
3 import spoon.processing.AbstractProcessor;
4 import spoon.processing.Severity;
5 import spoon.reflect.declaration.CtElement;
6 import spoon.reflect.declaration.CtExecutable;
7 import spoon.reflect.declaration.CtField;
8 import spoon.reflect.declaration.CtModifiable;
9 import spoon.reflect.declaration.CtSimpleType;
10 import spoon.reflect.declaration.ModifierKind;
11
12 /**
13  * Report warnings when undocumented elements are found.
14  */
15 public class DocProcessor extends AbstractProcessor<CtElement> {
16
17     public void process(CtElement element) {
18         if (element instanceof CtSimpleType || element instanceof CtField
19                 || element instanceof CtExecutable) {
20             if (((CtModifiable) element).getModifiers().contains(
21                     ModifierKind.PUBLIC)
22                     || ((CtModifiable) element).getModifiers().contains(
23                             ModifierKind.PROTECTED)) {
24                 // if(element instanceof CtMethod) {
25 // ((CtMethod)element).getReference().getOverloadingExecutable()
26 // }
27 if (element.getDocComment() == null
28                         || element.getDocComment().equals("")) {
29                     getFactory().getEnvironment().report(this,
30                             Severity.WARNING, element, "undocument element");
31                 }
32             }
33         }
34     }
35
36 }
37
Popular Tags