jmeter-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From fschumac...@apache.org
Subject svn commit: r1648732 - in /jmeter/trunk/src: junit/org/apache/jmeter/protocol/java/sampler/ monitor/components/org/apache/jmeter/monitor/util/ monitor/components/org/apache/jmeter/visualizers/ monitor/model/org/apache/jmeter/monitor/parser/ protocol/ht...
Date Wed, 31 Dec 2014 17:04:58 GMT
Author: fschumacher
Date: Wed Dec 31 17:04:58 2014
New Revision: 1648732

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

Modified:
    jmeter/trunk/src/junit/org/apache/jmeter/protocol/java/sampler/JUnitSampler.java
    jmeter/trunk/src/monitor/components/org/apache/jmeter/monitor/util/Stats.java
    jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorAccumModel.java
    jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorStats.java
    jmeter/trunk/src/monitor/model/org/apache/jmeter/monitor/parser/MonitorHandler.java
    jmeter/trunk/src/monitor/model/org/apache/jmeter/monitor/parser/ParserImpl.java
    jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/ProxyControl.java
    jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/LogFilter.java
    jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/NVPair.java
    jmeter/trunk/src/protocol/mail/org/apache/jmeter/protocol/mail/sampler/MailReaderSampler.java

Modified: jmeter/trunk/src/junit/org/apache/jmeter/protocol/java/sampler/JUnitSampler.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/junit/org/apache/jmeter/protocol/java/sampler/JUnitSampler.java?rev=1648732&r1=1648731&r2=1648732&view=diff
==============================================================================
--- jmeter/trunk/src/junit/org/apache/jmeter/protocol/java/sampler/JUnitSampler.java (original)
+++ jmeter/trunk/src/junit/org/apache/jmeter/protocol/java/sampler/JUnitSampler.java Wed Dec
31 17:04:58 2014
@@ -142,7 +142,7 @@ public class JUnitSampler extends Abstra
     /**
      * Set the string label used to create an instance of the
      * test with the string constructor.
-     * @param constr
+     * @param constr the string passed to the constructor
      */
     public void setConstructorString(String constr)
     {
@@ -150,7 +150,7 @@ public class JUnitSampler extends Abstra
     }
 
     /**
-     * get the string passed to the string constructor
+     * @return the string passed to the string constructor
      */
     public String getConstructorString()
     {
@@ -158,23 +158,23 @@ public class JUnitSampler extends Abstra
     }
 
     /**
-     * Return the name of the method to test
+     * @return the name of the method to test
      */
     public String getMethod(){
         return getPropertyAsString(METHOD);
     }
 
     /**
-     * Method should add the JUnit testXXX method to the list at
+     * Method should add the JUnit <em>testXXX</em> method to the list at
      * the end, since the sequence matters.
-     * @param methodName
+     * @param methodName name of the method to test
      */
     public void setMethod(String methodName){
         setProperty(METHOD,methodName);
     }
 
     /**
-     * get the success message
+     * @return the success message
      */
     public String getSuccess(){
         return getPropertyAsString(SUCCESS);
@@ -182,30 +182,30 @@ public class JUnitSampler extends Abstra
 
     /**
      * set the success message
-     * @param success
+     * @param success message to be used for success
      */
     public void setSuccess(String success){
         setProperty(SUCCESS,success);
     }
 
     /**
-     * get the success code defined by the user
+     * @return the success code defined by the user
      */
     public String getSuccessCode(){
         return getPropertyAsString(SUCCESSCODE);
     }
 
     /**
-     * set the succes code. the success code should
+     * Set the success code. The success code should
      * be unique.
-     * @param code
+     * @param code unique success code
      */
     public void setSuccessCode(String code){
         setProperty(SUCCESSCODE,code);
     }
 
     /**
-     * get the failure message
+     * @return the failure message
      */
     public String getFailure(){
         return getPropertyAsString(FAILURE);
@@ -213,14 +213,14 @@ public class JUnitSampler extends Abstra
 
     /**
      * set the failure message
-     * @param fail
+     * @param fail the failure message
      */
     public void setFailure(String fail){
         setProperty(FAILURE,fail);
     }
 
     /**
-     * The failure code is used by other components
+     * @return The failure code that is used by other components
      */
     public String getFailureCode(){
         return getPropertyAsString(FAILURECODE);
@@ -228,14 +228,14 @@ public class JUnitSampler extends Abstra
 
     /**
      * Provide some unique code to denote a type of failure
-     * @param code
+     * @param code unique code to denote the type of failure
      */
     public void setFailureCode(String code){
         setProperty(FAILURECODE,code);
     }
 
     /**
-     * return the descriptive error for the test
+     * @return the descriptive error for the test
      */
     public String getError(){
         return getPropertyAsString(ERROR);
@@ -244,16 +244,16 @@ public class JUnitSampler extends Abstra
     /**
      * provide a descriptive error for the test method. For
      * a description of the difference between failure and
-     * error, please refer to the following url
-     * http://junit.sourceforge.net/doc/faq/faq.htm#tests_9
-     * @param error
+     * error, please refer to the
+     * <a href="http://junit.sourceforge.net/doc/faq/faq.htm#tests_9">junit faq</a>
+     * @param error the description of the error
      */
     public void setError(String error){
         setProperty(ERROR,error);
     }
 
     /**
-     * return the error code for the test method. it should
+     * @return the error code for the test method. It should
      * be an unique error code.
      */
     public String getErrorCode(){
@@ -261,24 +261,24 @@ public class JUnitSampler extends Abstra
     }
 
     /**
-     * provide an unique error code for when the test
+     * Provide an unique error code for when the test
      * does not pass the assert test.
-     * @param code
+     * @param code unique error code
      */
     public void setErrorCode(String code){
         setProperty(ERRORCODE,code);
     }
 
     /**
-     * return the comma separated string for the filter
+     * @return the comma separated string for the filter
      */
     public String getFilterString(){
         return getPropertyAsString(FILTER);
     }
 
     /**
-     * set the filter string in comman separated format
-     * @param text
+     * set the filter string in comma separated format
+     * @param text comma separated filter
      */
     public void setFilterString(String text){
         setProperty(FILTER,text);
@@ -288,6 +288,8 @@ public class JUnitSampler extends Abstra
      * if the sample shouldn't call setup/teardown, the
      * method returns true. It's meant for onetimesetup
      * and onetimeteardown.
+     * 
+     * @return flag whether setup/teardown methods should not be called
      */
     public boolean getDoNotSetUpTearDown(){
         return getPropertyAsBoolean(DOSETUP);
@@ -295,7 +297,8 @@ public class JUnitSampler extends Abstra
 
     /**
      * set the setup/teardown option
-     * @param setup
+     *
+     * @param setup flag whether the setup/teardown methods should not be called
      */
     public void setDoNotSetUpTearDown(boolean setup){
         setProperty(DOSETUP,String.valueOf(setup));
@@ -306,6 +309,8 @@ public class JUnitSampler extends Abstra
      * which means users have to explicitly set the sampler to
      * append the assert errors. Because of how junit works, there
      * should only be one error
+     *
+     * @return flag whether errors should be appended
      */
     public boolean getAppendError() {
         return getPropertyAsBoolean(APPEND_ERROR,false);
@@ -321,9 +326,11 @@ public class JUnitSampler extends Abstra
     }
 
     /**
-     * If append exception is not set, by default it is set to false.
-     * Users have to explicitly set it to true to see the exceptions
+     * If append exception is not set, by default it is set to <code>false</code>.
+     * Users have to explicitly set it to <code>true</code> to see the exceptions
      * in the result tree.
+     * 
+     * @return flag whether exceptions should be appended to the result tree
      */
     public boolean getAppendException() {
         return getPropertyAsBoolean(APPEND_EXCEPTION,false);
@@ -703,6 +710,7 @@ public class JUnitSampler extends Abstra
     /**
      * 
      * @param createOneInstancePerSample
+     *            flag whether a new instance for each call should be created
      */
     public void setCreateOneInstancePerSample(boolean createOneInstancePerSample) {
         this.setProperty(CREATE_INSTANCE_PER_SAMPLE, createOneInstancePerSample, CREATE_INSTANCE_PER_SAMPLE_DEFAULT);

Modified: jmeter/trunk/src/monitor/components/org/apache/jmeter/monitor/util/Stats.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/monitor/components/org/apache/jmeter/monitor/util/Stats.java?rev=1648732&r1=1648731&r2=1648732&view=diff
==============================================================================
--- jmeter/trunk/src/monitor/components/org/apache/jmeter/monitor/util/Stats.java (original)
+++ jmeter/trunk/src/monitor/components/org/apache/jmeter/monitor/util/Stats.java Wed Dec
31 17:04:58 2014
@@ -62,7 +62,7 @@ public class Stats {
      * threads. The current factor is 50/50.
      * <p>
      *
-     * @param stat
+     * @param stat status information about the server
      * @return calculated load value
      */
     public static int calculateLoad(Status stat) {
@@ -98,14 +98,16 @@ public class Stats {
      * Method should calculate if the server is: dead, active, warning or
      * healthy. We do this by looking at the current busy threads.
      * <ol>
-     * <li> free &gt; spare is healthy
-     * <li> free &lt; spare is active
-     * <li> busy threads &gt; 75% is warning
-     * <li> none of the above is dead
+     * <li>free &gt; spare is {@link Stats#HEALTHY healthy}</li>
+     * <li>free &lt; spare is {@link Stats#ACTIVE active}</li>
+     * <li>busy threads &gt; 75% is {@link Stats#WARNING warning}</li>
+     * <li>none of the above is {@link Stats#DEAD dead}</li>
      * </ol>
      *
-     * @param stat
-     * @return integer representing the status
+     * @param stat status information about the server
+     * @return integer representing the status (one of {@link Stats#HEALTHY
+     *         HEALTHY}, {@link Stats#ACTIVE ACTIVE}, {@link Stats#WARNING
+     *         WARNING} or {@link Stats#DEAD DEAD})
      */
     public static int calculateStatus(Status stat) {
         if (stat != null && stat.getConnector().size() > 0) {
@@ -133,7 +135,7 @@ public class Stats {
      * is an integer between 1 and 100. It is the percent memory used. Changed
      * this to be more like other system monitors. Peter Lin 2-11-05
      *
-     * @param stat
+     * @param stat status information about the jvm
      * @return memory load
      */
     public static int calculateMemoryLoad(Status stat) {
@@ -151,7 +153,7 @@ public class Stats {
      * Method will calculate the thread load: busy / max = load. The value is an
      * integer between 1 and 100. It is the percent busy.
      *
-     * @param stat
+     * @param stat status information about the server
      * @return thread load
      */
     public static int calculateThreadLoad(Status stat) {

Modified: jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorAccumModel.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorAccumModel.java?rev=1648732&r1=1648731&r2=1648732&view=diff
==============================================================================
--- jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorAccumModel.java
(original)
+++ jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorAccumModel.java
Wed Dec 31 17:04:58 2014
@@ -86,7 +86,7 @@ public class MonitorAccumModel implement
      * Method will look up the server in the map. The MonitorModel will be added
      * to an existing list, or a new one will be created.
      *
-     * @param model
+     * @param model the {@link MonitorModel} to be added
      */
     public void addSample(MonitorModel model) {
         this.current = model;
@@ -119,7 +119,7 @@ public class MonitorAccumModel implement
     /**
      * Get all MonitorModels matching the URL.
      *
-     * @param url
+     * @param url to be matched against
      * @return list
      */
     public List<MonitorModel> getAllSamples(String url) {
@@ -134,7 +134,9 @@ public class MonitorAccumModel implement
      * Get the MonitorModel matching the url.
      *
      * @param url
-     * @return list
+     *            to be matched against
+     * @return the first {@link MonitorModel} registered for this
+     *         <code>url</code>
      */
     public MonitorModel getSample(String url) {
         if (serverListMap.containsKey(url)) {
@@ -151,6 +153,7 @@ public class MonitorAccumModel implement
      * not a monitor sample, the method will ignore it.
      *
      * @param sample
+     *            {@link SampleResult} with the result of the status request
      */
     public void addSample(SampleResult sample) {
         URL surl = null;
@@ -186,6 +189,7 @@ public class MonitorAccumModel implement
      * object with the current timestamp and health "dead".
      *
      * @param url
+     *            URL from where the status should have come
      */
     public void noResponse(URL url) {
         notifyListeners(createNewMonitorModel(url));
@@ -196,6 +200,7 @@ public class MonitorAccumModel implement
      * used when the server fails to respond fully, or is dead.
      *
      * @param url
+     *            URL from where the status should have come
      * @return new MonitorModel
      */
     public MonitorModel createNewMonitorModel(URL url) {
@@ -221,6 +226,7 @@ public class MonitorAccumModel implement
      * notify the listeners with the MonitorModel object.
      *
      * @param model
+     *            the {@link MonitorModel} that should be sent to the listeners
      */
     public void notifyListeners(MonitorModel model) {
         for (int idx = 0; idx < listeners.size(); idx++) {
@@ -234,6 +240,7 @@ public class MonitorAccumModel implement
      * listener of the change.
      *
      * @param listener
+     *            the {@link MonitorListener} that should be added
      */
     public void addListener(MonitorListener listener) {
         listeners.add(listener);

Modified: jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorStats.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorStats.java?rev=1648732&r1=1648731&r2=1648732&view=diff
==============================================================================
--- jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorStats.java (original)
+++ jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorStats.java Wed
Dec 31 17:04:58 2014
@@ -18,6 +18,7 @@ package org.apache.jmeter.visualizers;
 
 import java.io.Serializable;
 
+import org.apache.jmeter.monitor.util.Stats;
 import org.apache.jmeter.testelement.AbstractTestElement;
 
 /*
@@ -61,14 +62,28 @@ public class MonitorStats extends Abstra
      * Default constructor
      *
      * @param health
+     *            Health of the server. Has to be one of {@link Stats#HEALTHY
+     *            HEALTHY}, {@link Stats#ACTIVE ACTIVE}, {@link Stats#WARNING
+     *            WARNING} or {@link Stats#DEAD DEAD}
      * @param load
+     *            load of the server as integer from a range in between 1 and
+     *            100
      * @param cpuload
+     *            cpu load of the server as integer from range between 1 and 100
      * @param memload
+     *            load of the server as integer from a range in between 1 and
+     *            100
      * @param threadload
+     *            thread load of the server as an integer from a range in
+     *            between 1 and 100
      * @param host
+     *            name of the host from which the status was taken
      * @param port
+     *            port from which the status was taken
      * @param protocol
+     *            over which the status was taken
      * @param time
+     *            time in milliseconds when this status was created
      */
     public MonitorStats(int health, int load, int cpuload, int memload, int threadload, String
host, String port,
             String protocol, long time) {

Modified: jmeter/trunk/src/monitor/model/org/apache/jmeter/monitor/parser/MonitorHandler.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/monitor/model/org/apache/jmeter/monitor/parser/MonitorHandler.java?rev=1648732&r1=1648731&r2=1648732&view=diff
==============================================================================
--- jmeter/trunk/src/monitor/model/org/apache/jmeter/monitor/parser/MonitorHandler.java (original)
+++ jmeter/trunk/src/monitor/model/org/apache/jmeter/monitor/parser/MonitorHandler.java Wed
Dec 31 17:04:58 2014
@@ -60,7 +60,7 @@ public class MonitorHandler extends Defa
     // private List workerslist;
 
     /**
-     *
+     * @param factory {@link ObjectFactory} to use
      */
     public MonitorHandler(ObjectFactory factory) {
         super();
@@ -99,9 +99,11 @@ public class MonitorHandler extends Defa
      * </p>
      *
      * @param uri
+     *            The namespace uri, or the empty string, if no namespace is available
      * @param localName
      *            The element type name.
      * @param qName
+     *            The qualified name, or the empty string (must not be <code>null</code>)
      * @param attributes
      *            The specified or defaulted attributes.
      * @exception org.xml.sax.SAXException
@@ -248,6 +250,7 @@ public class MonitorHandler extends Defa
      * </p>
      *
      * @param uri
+     *            the namespace uri, or the empty string, if no namespace is available
      * @param localName
      *            The element type name.
      * @param qName
@@ -320,7 +323,7 @@ public class MonitorHandler extends Defa
      * Convienance method for parsing long. If the string was not a number, the
      * method returns zero.
      *
-     * @param data
+     * @param data string representation of a {@link Long}
      * @return the value as a long
      */
     public long parseLong(String data) {
@@ -338,7 +341,7 @@ public class MonitorHandler extends Defa
     /**
      * Convienance method for parsing integers.
      *
-     * @param data
+     * @param data string representation of an {@link Integer}
      * @return the value as an integer
      */
     public int parseInt(String data) {

Modified: jmeter/trunk/src/monitor/model/org/apache/jmeter/monitor/parser/ParserImpl.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/monitor/model/org/apache/jmeter/monitor/parser/ParserImpl.java?rev=1648732&r1=1648731&r2=1648732&view=diff
==============================================================================
--- jmeter/trunk/src/monitor/model/org/apache/jmeter/monitor/parser/ParserImpl.java (original)
+++ jmeter/trunk/src/monitor/model/org/apache/jmeter/monitor/parser/ParserImpl.java Wed Dec
31 17:04:58 2014
@@ -44,7 +44,7 @@ public abstract class ParserImpl impleme
     private final ObjectFactory FACTORY;
 
     /**
-     *
+     * @param factory {@link ObjectFactory} to use
      */
     public ParserImpl(ObjectFactory factory) {
         super();
@@ -67,7 +67,7 @@ public abstract class ParserImpl impleme
     /**
      * parse byte array and return Status object
      *
-     * @param bytes
+     * @param bytes bytes to be parsed
      * @return Status
      */
     @Override
@@ -89,7 +89,7 @@ public abstract class ParserImpl impleme
     }
 
     /**
-     * @param content
+     * @param content text to be parsed
      * @return Status
      */
     @Override
@@ -112,6 +112,9 @@ public abstract class ParserImpl impleme
 
     /**
      * @param result
+     *            {@link SampleResult} out of which the
+     *            {@link SampleResult#getResponseData() reponseData} will be
+     *            used for parsing
      * @return Status
      */
     @Override

Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/ProxyControl.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/ProxyControl.java?rev=1648732&r1=1648731&r2=1648732&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/ProxyControl.java
(original)
+++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/ProxyControl.java
Wed Dec 31 17:04:58 2014
@@ -346,7 +346,7 @@ public class ProxyControl extends Generi
     }
 
     /**
-     * @param b
+     * @param b flag whether keep alive should be used
      */
     public void setUseKeepAlive(boolean b) {
         useKeepAlive = b;
@@ -372,7 +372,7 @@ public class ProxyControl extends Generi
     }
 
     /**
-     * @param b
+     * @param b flag whether regex matching should be used
      */
     public void setRegexMatch(boolean b) {
         regexMatch = b;
@@ -515,6 +515,8 @@ public class ProxyControl extends Generi
     /**
      * Sets the target node where the samples generated by the proxy have to be
      * stored.
+     * 
+     * @param target target node to store generated samples
      */
     public void setTarget(JMeterTreeNode target) {
         this.target = target;

Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/LogFilter.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/LogFilter.java?rev=1648732&r1=1648731&r2=1648732&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/LogFilter.java
(original)
+++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/LogFilter.java
Wed Dec 31 17:04:58 2014
@@ -139,6 +139,7 @@ public class LogFilter implements Filter
      * Give the filter a list of files to include
      *
      * @param filenames
+     *            list of files to include
      * @see org.apache.jmeter.protocol.http.util.accesslog.Filter#includeFiles(java.lang.String[])
      */
     @Override
@@ -153,6 +154,7 @@ public class LogFilter implements Filter
      * Give the filter a list of files to exclude
      *
      * @param filenames
+     *            list of files to exclude
      * @see org.apache.jmeter.protocol.http.util.accesslog.Filter#excludeFiles(java.lang.String[])
      */
     @Override
@@ -169,6 +171,7 @@ public class LogFilter implements Filter
      * implementation is not complete.
      *
      * @param regexp
+     *            list of regular expressions
      * @see org.apache.jmeter.protocol.http.util.accesslog.Filter#includePattern(String[])
      */
     @Override
@@ -190,6 +193,7 @@ public class LogFilter implements Filter
      * implementation is not complete.
      *
      * @param regexp
+     *            list of regular expressions
      *
      * @see org.apache.jmeter.protocol.http.util.accesslog.Filter#excludePattern(String[])
      */
@@ -211,13 +215,13 @@ public class LogFilter implements Filter
      * should be used. Therefore, the method will only return true if the entry
      * should be used. Since the interface defines both inclusion and exclusion,
      * that means by default inclusion filtering assumes all entries are
-     * excluded unless it matches. In the case of exlusion filtering, it assumes
+     * excluded unless it matches. In the case of exclusion filtering, it assumes
      * all entries are included unless it matches, which means it should be
      * excluded.
      *
      * @see org.apache.jmeter.protocol.http.util.accesslog.Filter#isFiltered(String, TestElement)
-     * @param path
-     * @return boolean
+     * @param path path to be tested
+     * @return <code>true</code> if entry should be excluded
      */
     @Override
     public boolean isFiltered(String path,TestElement el) {
@@ -267,6 +271,7 @@ public class LogFilter implements Filter
      * won't bother with the rest of the filenames in the array.
      *
      * @param text
+     *            name of the file to tested (must not be <code>null</code>)
      * @return boolean include
      */
     public boolean incFile(String text) {
@@ -290,6 +295,7 @@ public class LogFilter implements Filter
      * won't bother with the rest of the filenames in the array.
      *
      * @param text
+     *            name of the file to be tested (must not be null)
      * @return boolean exclude
      */
     public boolean excFile(String text) {
@@ -310,7 +316,7 @@ public class LogFilter implements Filter
     }
 
     /**
-     * The current implemenation assumes the user has checked the regular
+     * The current implementation assumes the user has checked the regular
      * expressions so that they don't cancel each other. The basic assumption is
      * the method will return true if the text should be filtered. If not, it
      * will return false, which means it should not be filtered.
@@ -366,7 +372,7 @@ public class LogFilter implements Filter
     }
 
     /**
-     * Method uses indexOf to replace the old extension with the new extesion.
+     * Method uses indexOf to replace the old extension with the new extension.
      * It might be good to use regular expression, but for now this is a simple
      * method. The method isn't designed to replace multiple instances of the
      * text, since that isn't how file extensions work. If the string contains
@@ -374,7 +380,10 @@ public class LogFilter implements Filter
      * be replaced.
      *
      * @param text
-     * @return boolean
+     *            name of the file in which the extension should be replaced
+     *            (must not be null)
+     * @return <code>true</code> if the extension could be replaced,
+     *         <code>false</code> otherwise
      */
     public boolean replaceExtension(String text) {
         int pt = text.indexOf(this.OLDEXT);
@@ -412,7 +421,9 @@ public class LogFilter implements Filter
      * create a new pattern object from the string.
      *
      * @param pattern
-     * @return Pattern
+     *            string representation of the perl5 compatible regex pattern
+     * @return compiled Pattern, or <code>null</code> if no pattern could be
+     *         compiled
      */
     public Pattern createPattern(String pattern) {
         try {

Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/NVPair.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/NVPair.java?rev=1648732&r1=1648731&r2=1648732&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/NVPair.java
(original)
+++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/NVPair.java
Wed Dec 31 17:04:58 2014
@@ -38,8 +38,8 @@ public class NVPair {
      * The constructor takes a name and value which represent HTTP request
      * parameters.
      *
-     * @param name
-     * @param value
+     * @param name name of the request parameter
+     * @param value value of the request parameter
      */
     public NVPair(String name, String value) {
         this.NAME = name;
@@ -49,7 +49,7 @@ public class NVPair {
     /**
      * Set the name
      *
-     * @param name
+     * @param name name of the request parameter
      */
     public void setName(String name) {
         this.NAME = name;
@@ -58,7 +58,7 @@ public class NVPair {
     /**
      * Set the value
      *
-     * @param value
+     * @param value value of the request parameter
      */
     public void setValue(String value) {
         this.VALUE = value;

Modified: jmeter/trunk/src/protocol/mail/org/apache/jmeter/protocol/mail/sampler/MailReaderSampler.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/mail/org/apache/jmeter/protocol/mail/sampler/MailReaderSampler.java?rev=1648732&r1=1648731&r2=1648732&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/mail/org/apache/jmeter/protocol/mail/sampler/MailReaderSampler.java
(original)
+++ jmeter/trunk/src/protocol/mail/org/apache/jmeter/protocol/mail/sampler/MailReaderSampler.java
Wed Dec 31 17:04:58 2014
@@ -394,7 +394,7 @@ public class MailReaderSampler extends A
      * server. Either MailReaderSampler.TYPE_IMAP[S] or
      * MailReaderSampler.TYPE_POP3[S]. Default is MailReaderSampler.TYPE_POP3.
      *
-     * @param serverType
+     * @param serverType protocol to use
      */
     public void setServerType(String serverType) {
         setProperty(SERVER_TYPE, serverType);
@@ -454,7 +454,7 @@ public class MailReaderSampler extends A
     }
 
     /**
-     * @param password
+     * @param password the password to use
      */
     public void setPassword(String password) {
         setProperty(PASSWORD, password);



Mime
View raw message