swig/Examples/test-suite/java/commentParser.java
2012-07-07 13:40:41 +00:00

71 lines
No EOL
2 KiB
Java

import com.sun.javadoc.*;
import java.util.HashMap;
import java.util.Map.Entry;
import java.util.Iterator;
public class commentParser {
static HashMap<String, String> parsedComments = new HashMap<String, String>();
public static boolean start(RootDoc root) {
/*
* This method is called by 'javadoc' and gets the whole parsed java
* file, we get comments and store them
*/
ClassDoc[] classes = root.classes();
for (int i = 0; i < classes.length; i++) {
if (classes[i].getRawCommentText().length() > 0)
parsedComments.put(classes[i].name(),
classes[i].getRawCommentText());
MethodDoc[] methods = classes[i].methods();
FieldDoc[] fields = classes[i].fields();
FieldDoc[] constants = classes[i].enumConstants();
for (int j = 0; j < constants.length; j++) {
FieldDoc f = constants[j];
if (f.getRawCommentText().length() > 0)
parsedComments.put(f.name(), f.getRawCommentText());
}
for (int j = 0; j < fields.length; j++) {
FieldDoc f = fields[j];
if (f.getRawCommentText().length() > 0)
parsedComments.put(f.name(), f.getRawCommentText());
}
for (int j = 0; j < methods.length; j++) {
MethodDoc m = methods[j];
if (m.getRawCommentText().length() > 0)
parsedComments.put(m.name(), m.getRawCommentText());
}
}
return true;
}
public static int check(HashMap<String, String> wantedComments) {
int errorCount=0;
Iterator< Entry<String, String> > it = parsedComments.entrySet().iterator();
while (it.hasNext())
{
Entry<String, String> e = (Entry<String, String>) it.next();
if (!e.getValue().equals(wantedComments.get(e.getKey()))) {
System.out.println("Documentation comments for " + e.getKey() + " does not match: ");
System.out.println("\texpected:"+wantedComments.get(e.getKey()));
System.out.println("\tgot:\t"+e.getValue());
errorCount++;
}
}
if (parsedComments.size() < wantedComments.size()) {
System.out.println("Found " + (wantedComments.size()-parsedComments.size()) + " missed comment(s)!");
errorCount++;
}
return errorCount;
}
}