You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jmeter.apache.org by fs...@apache.org on 2014/11/13 20:17:21 UTC
svn commit: r1639469 - in /jmeter/trunk/src:
components/org/apache/jmeter/visualizers/ core/org/apache/jmeter/control/
core/org/apache/jmeter/util/ functions/org/apache/jmeter/functions/
jorphan/org/apache/jorphan/io/ protocol/http/org/apache/jmeter/pr...
Author: fschumacher
Date: Thu Nov 13 19:17:21 2014
New Revision: 1639469
URL: http://svn.apache.org/r1639469
Log:
Bug 57193: Escape entities like &, < and >, as they are not
allowed in javadocs. Place code tag around code-fragments in javadoc.
Bugzilla Id: 57193
Modified:
jmeter/trunk/src/components/org/apache/jmeter/visualizers/Spline3.java
jmeter/trunk/src/core/org/apache/jmeter/control/Controller.java
jmeter/trunk/src/core/org/apache/jmeter/control/GenericController.java
jmeter/trunk/src/core/org/apache/jmeter/control/IfController.java
jmeter/trunk/src/core/org/apache/jmeter/util/SlowSocket.java
jmeter/trunk/src/functions/org/apache/jmeter/functions/EscapeHtml.java
jmeter/trunk/src/jorphan/org/apache/jorphan/io/TextFile.java
jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/config/gui/UrlConfigGui.java
jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/HTMLParser.java
jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HTTPSampleResult.java
jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/TCLogParser.java
jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/Utils.java
jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/ReceiveSubscriber.java
Modified: jmeter/trunk/src/components/org/apache/jmeter/visualizers/Spline3.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/visualizers/Spline3.java?rev=1639469&r1=1639468&r2=1639469&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/visualizers/Spline3.java (original)
+++ jmeter/trunk/src/components/org/apache/jmeter/visualizers/Spline3.java Thu Nov 13 19:17:21 2014
@@ -68,9 +68,9 @@ import org.apache.log.Logger;
* <P>
* Here is a little piece of code showing how to use this class :
*
- * <PRE> // ... float[] nodes = {3F, 2F, 4F, 1F, 2.5F, 5F, 3F}; Spline3 curve =
+ * <PRE>// ... float[] nodes = {3F, 2F, 4F, 1F, 2.5F, 5F, 3F}; Spline3 curve =
* new Spline3(nodes); // ... public void paint(Graphics g) { int[] plot =
- * curve.getPlots(); for (int i = 1; i < n; i++) { g.drawLine(i - 1, plot[i -
+ * curve.getPlots(); for (int i = 1; i < n; i++) { g.drawLine(i - 1, plot[i -
* 1], i, plot[i]); } } // ...
*
* </PRE>
Modified: jmeter/trunk/src/core/org/apache/jmeter/control/Controller.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/control/Controller.java?rev=1639469&r1=1639468&r2=1639469&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/control/Controller.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/control/Controller.java Thu Nov 13 19:17:21 2014
@@ -24,8 +24,8 @@ import org.apache.jmeter.testelement.Tes
/**
* This interface is used by JMeterThread in the following manner:
- *
- * while (running && (sampler = controller.next()) != null)
+ * <p>
+ * <code>while (running && (sampler = controller.next()) != null)</code>
*/
public interface Controller extends TestElement {
/**
Modified: jmeter/trunk/src/core/org/apache/jmeter/control/GenericController.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/control/GenericController.java?rev=1639469&r1=1639468&r2=1639469&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/control/GenericController.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/control/GenericController.java Thu Nov 13 19:17:21 2014
@@ -45,7 +45,7 @@ import org.apache.log.Logger;
* The main entry point is next(), which is called by by JMeterThread as follows:
* </p>
* <p>
- * <code>while (running && (sampler = controller.next()) != null)</code>
+ * <code>while (running && (sampler = controller.next()) != null)</code>
* </p>
*/
public class GenericController extends AbstractTestElement implements Controller, Serializable, TestCompilerHelper {
Modified: jmeter/trunk/src/core/org/apache/jmeter/control/IfController.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/control/IfController.java?rev=1639469&r1=1639468&r2=1639469&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/control/IfController.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/control/IfController.java Thu Nov 13 19:17:21 2014
@@ -44,7 +44,7 @@ import org.mozilla.javascript.Scriptable
* Thread-Group (set to loop a number of times or indefinitely,
* ... Samplers ... (e.g. Counter )
* ... Other Controllers ....
- * ... IfController ( condition set to something like - ${counter}<10)
+ * ... IfController ( condition set to something like - ${counter} < 10)
* ... statements to perform if condition is true
* ...
* ... Other Controllers /Samplers }
@@ -81,14 +81,14 @@ public class IfController extends Generi
}
/**
- * Condition Accessor - this is gonna be like ${count}<10
+ * Condition Accessor - this is gonna be like <code>${count} < 10</code>
*/
public void setCondition(String condition) {
setProperty(new StringProperty(CONDITION, condition));
}
/**
- * Condition Accessor - this is gonna be like ${count}<10
+ * Condition Accessor - this is gonna be like <code>${count} < 10</code>
*/
public String getCondition() {
return getPropertyAsString(CONDITION);
Modified: jmeter/trunk/src/core/org/apache/jmeter/util/SlowSocket.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/util/SlowSocket.java?rev=1639469&r1=1639468&r2=1639469&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/util/SlowSocket.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/util/SlowSocket.java Thu Nov 13 19:17:21 2014
@@ -57,7 +57,7 @@ public class SlowSocket extends Socket {
* @param localPort local port
*
* @throws IOException
- * @throws IllegalArgumentException if cps <=0
+ * @throws IllegalArgumentException if cps <= 0
*/
public SlowSocket(int cps, String host, int port, InetAddress localAddr, int localPort) throws IOException {
super(host, port, localAddr, localPort);
@@ -75,7 +75,7 @@ public class SlowSocket extends Socket {
*
* @throws UnknownHostException
* @throws IOException
- * @throws IllegalArgumentException if cps <=0
+ * @throws IllegalArgumentException if cps <= 0
*/
public SlowSocket(int cps, String host, int port) throws UnknownHostException, IOException {
super(host, port);
Modified: jmeter/trunk/src/functions/org/apache/jmeter/functions/EscapeHtml.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/functions/org/apache/jmeter/functions/EscapeHtml.java?rev=1639469&r1=1639468&r2=1639469&view=diff
==============================================================================
--- jmeter/trunk/src/functions/org/apache/jmeter/functions/EscapeHtml.java (original)
+++ jmeter/trunk/src/functions/org/apache/jmeter/functions/EscapeHtml.java Thu Nov 13 19:17:21 2014
@@ -34,7 +34,7 @@ import org.apache.jmeter.util.JMeterUtil
* <p>
* For example:
* </p>
- * <p><code>"bread" & "butter"</code></p>
+ * <p><code>"bread" & "butter"</code></p>
* becomes:
* <p>
* <code>&quot;bread&quot; &amp; &quot;butter&quot;</code>.
Modified: jmeter/trunk/src/jorphan/org/apache/jorphan/io/TextFile.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/jorphan/org/apache/jorphan/io/TextFile.java?rev=1639469&r1=1639468&r2=1639469&view=diff
==============================================================================
--- jmeter/trunk/src/jorphan/org/apache/jorphan/io/TextFile.java (original)
+++ jmeter/trunk/src/jorphan/org/apache/jorphan/io/TextFile.java Thu Nov 13 19:17:21 2014
@@ -57,9 +57,9 @@ public class TextFile extends File {
* encoding.
*
* @param filename
- * File to be read & written through this object.
+ * File to be read and written through this object.
* @param encoding
- * Encoding to be used when reading & writing this file.
+ * Encoding to be used when reading and writing this file.
*/
public TextFile(File filename, String encoding) {
super(filename.toString());
@@ -71,7 +71,7 @@ public class TextFile extends File {
* default encoding.
*
* @param filename
- * File to be read & written through this object.
+ * File to be read and written through this object.
*/
public TextFile(File filename) {
super(filename.toString());
@@ -82,7 +82,7 @@ public class TextFile extends File {
* default encoding.
*
* @param filename
- * Name of the file to be read & written through this object.
+ * Name of the file to be read and written through this object.
*/
public TextFile(String filename) {
super(filename);
@@ -93,9 +93,9 @@ public class TextFile extends File {
* encoding.
*
* @param filename
- * Name of the file to be read & written through this object.
+ * Name of the file to be read and written through this object.
* @param encoding
- * Encoding to be used when reading & writing this file.
+ * Encoding to be used when reading and writing this file.
*/
public TextFile(String filename, String encoding) {
super(filename);
@@ -160,7 +160,7 @@ public class TextFile extends File {
}
/**
- * @return Encoding being used to read & write this file.
+ * @return Encoding being used to read and write this file.
*/
public String getEncoding() {
return encoding;
@@ -168,7 +168,7 @@ public class TextFile extends File {
/**
* @param string
- * Encoding to be used to read & write this file.
+ * Encoding to be used to read and write this file.
*/
public void setEncoding(String string) {
encoding = string;
Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/config/gui/UrlConfigGui.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/config/gui/UrlConfigGui.java?rev=1639469&r1=1639468&r2=1639469&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/config/gui/UrlConfigGui.java (original)
+++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/config/gui/UrlConfigGui.java Thu Nov 13 19:17:21 2014
@@ -56,10 +56,12 @@ import org.apache.jorphan.gui.JLabeledCh
/**
* Basic URL / HTTP Request configuration:
- * - host and port
- * - connect and response timeouts
- * - path, method, encoding, parameters
- * - redirects & keepalive
+ * <ul>
+ * <li>host and port</li>
+ * <li>connect and response timeouts</li>
+ * <li>path, method, encoding, parameters</li>
+ * <li>redirects and keepalive</li>
+ * </ul>
*/
public class UrlConfigGui extends JPanel implements ChangeListener {
Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/HTMLParser.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/HTMLParser.java?rev=1639469&r1=1639468&r2=1639469&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/HTMLParser.java (original)
+++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/HTMLParser.java Thu Nov 13 19:17:21 2014
@@ -227,7 +227,7 @@ public abstract class HTMLParser {
/**
*
* @param ieVersion Float IE version
- * @return true if IE version < IE v10
+ * @return true if IE version < IE v10
*/
protected final boolean isEnableConditionalComments(Float ieVersion) {
if(ieVersion == null) {
Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HTTPSampleResult.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HTTPSampleResult.java?rev=1639469&r1=1639468&r2=1639469&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HTTPSampleResult.java (original)
+++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HTTPSampleResult.java Thu Nov 13 19:17:21 2014
@@ -91,7 +91,7 @@ public class HTTPSampleResult extends Sa
/**
* Determine whether this result is a redirect.
- * Returs true for: 301,302,303, & 307(GET or HEAD)
+ * Returns true for: 301,302,303 and 307(GET or HEAD)
* @return true iff res is an HTTP redirect response
*/
public boolean isRedirect() {
Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/TCLogParser.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/TCLogParser.java?rev=1639469&r1=1639468&r2=1639469&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/TCLogParser.java (original)
+++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/TCLogParser.java Thu Nov 13 19:17:21 2014
@@ -62,7 +62,7 @@ import org.apache.log.Logger;
* <li> tokenizes the string using question mark "?"
* <li> get the path from the first token
* <li> returns the second token and checks it for parameters
- * <li> tokenizes the string using ampersand "&"
+ * <li> tokenizes the string using ampersand "&"
* <li> parses each token to name/value pairs
* </ol>
* <p>
@@ -450,7 +450,7 @@ public class TCLogParser implements LogP
}
/**
- * Checks the string to see if it contains "&" and "=". If it does, return
+ * Checks the string to see if it contains "&" and "=". If it does, return
* true, so that it can be parsed.
*
* @param text
@@ -529,7 +529,7 @@ public class TCLogParser implements LogP
/**
* Method uses StringTokenizer to convert the string into single pairs. The
* string should conform to HTTP protocol spec, which means the name/value
- * pairs are separated by the ampersand symbol "&". Some one could write the
+ * pairs are separated by the ampersand symbol "&". Someone could write the
* querystrings by hand, but that would be round about and go against the
* purpose of this utility.
*
Modified: jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/Utils.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/Utils.java?rev=1639469&r1=1639468&r2=1639469&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/Utils.java (original)
+++ jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/Utils.java Thu Nov 13 19:17:21 2014
@@ -226,7 +226,7 @@ public final class Utils {
/**
* Converts {@link Arguments} to {@link JMSProperties} defaulting to String type
- * Used to convert version <= 2.10 test plans
+ * Used to convert version <= 2.10 test plans
* @param args {@link Arguments}
* @return jmsProperties {@link JMSProperties}
*/
Modified: jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/ReceiveSubscriber.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/ReceiveSubscriber.java?rev=1639469&r1=1639468&r2=1639469&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/ReceiveSubscriber.java (original)
+++ jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/ReceiveSubscriber.java Thu Nov 13 19:17:21 2014
@@ -104,7 +104,7 @@ public class ReceiveSubscriber implement
* <br/>
* The caller must then invoke {@link #start()} to enable message reception.
*
- * @param queueSize maximum queue size <=0 == no limit
+ * @param queueSize maximum queue size, where a queueSize <=0 means no limit
* @param useProps if true, use jndi.properties instead of
* initialContextFactory, providerUrl, securityPrincipal, securityCredentials
* @param initialContextFactory
@@ -137,7 +137,7 @@ public class ReceiveSubscriber implement
* <br/>
* The caller must then invoke {@link #start()} to enable message reception.
*
- * @param queueSize maximum queue size <=0 == no limit
+ * @param queueSize maximum queue, where a queueSize <=0 means no limit
* @param useProps if true, use jndi.properties instead of
* initialContextFactory, providerUrl, securityPrincipal, securityCredentials
* @param initialContextFactory