jmeter-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From fschumac...@apache.org
Subject svn commit: r1647589 - in /jmeter/trunk/src: core/org/apache/jmeter/testelement/ jorphan/org/apache/jorphan/gui/ jorphan/org/apache/jorphan/reflect/ protocol/http/org/apache/jmeter/protocol/http/modifier/ protocol/jms/org/apache/jmeter/protocol/jms/sam...
Date Tue, 23 Dec 2014 15:09:47 GMT
Author: fschumacher
Date: Tue Dec 23 15:09:47 2014
New Revision: 1647589

URL: http://svn.apache.org/r1647589
Log:
Bug 57193: Add param and return tags to javadoc
Bugzilla Id: 57193

Modified:
    jmeter/trunk/src/core/org/apache/jmeter/testelement/AbstractScopedTestElement.java
    jmeter/trunk/src/jorphan/org/apache/jorphan/gui/AbstractTreeTableModel.java
    jmeter/trunk/src/jorphan/org/apache/jorphan/reflect/ClassTools.java
    jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/modifier/UserParameterXMLParser.java
    jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/BaseJMSSampler.java
    jmeter/trunk/src/reports/org/apache/jmeter/testelement/AbstractChart.java

Modified: jmeter/trunk/src/core/org/apache/jmeter/testelement/AbstractScopedTestElement.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/testelement/AbstractScopedTestElement.java?rev=1647589&r1=1647588&r2=1647589&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/testelement/AbstractScopedTestElement.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/testelement/AbstractScopedTestElement.java Tue
Dec 23 15:09:47 2014
@@ -68,7 +68,9 @@ public abstract class AbstractScopedTest
      * Is the assertion to be applied to the main (parent) sample?
      *
      * @param scope
