WEB4J Development Tools 4.10.0.0

hirondelle.web4jtools.metrics.comments
Class CommentsAction

Object
  extended by ActionImpl
      extended by hirondelle.web4jtools.metrics.base.MetricsAction
          extended by hirondelle.web4jtools.metrics.comments.CommentsAction
All Implemented Interfaces:
Action

public final class CommentsAction
extends MetricsAction

List java classes with a low number of comments.

Calculate the overall percentage of comments in your code. Uses the ThresholdForLowComments setting in web.xml.


Field Summary
 
Fields inherited from class hirondelle.web4jtools.metrics.base.MetricsAction
fFileList
 
Fields inherited from class ActionImpl
DATA, ERRORS, ITEM_FOR_EDIT, ITEMS_FOR_LISTING, MESSAGES, USER_ID
 
Constructor Summary
CommentsAction(RequestParser aRequestParser)
           
 
Method Summary
protected  void calculateMetric()
          Calculate metrics and show list of classes with low numbers of comments.
static void readConfig(ServletConfig aConfig)
          Read in settings from web.xml.
 
Methods inherited from class hirondelle.web4jtools.metrics.base.MetricsAction
execute
 
Methods inherited from class ActionImpl
addError, addError, addError, addMessage, addMessage, addToRequest, addToSession, copyFromSessionToRequest, createSessionAndCsrfToken, endSession, getErrors, getExistingSession, getFromSession, getIdParam, getIdParams, getLocale, getLoggedInUserName, getMessages, getOperation, getOrderBy, getParam, getParamUnsafe, getRequestParser, getResponsePage, getTimeZone, getUserId, hasErrors, removeFromSession, setResponsePage
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CommentsAction

public CommentsAction(RequestParser aRequestParser)
Method Detail

readConfig

public static void readConfig(ServletConfig aConfig)
Read in settings from web.xml.


calculateMetric

protected void calculateMetric()
Calculate metrics and show list of classes with low numbers of comments.

Specified by:
calculateMetric in class MetricsAction

WEB4J Development Tools 4.10.0.0

Copyright Hirondelle Systems - Generated 2013Oct19.12.26