jmeter-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Felix Schumacher <felix.schumac...@internetallee.de>
Subject Re: svn commit: r1816008 - in /jmeter/trunk: src/core/org/apache/jmeter/gui/ src/core/org/apache/jmeter/threads/ src/functions/org/apache/jmeter/functions/ src/protocol/http/org/apache/jmeter/protocol/http/control/ src/protocol/jms/org/apache/jmeter/protoc...
Date Wed, 22 Nov 2017 08:18:29 GMT


Am 22. November 2017 08:53:54 MEZ schrieb milamber@apache.org:
>Author: milamber
>Date: Wed Nov 22 07:53:54 2017
>New Revision: 1816008
>
>URL: http://svn.apache.org/viewvc?rev=1816008&view=rev
>Log:
>Fix some javadoc issues
>
>Modified:
>    jmeter/trunk/src/core/org/apache/jmeter/gui/GuiPackage.java
>    jmeter/trunk/src/core/org/apache/jmeter/threads/JMeterContext.java
>    jmeter/trunk/src/functions/org/apache/jmeter/functions/CSVRead.java
> jmeter/trunk/src/functions/org/apache/jmeter/functions/ChangeCase.java
>jmeter/trunk/src/functions/org/apache/jmeter/functions/DateTimeConvertFunction.java
>jmeter/trunk/src/functions/org/apache/jmeter/functions/DigestEncodeFunction.java
>jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/CacheManager.java
>jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/render/package-info.java
>jmeter/trunk/test/src/org/apache/jmeter/functions/TestDateTimeConvertFunction.java
>jmeter/trunk/test/src/org/apache/jmeter/functions/TestDigestFunction.java
>
>Modified: jmeter/trunk/src/core/org/apache/jmeter/gui/GuiPackage.java
>URL:
>http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/gui/GuiPackage.java?rev=1816008&r1=1816007&r2=1816008&view=diff
>==============================================================================
>--- jmeter/trunk/src/core/org/apache/jmeter/gui/GuiPackage.java
>(original)
>+++ jmeter/trunk/src/core/org/apache/jmeter/gui/GuiPackage.java Wed Nov
>22 07:53:54 2017
>@@ -956,6 +956,8 @@ public final class GuiPackage implements
>     /**
>      * Should Save Before Run 
>      * Decide by Preference and if not exists by Property
>+     * 
>+     * @return boolean Should Save Before Run
>      */
>     public boolean shouldSaveBeforeRun() {
>         String sbr = PREFS.get(SBR_PREFS_KEY, null);
>
>Modified:
>jmeter/trunk/src/core/org/apache/jmeter/threads/JMeterContext.java
>URL:
>http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/threads/JMeterContext.java?rev=1816008&r1=1816007&r2=1816008&view=diff
>==============================================================================
>--- jmeter/trunk/src/core/org/apache/jmeter/threads/JMeterContext.java
>(original)
>+++ jmeter/trunk/src/core/org/apache/jmeter/threads/JMeterContext.java
>Wed Nov 22 07:53:54 2017
>@@ -102,6 +102,8 @@ public class JMeterContext {
> 
>     /**
>      * Internally called by JMeter, never call it directly
>+     * 
>+     * @param vars JMeterVariables
>      */
>     public void setVariables(JMeterVariables vars) {
>         this.variables = vars;
>@@ -113,6 +115,8 @@ public class JMeterContext {
> 
>     /**
>      * Internally called by JMeter, never call it directly
>+     * 
>+     * @param result SampleResult
>      */
>     public void setPreviousResult(SampleResult result) {
>         this.previousResult = result;
>@@ -124,6 +128,8 @@ public class JMeterContext {
> 
>     /**
>      * Internally called by JMeter, never call it directly
>+     * 
>+     * @param sampler Sampler
>      */
>     public void setCurrentSampler(Sampler sampler) {
>         this.previousSampler = currentSampler;
>@@ -219,9 +225,8 @@ public class JMeterContext {
>     /**
>* if set to <code>true</code> current loop iteration will be
>interrupted and 
>      * JMeter will go to next iteration
>-     *
>-     * @param restartNextLoop
>-     *            flag whether restart will occur
>+     * 
>+     * @return boolean restartNextLoop
>      */
>     public boolean isStartNextThreadLoop() {
>         return restartNextLoop;
>
>Modified:
>jmeter/trunk/src/functions/org/apache/jmeter/functions/CSVRead.java
>URL:
>http://svn.apache.org/viewvc/jmeter/trunk/src/functions/org/apache/jmeter/functions/CSVRead.java?rev=1816008&r1=1816007&r2=1816008&view=diff
>==============================================================================
>--- jmeter/trunk/src/functions/org/apache/jmeter/functions/CSVRead.java
>(original)
>+++ jmeter/trunk/src/functions/org/apache/jmeter/functions/CSVRead.java
>Wed Nov 22 07:53:54 2017
>@@ -35,11 +35,11 @@ import org.slf4j.LoggerFactory;
>* line-thru the data in the CSV file - one line per each test. E.g.
>inserting
>  * the following in the test scripts :
>  *
>- * <pre>{@code
>+ * <pre>{@code}

Are you sure the closing bracket is correct here? 

>* ${__CSVRead(c:/BOF/abcd.csv,0)} // read (first) line of
>'c:/BOF/abcd.csv' ,
>- * return the 1<sup>st</sup> column ( represented by the '0'),
>+ * return the 1st column (represented by the '0'),

Is the sup doing any harm? 

>* ${__CSVRead(c:/BOF/abcd.csv,1)} // read (first) line of
>'c:/BOF/abcd.csv' ,
>- * return the 2<sup>nd</sup> column ( represented by the '1'),
>+ * return the 2nd column (represented by the '1'),
>* ${__CSVRead(c:/BOF/abcd.csv,next())} // Go to next line of
>'c:/BOF/abcd.csv'
>  * }</pre>
>* NOTE: A single instance of each different file is opened and used for
>all
>
>Modified:
>jmeter/trunk/src/functions/org/apache/jmeter/functions/ChangeCase.java
>URL:
>http://svn.apache.org/viewvc/jmeter/trunk/src/functions/org/apache/jmeter/functions/ChangeCase.java?rev=1816008&r1=1816007&r2=1816008&view=diff
>==============================================================================
>---
>jmeter/trunk/src/functions/org/apache/jmeter/functions/ChangeCase.java
>(original)
>+++
>jmeter/trunk/src/functions/org/apache/jmeter/functions/ChangeCase.java
>Wed Nov 22 07:53:54 2017
>@@ -42,7 +42,7 @@ import org.slf4j.LoggerFactory;
>  * <li>capitalize</li>
>  * <li>camel cases</li>
>  * <li></li>
>- * 
>+ * </ul>
>  * 
>  * @since 4.0
>  *
>@@ -164,7 +164,7 @@ public class ChangeCase extends Abstract
>         /**
>          * Get ChangeCaseMode by mode
>          * 
>-         * @param mode
>+         * @param mode Change new case mode
>          * @return relevant ChangeCaseMode
>          */
>         public static ChangeCaseMode typeOf(String mode) {
>
>Modified:
>jmeter/trunk/src/functions/org/apache/jmeter/functions/DateTimeConvertFunction.java
>URL:
>http://svn.apache.org/viewvc/jmeter/trunk/src/functions/org/apache/jmeter/functions/DateTimeConvertFunction.java?rev=1816008&r1=1816007&r2=1816008&view=diff
>==============================================================================
>---
>jmeter/trunk/src/functions/org/apache/jmeter/functions/DateTimeConvertFunction.java
>(original)
>+++
>jmeter/trunk/src/functions/org/apache/jmeter/functions/DateTimeConvertFunction.java
>Wed Nov 22 07:53:54 2017
>@@ -31,7 +31,7 @@ import org.slf4j.Logger;
> import org.slf4j.LoggerFactory;
> 
> /**
>- * DateConvert function to change date format<br/>
>+ * DateConvert function to change date format

Some form of break is needed here, don't you think? 

>  * Can optionally store it in a variable.
>  * 
>  * @since 4.0
>
>Modified:
>jmeter/trunk/src/functions/org/apache/jmeter/functions/DigestEncodeFunction.java
>URL:
>http://svn.apache.org/viewvc/jmeter/trunk/src/functions/org/apache/jmeter/functions/DigestEncodeFunction.java?rev=1816008&r1=1816007&r2=1816008&view=diff
>==============================================================================
>---
>jmeter/trunk/src/functions/org/apache/jmeter/functions/DigestEncodeFunction.java
>(original)
>+++
>jmeter/trunk/src/functions/org/apache/jmeter/functions/DigestEncodeFunction.java
>Wed Nov 22 07:53:54 2017
>@@ -39,7 +39,7 @@ import java.util.List;
> 
> /**
>* Digest Encode Function that provides computing of different SHA-XXX,
>can
>- * uppercase the result and store it in a variable.<br/>
>+ * uppercase the result and store it in a variable.

See above

Regards, 
 Felix 

>* Algorithm names can be specified using MessageDigest Algorithms names
>at
>  * <a href=
>*
>"https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html"
>
>Modified:
>jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/CacheManager.java
>URL:
>http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/CacheManager.java?rev=1816008&r1=1816007&r2=1816008&view=diff
>==============================================================================
>---
>jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/CacheManager.java
>(original)
>+++
>jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/CacheManager.java
>Wed Nov 22 07:53:54 2017
>@@ -117,7 +117,7 @@ public class CacheManager extends Config
>* @param lastModified formatted string containing the last modification
>time of the http response
>* @param expires formatted string containing the expiration time of the
>http response
>          * @param etag of the http response
>-         * @deprecated use {@link CacheEntry(String lastModified, Date
>expires, String etag, String varyHeader)} instead
>+         * @deprecated use {@link CacheEntry#CacheEntry(String
>lastModified, Date expires, String etag, String varyHeader)} instead
>          */
>         @Deprecated
>    public CacheEntry(String lastModified, Date expires, String etag) {
>
>Modified:
>jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/render/package-info.java
>URL:
>http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/render/package-info.java?rev=1816008&r1=1816007&r2=1816008&view=diff
>==============================================================================
>---
>jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/render/package-info.java
>(original)
>+++
>jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/render/package-info.java
>Wed Nov 22 07:53:54 2017
>@@ -17,7 +17,7 @@
> 
> /**
>  * Package contains all renderer for JMS publisher.
>- * @see Renderers
>- * @see MessageRenderer
>+ * @see org.apache.jmeter.protocol.jms.sampler.render.Renderers
>+ * @see org.apache.jmeter.protocol.jms.sampler.render.MessageRenderer
>  */
> package org.apache.jmeter.protocol.jms.sampler.render;
>
>Modified:
>jmeter/trunk/test/src/org/apache/jmeter/functions/TestDateTimeConvertFunction.java
>URL:
>http://svn.apache.org/viewvc/jmeter/trunk/test/src/org/apache/jmeter/functions/TestDateTimeConvertFunction.java?rev=1816008&r1=1816007&r2=1816008&view=diff
>==============================================================================
>---
>jmeter/trunk/test/src/org/apache/jmeter/functions/TestDateTimeConvertFunction.java
>(original)
>+++
>jmeter/trunk/test/src/org/apache/jmeter/functions/TestDateTimeConvertFunction.java
>Wed Nov 22 07:53:54 2017
>@@ -33,7 +33,7 @@ import org.junit.Before;
> import org.junit.Test;
> 
> /**
>- * Test {@link DateConvertFunction}
>+ * Test {@link DateTimeConvertFunction}
>  * 
>  * @since 4.0
>  */
>
>Modified:
>jmeter/trunk/test/src/org/apache/jmeter/functions/TestDigestFunction.java
>URL:
>http://svn.apache.org/viewvc/jmeter/trunk/test/src/org/apache/jmeter/functions/TestDigestFunction.java?rev=1816008&r1=1816007&r2=1816008&view=diff
>==============================================================================
>---
>jmeter/trunk/test/src/org/apache/jmeter/functions/TestDigestFunction.java
>(original)
>+++
>jmeter/trunk/test/src/org/apache/jmeter/functions/TestDigestFunction.java
>Wed Nov 22 07:53:54 2017
>@@ -33,7 +33,7 @@ import org.junit.Before;
> import org.junit.Test;
> /**
>  * Test Digest function
>- * @see DigestEncode
>+ * @see DigestEncodeFunction
>  * @since 4.0
>  *
>  */

Mime
View raw message