org.acm.seguin.pretty
Class ForceJavadocComments

java.lang.Object
  org.acm.seguin.pretty.ForceJavadocComments

public class ForceJavadocComments
extends java.lang.Object

Forces javadoc comments only for a certain level of source code. The level is based on the permissions associated with the file.

Author:

Chris Seguin

Constructor Summary

ForceJavadocComments()

Method Summary

boolean

isJavaDocRequired(java.lang.String type, net.sourceforge.jrefactory.ast.ModifierHolder mods) Determines if the java doc comment is required for the particular method or field

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ForceJavadocComments

public ForceJavadocComments()

Method Detail

isJavaDocRequired

public boolean isJavaDocRequired(java.lang.String type,
                                 net.sourceforge.jrefactory.ast.ModifierHolder mods)

Determines if the java doc comment is required for the particular method or field

Parameters:

type - the type (method or field)

mods - the modifiers associated with this object

Returns:

true if they are required