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/23 20:04:35 UTC
svn commit: r1641242 - in /jmeter/trunk/src/components/org/apache/jmeter:
modifiers/ reporters/ timers/ visualizers/
Author: fschumacher
Date: Sun Nov 23 19:04:35 2014
New Revision: 1641242
URL: http://svn.apache.org/r1641242
Log:
Bug 57193: Add param and return tags to javadoc
Bugzilla Id: 57193
Modified:
jmeter/trunk/src/components/org/apache/jmeter/modifiers/UserParameters.java
jmeter/trunk/src/components/org/apache/jmeter/reporters/MailerModel.java
jmeter/trunk/src/components/org/apache/jmeter/timers/ConstantTimer.java
jmeter/trunk/src/components/org/apache/jmeter/timers/SyncTimer.java
jmeter/trunk/src/components/org/apache/jmeter/visualizers/AxisGraph.java
jmeter/trunk/src/components/org/apache/jmeter/visualizers/BarGraph.java
jmeter/trunk/src/components/org/apache/jmeter/visualizers/DistributionGraph.java
jmeter/trunk/src/components/org/apache/jmeter/visualizers/Graph.java
jmeter/trunk/src/components/org/apache/jmeter/visualizers/LineGraph.java
Modified: jmeter/trunk/src/components/org/apache/jmeter/modifiers/UserParameters.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/modifiers/UserParameters.java?rev=1641242&r1=1641241&r2=1641242&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/modifiers/UserParameters.java (original)
+++ jmeter/trunk/src/components/org/apache/jmeter/modifiers/UserParameters.java Sun Nov 23 19:04:35 2014
@@ -72,6 +72,9 @@ public class UserParameters extends Abst
* The list of names of the variables to hold values. This list must come in
* the same order as the sub lists that are given to
* {@link #setThreadLists(Collection)}.
+ *
+ * @param list
+ * The ordered list of names
*/
public void setNames(Collection<?> list) {
setProperty(new CollectionProperty(NAMES, list));
@@ -81,6 +84,9 @@ public class UserParameters extends Abst
* The list of names of the variables to hold values. This list must come in
* the same order as the sub lists that are given to
* {@link #setThreadLists(CollectionProperty)}.
+ *
+ * @param list
+ * The ordered list of names
*/
public void setNames(CollectionProperty list) {
setProperty(list);
@@ -91,6 +97,9 @@ public class UserParameters extends Abst
* collection of values for a simulated user. As many different sets of
* values can be supplied in this fashion to cause JMeter to set different
* values to variables for different test threads.
+ *
+ * @param threadLists
+ * The list of lists of values for each user thread
*/
public void setThreadLists(Collection<?> threadLists) {
setProperty(new CollectionProperty(THREAD_VALUES, threadLists));
@@ -101,6 +110,9 @@ public class UserParameters extends Abst
* collection of values for a simulated user. As many different sets of
* values can be supplied in this fashion to cause JMeter to set different
* values to variables for different test threads.
+ *
+ * @param threadLists
+ * The list of lists of values for each user thread
*/
public void setThreadLists(CollectionProperty threadLists) {
setProperty(threadLists);
Modified: jmeter/trunk/src/components/org/apache/jmeter/reporters/MailerModel.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/reporters/MailerModel.java?rev=1641242&r1=1641241&r2=1641242&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/reporters/MailerModel.java (original)
+++ jmeter/trunk/src/components/org/apache/jmeter/reporters/MailerModel.java Sun Nov 23 19:04:35 2014
@@ -296,7 +296,9 @@ public class MailerModel extends Abstrac
* @param smtpHost
* the smtp-server used to send the mail.
* @throws MessagingException
+ * if the building of the message fails
* @throws AddressException
+ * if any of the addresses is wrong
*/
public void sendMail(String from, List<String> vEmails, String subject, String attText, String smtpHost)
throws AddressException, MessagingException {
@@ -321,6 +323,7 @@ public class MailerModel extends Abstrac
* @param user the login used to authenticate
* @param password the password used to authenticate
* @param mailAuthType {@link MailAuthType} Security policy
+ * @param debug Flag whether debug messages for the mail session should be generated
* @throws AddressException If mail address is wrong
* @throws MessagingException If building MimeMessage fails
*/
Modified: jmeter/trunk/src/components/org/apache/jmeter/timers/ConstantTimer.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/timers/ConstantTimer.java?rev=1641242&r1=1641241&r2=1641242&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/timers/ConstantTimer.java (original)
+++ jmeter/trunk/src/components/org/apache/jmeter/timers/ConstantTimer.java Sun Nov 23 19:04:35 2014
@@ -46,7 +46,7 @@ public class ConstantTimer extends Abstr
/**
* Set the delay for this timer.
- *
+ * @param delay The delay for this timer
*/
public void setDelay(String delay) {
setProperty(DELAY, delay);
@@ -54,6 +54,7 @@ public class ConstantTimer extends Abstr
/**
* Set the range (not used for this timer).
+ * @param range Not used
*
*/
public void setRange(double range) {
Modified: jmeter/trunk/src/components/org/apache/jmeter/timers/SyncTimer.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/timers/SyncTimer.java?rev=1641242&r1=1641241&r2=1641242&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/timers/SyncTimer.java (original)
+++ jmeter/trunk/src/components/org/apache/jmeter/timers/SyncTimer.java Sun Nov 23 19:04:35 2014
@@ -74,9 +74,15 @@ public class SyncTimer extends AbstractT
/**
- * @return int
+ * Wait until all threads called await on this timer
+ *
+ * @return The arrival index of the current thread
* @throws InterruptedException
+ * when interrupted while waiting, or the interrupted status
+ * is set on entering this method
* @throws BrokenBarrierException
+ * if the barrier is reset while waiting or broken on
+ * entering or while waiting
* @see java.util.concurrent.CyclicBarrier#await()
*/
public int await() throws InterruptedException, BrokenBarrierException{
@@ -84,12 +90,21 @@ public class SyncTimer extends AbstractT
}
/**
+ * Wait until all threads called await on this timer
+ *
* @param timeout
+ * The timeout in <code>timeUnit</code> units
* @param timeUnit
- * @return int
+ * The time unit for the <code>timeout</code>
+ * @return The arrival index of the current thread
* @throws InterruptedException
+ * when interrupted while waiting, or the interrupted status
+ * is set on entering this method
* @throws BrokenBarrierException
- * @throws TimeoutException
+ * if the barrier is reset while waiting or broken on
+ * entering or while waiting
+ * @throws TimeoutException
+ * if the specified time elapses
* @see java.util.concurrent.CyclicBarrier#await()
*/
public int await(long timeout, TimeUnit timeUnit) throws InterruptedException, BrokenBarrierException, TimeoutException {
Modified: jmeter/trunk/src/components/org/apache/jmeter/visualizers/AxisGraph.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/visualizers/AxisGraph.java?rev=1641242&r1=1641241&r2=1641242&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/visualizers/AxisGraph.java (original)
+++ jmeter/trunk/src/components/org/apache/jmeter/visualizers/AxisGraph.java Sun Nov 23 19:04:35 2014
@@ -101,15 +101,15 @@ public class AxisGraph extends JPanel {
}
/**
- * @param layout
+ * @param layout The {@link LayoutManager} to use
*/
public AxisGraph(LayoutManager layout) {
super(layout);
}
/**
- * @param layout
- * @param isDoubleBuffered
+ * @param layout The {@link LayoutManager} to use
+ * @param isDoubleBuffered Flag whether double buffering should be used
*/
public AxisGraph(LayoutManager layout, boolean isDoubleBuffered) {
super(layout, isDoubleBuffered);
@@ -117,7 +117,7 @@ public class AxisGraph extends JPanel {
/**
* Expects null array when no data not empty array
- * @param data
+ * @param data The data to be drawn
*/
public void setData(double[][] data) {
this.data = data;
@@ -141,7 +141,7 @@ public class AxisGraph extends JPanel {
/**
* Expects null array when no labels not empty array
- * @param labels
+ * @param labels The labels for the x axis
*/
public void setXAxisLabels(String[] labels) {
this.xAxisLabels = labels;
Modified: jmeter/trunk/src/components/org/apache/jmeter/visualizers/BarGraph.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/visualizers/BarGraph.java?rev=1641242&r1=1641241&r2=1641242&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/visualizers/BarGraph.java (original)
+++ jmeter/trunk/src/components/org/apache/jmeter/visualizers/BarGraph.java Sun Nov 23 19:04:35 2014
@@ -34,9 +34,9 @@ public class BarGraph {
private Color backColor;
/**
- * @param resString
- * @param checked
- * @param backColor
+ * @param resString The label of this component
+ * @param checked Flag whether the corresponding checkbox should be checked
+ * @param backColor The color of the background
*/
public BarGraph(String resString, boolean checked, Color backColor) {
super();
Modified: jmeter/trunk/src/components/org/apache/jmeter/visualizers/DistributionGraph.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/visualizers/DistributionGraph.java?rev=1641242&r1=1641241&r2=1641242&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/visualizers/DistributionGraph.java (original)
+++ jmeter/trunk/src/components/org/apache/jmeter/visualizers/DistributionGraph.java Sun Nov 23 19:04:35 2014
@@ -60,6 +60,7 @@ public class DistributionGraph extends J
/**
* Constructor for the Graph object.
+ * @param model The container for the aggregated sample data
*/
public DistributionGraph(SamplingStatCalculator model) {
this();
Modified: jmeter/trunk/src/components/org/apache/jmeter/visualizers/Graph.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/visualizers/Graph.java?rev=1641242&r1=1641241&r2=1641242&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/visualizers/Graph.java (original)
+++ jmeter/trunk/src/components/org/apache/jmeter/visualizers/Graph.java Sun Nov 23 19:04:35 2014
@@ -70,6 +70,7 @@ public class Graph extends JComponent im
/**
* Constructor for the Graph object.
+ * @param model The container for samples and statistics
*/
public Graph(CachingStatCalculator model) {
this();
Modified: jmeter/trunk/src/components/org/apache/jmeter/visualizers/LineGraph.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/visualizers/LineGraph.java?rev=1641242&r1=1641241&r2=1641242&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/visualizers/LineGraph.java (original)
+++ jmeter/trunk/src/components/org/apache/jmeter/visualizers/LineGraph.java Sun Nov 23 19:04:35 2014
@@ -82,15 +82,15 @@ public class LineGraph extends JPanel {
}
/**
- * @param layout
+ * @param layout The {@link LayoutManager} to be used
*/
public LineGraph(LayoutManager layout) {
super(layout);
}
/**
- * @param layout
- * @param isDoubleBuffered
+ * @param layout The {@link LayoutManager} to be used
+ * @param isDoubleBuffered Flag whether double buffering should be used
*/
public LineGraph(LayoutManager layout, boolean isDoubleBuffered) {
super(layout, isDoubleBuffered);
@@ -183,9 +183,11 @@ public class LineGraph extends JPanel {
}
/**
- * Since we only have 4 shapes, the method will start with the
- * first shape and keep cycling through the shapes in order.
+ * Since we only have 4 shapes, the method will start with the first shape
+ * and keep cycling through the shapes in order.
+ *
* @param count
+ * The number of shapes to be created
* @return the first n shapes
*/
public Shape[] createShapes(int count) {
@@ -209,9 +211,11 @@ public class LineGraph extends JPanel {
}
/**
- *
+ * Create a given number of {@link Stroke}s
+ *
* @param count
- * @return the first count strokes
+ * The number of strokes to be created
+ * @return the first <code>count</code> strokes
*/
public Stroke[] createStrokes(int count) {
Stroke[] str = new Stroke[count];
@@ -231,9 +235,11 @@ public class LineGraph extends JPanel {
/**
* return an array of Paint with different colors. The current
- * implementation will cycle through 12 colors if a line graph
- * has more than 12 entries
+ * implementation will cycle through 12 colors if a line graph has more than
+ * 12 entries
+ *
* @param count
+ * The number of {@link Paint}s to be created
* @return an array of Paint with different colors
*/
public Paint[] createPaint(int count) {