-     * @return if the assertion is to be applied to the parent sample.
+     *            name of the scope to be checked
+     * @return <code>true</code> if the assertion is to be applied to the parent
+     *         sample.
      */
     public boolean isScopeParent(String scope) {
         return scope.equals(SCOPE_PARENT);
@@ -78,7 +80,9 @@ public abstract class AbstractScopedTest
      * Is the assertion to be applied to the sub-samples (children)?
      *
      * @param scope
-     * @return if the assertion is to be applied to the children.
+     *            name of the scope to be checked
+     * @return <code>true</code> if the assertion is to be applied to the
+     *         children.
      */
     public boolean isScopeChildren(String scope) {
         return scope.equals(SCOPE_CHILDREN);
@@ -88,7 +92,9 @@ public abstract class AbstractScopedTest
      * Is the assertion to be applied to the all samples?
      *
      * @param scope
-     * @return if the assertion is to be applied to the all samples.
+     *            name of the scope to be checked
+     * @return <code>true</code> if the assertion is to be applied to the all
+     *         samples.
      */
     public boolean isScopeAll(String scope) {
         return scope.equals(SCOPE_ALL);
@@ -98,7 +104,9 @@ public abstract class AbstractScopedTest
      * Is the assertion to be applied to the all samples?
      *
      * @param scope
-     * @return if the assertion is to be applied to the all samples.
+     *            name of the scope to be checked
+     * @return <code>true</code> if the assertion is to be applied to the all
+     *         samples.
      */
     public boolean isScopeVariable(String scope) {
         return scope.equals(SCOPE_VARIABLE);
@@ -107,7 +115,7 @@ public abstract class AbstractScopedTest
     /**
      * Is the assertion to be applied to the all samples?
      *
-     * @return if the assertion is to be applied to the all samples.
+     * @return <code>true</code> if the assertion is to be applied to the all
samples.
      */
     protected boolean isScopeVariable() {
         return isScopeVariable(fetchScope());

Modified: jmeter/trunk/src/jorphan/org/apache/jorphan/gui/AbstractTreeTableModel.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/jorphan/org/apache/jorphan/gui/AbstractTreeTableModel.java?rev=1647589&r1=1647588&r2=1647589&view=diff
==============================================================================
--- jmeter/trunk/src/jorphan/org/apache/jorphan/gui/AbstractTreeTableModel.java (original)
+++ jmeter/trunk/src/jorphan/org/apache/jorphan/gui/AbstractTreeTableModel.java Tue Dec 23
15:09:47 2014
@@ -172,10 +172,14 @@ public abstract class AbstractTreeTableM
     }
 
     /**
-     * the implementation checks if the Object is a treenode. If it is,
-     * it returns isLeaf(), otherwise it returns false.
+     * the implementation checks if the Object is a treenode. If it is, it
+     * returns {@link TreeNode#isLeaf() isLeaf()}, otherwise it returns
+     * <code>false</code>.
+     * 
      * @param node
-     * @return whether object is a leaf node or not
+     *            object to be checked for {@link TreeNode#isLeaf() isLeaf()}
+     * @return <code>true</code> if object is a leaf node, <code>false</code>
+     *         otherwise
      */
     public boolean isLeaf(Object node) {
         if (node instanceof TreeNode) {

Modified: jmeter/trunk/src/jorphan/org/apache/jorphan/reflect/ClassTools.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/jorphan/org/apache/jorphan/reflect/ClassTools.java?rev=1647589&r1=1647588&r2=1647589&view=diff
==============================================================================
--- jmeter/trunk/src/jorphan/org/apache/jorphan/reflect/ClassTools.java (original)
+++ jmeter/trunk/src/jorphan/org/apache/jorphan/reflect/ClassTools.java Tue Dec 23 15:09:47
2014
@@ -34,7 +34,7 @@ public class ClassTools {
     /**
      * Call no-args constructor for a class.
      *
-     * @param className
+     * @param className name of the class to be constructed
      * @return an instance of the class
      * @throws JMeterException if class cannot be created
      */
@@ -54,7 +54,7 @@ public class ClassTools {
 
     /**
      * Call a class constructor with an integer parameter
-     * @param className
+     * @param className name of the class to be constructed
      * @param parameter (integer)
      * @return an instance of the class
      * @throws JMeterException if class cannot be created
@@ -82,8 +82,8 @@ public class ClassTools {
 
     /**
      * Call a class constructor with an String parameter
-     * @param className
-     * @param parameter (String)
+     * @param className the name of the class to construct
+     * @param parameter to be used for the construction of the class instance
      * @return an instance of the class
      * @throws JMeterException if class cannot be created
      */
@@ -114,10 +114,16 @@ public class ClassTools {
      * Invoke a public method on a class instance
      *
      * @param instance
+     *            object on which the method should be called
      * @param methodName
+     *            name of the method to be called
      * @throws SecurityException
+     *             if a security violation occurred while looking for the method
      * @throws IllegalArgumentException
+     *             if the method parameters (none given) do not match the
+     *             signature of the method
      * @throws JMeterException
+     *             if something went wrong in the invoked method
      */
     public static void invoke(Object instance, String methodName)
     throws SecurityException, IllegalArgumentException, JMeterException

Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/modifier/UserParameterXMLParser.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/modifier/UserParameterXMLParser.java?rev=1647589&r1=1647588&r2=1647589&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/modifier/UserParameterXMLParser.java
(original)
+++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/modifier/UserParameterXMLParser.java
Tue Dec 23 15:09:47 2014
@@ -31,8 +31,7 @@ import org.xml.sax.XMLReader;
  * Parse an XML file to obtain parameter name and value information for all
  * users defined in the XML file.
  *
- * This test element is deprecated. Test plans should use User Parameters instead.
- * @deprecated
+ * @deprecated This test element is deprecated. Test plans should use User Parameters instead.
  */
 @Deprecated
 public class UserParameterXMLParser {
@@ -43,6 +42,10 @@ public class UserParameterXMLParser {
      * @param xmlURI
      *            name of the XML to load users parameter data
      * @return all users name value pairs obtained from XML file
+     * @throws SAXException
+     *             when XML pointed to by <code>xmlURI</code> is not valid
+     * @throws IOException
+     *             when XML pointed to by <code>xmlURI</code> can not be read
      */
     public List<Map<String, String>> getXMLParameters(String xmlURI) throws SAXException,
IOException {
         // create instances needed for parsing

Modified: jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/BaseJMSSampler.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/BaseJMSSampler.java?rev=1647589&r1=1647588&r2=1647589&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/BaseJMSSampler.java
(original)
+++ jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/BaseJMSSampler.java
Tue Dec 23 15:09:47 2014
@@ -86,7 +86,7 @@ public abstract class BaseJMSSampler ext
     /**
      * set the initial context factory
      *
-     * @param icf
+     * @param icf the initial context factory
      */
     public void setJNDIIntialContextFactory(String icf) {
         setProperty(JNDI_INITIAL_CONTEXT_FAC, icf);
@@ -123,7 +123,7 @@ public abstract class BaseJMSSampler ext
     /**
      * set the connection factory for
      *
-     * @param factory
+     * @param factory the connection factory
      */
     public void setConnectionFactory(String factory) {
         setProperty(CONN_FACTORY, factory);
@@ -160,7 +160,7 @@ public abstract class BaseJMSSampler ext
     /**
      * set the username to login into the jms server if needed
      *
-     * @param user
+     * @param user the name of the user
      */
     public void setUsername(String user) {
         setProperty(PRINCIPAL, user);
@@ -178,7 +178,7 @@ public abstract class BaseJMSSampler ext
     /**
      * Set the password to login to the jms server
      *
-     * @param pwd
+     * @param pwd the password to use for login on the jms server
      */
     public void setPassword(String pwd) {
         setProperty(CREDENTIALS, pwd);
@@ -196,7 +196,7 @@ public abstract class BaseJMSSampler ext
     /**
      * set the number of iterations the sampler should aggregate
      *
-     * @param count
+     * @param count the number of iterations
      */
     public void setIterations(String count) {
         setProperty(ITERATIONS, count);
@@ -223,7 +223,7 @@ public abstract class BaseJMSSampler ext
     /**
      * Set whether authentication is required for JNDI
      *
-     * @param useAuth
+     * @param useAuth flag whether to use authentication
      */
     public void setUseAuth(boolean useAuth) {
         setProperty(USE_AUTH, useAuth);
@@ -267,9 +267,9 @@ public abstract class BaseJMSSampler ext
     }
 
     /**
-     * if the sampler should use jndi.properties file, call the method with true
+     * if the sampler should use jndi.properties file, call the method with the string "true"
      *
-     * @param properties
+     * @param properties flag whether to use <em>jndi.properties</em> file
      */
     public void setUseJNDIProperties(String properties) {
         setProperty(USE_PROPERTIES_FILE, properties);
@@ -279,7 +279,8 @@ public abstract class BaseJMSSampler ext
      * return whether the sampler should use properties file instead of UI
      * parameters.
      *
-     * @return  whether the sampler should use properties file instead of UI parameters.
+     * @return the string "true" when the sampler should use properties file
+     *         instead of UI parameters, the string "false" otherwise.
      */
     public String getUseJNDIProperties() {
         return getPropertyAsString(USE_PROPERTIES_FILE);
@@ -297,7 +298,7 @@ public abstract class BaseJMSSampler ext
     /**
      * if the sampler should use a static destination, call the method with true
      *
-     * @param isStatic
+     * @param isStatic flag whether the destination is a static destination
      */
     public void setDestinationStatic(boolean isStatic) {
         setProperty(DESTINATION_STATIC, isStatic, DESTINATION_STATIC_DEFAULT);

Modified: jmeter/trunk/src/reports/org/apache/jmeter/testelement/AbstractChart.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/reports/org/apache/jmeter/testelement/AbstractChart.java?rev=1647589&r1=1647588&r2=1647589&view=diff
==============================================================================
--- jmeter/trunk/src/reports/org/apache/jmeter/testelement/AbstractChart.java (original)
+++ jmeter/trunk/src/reports/org/apache/jmeter/testelement/AbstractChart.java Tue Dec 23 15:09:47
2014
@@ -87,9 +87,11 @@ public abstract class AbstractChart exte
     }
 
     /**
-     * The X data labels should be either the filename, date or some
-     * other series of values
+     * The X data labels should be either the filename, date or some other
+     * series of values
+     * 
      * @param label
+     *            the label of the x axis
      */
     public void setXLabel(String label) {
         setProperty(REPORT_CHART_X_LABEL,label);
@@ -114,10 +116,11 @@ public abstract class AbstractChart exte
     }
 
     /**
-     * The title is a the name for the chart. A page link will
-     * be generated using the title. The title will also be
-     * used for a page index.
+     * The title is a the name for the chart. A page link will be generated
+     * using the title. The title will also be used for a page index.
+     * 
      * @param title
+     *            the title of the chart
      */
     public void setTitle(String title) {
         setProperty(REPORT_CHART_TITLE,title);
@@ -133,9 +136,11 @@ public abstract class AbstractChart exte
     }
 
     /**
-     * The caption is a description for the chart explaining
-     * what the chart means.
+     * The caption is a description for the chart explaining what the chart
+     * means.
+     * 
      * @param caption
+     *            the caption of the chart
      */
     public void setCaption(String caption) {
         setProperty(REPORT_CHART_CAPTION,caption);
@@ -156,7 +161,9 @@ public abstract class AbstractChart exte
 
     /**
      * set the width of the graph
+     * 
      * @param width
+     *            the width of the chart
      */
     public void setWidth(String width) {
         setProperty(REPORT_CHART_WIDTH,String.valueOf(width));
@@ -177,7 +184,9 @@ public abstract class AbstractChart exte
 
     /**
      * set the height of the graph
+     * 
      * @param height
+     *            the height of the chart
      */
     public void setHeight(String height) {
         setProperty(REPORT_CHART_HEIGHT,String.valueOf(height));
@@ -203,18 +212,24 @@ public abstract class AbstractChart exte
 
     /**
      * in case an user wants set the bufferdImage
+     * 
      * @param img
+     *            the {@link BufferedImage} to render into
      */
     public void setBufferedImage(BufferedImage img) {
         this.image = img;
     }
 
     /**
-     * convienance method for getting the selected value. Rather than use
-     * Method.invoke(Object,Object[]), it's simpler to just check which
-     * column is selected and call the method directly.
+     * Convenience method for getting the selected value. Rather than use
+     * Method.invoke(Object,Object[]), it's simpler to just check which column
+     * is selected and call the method directly.
+     * 
      * @param stat
-     * @return value
+     *            the container with the aggregated data
+     * @return the statistical value chosen from the container depending on the
+     *         x-axis, or {@link Double#NaN} if no corresponding stats could be
+     *         found
      */
     public double getValue(SamplingStatCalculator stat) {
         if (this.getXAxis().equals(AbstractTable.REPORT_TABLE_50_PERCENT)) {



Mime
View raw message