Author: fschumacher
Date: Sun Dec 21 21:26:14 2014
New Revision: 1647215
URL: http://svn.apache.org/r1647215
Log:
Bug 57193: Add param and return tags to javadoc
Bugzilla Id: 57193
Modified:
jmeter/trunk/src/core/org/apache/jmeter/samplers/SampleListener.java
jmeter/trunk/src/core/org/apache/jmeter/samplers/SampleSaveConfiguration.java
jmeter/trunk/src/core/org/apache/jmeter/samplers/Sampler.java
jmeter/trunk/src/core/org/apache/jmeter/samplers/StatisticalSampleResult.java
jmeter/trunk/src/core/org/apache/jmeter/save/SaveGraphicsService.java
jmeter/trunk/src/core/org/apache/jmeter/save/ScriptWrapperConverter.java
Modified: jmeter/trunk/src/core/org/apache/jmeter/samplers/SampleListener.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/samplers/SampleListener.java?rev=1647215&r1=1647214&r2=1647215&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/samplers/SampleListener.java
(original)
+++ jmeter/trunk/src/core/org/apache/jmeter/samplers/SampleListener.java Sun
Dec 21 21:26:14 2014
@@ -28,16 +28,25 @@ package org.apache.jmeter.samplers;
public interface SampleListener {
/**
* A sample has started and stopped.
+ *
+ * @param e
+ * the {@link SampleEvent} that has occurred
*/
void sampleOccurred(SampleEvent e);
/**
* A sample has started.
+ *
+ * @param e
+ * the {@link SampleEvent} that has started
*/
void sampleStarted(SampleEvent e);
/**
* A sample has stopped.
+ *
+ * @param e
+ * the {@link SampleEvent} that has stopped
*/
void sampleStopped(SampleEvent e);
}
Modified:
jmeter/trunk/src/core/org/apache/jmeter/samplers/SampleSaveConfiguration.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/samplers/SampleSaveConfiguration.java?rev=1647215&r1=1647214&r2=1647215&view=diff
==============================================================================
---
jmeter/trunk/src/core/org/apache/jmeter/samplers/SampleSaveConfiguration.java
(original)
+++
jmeter/trunk/src/core/org/apache/jmeter/samplers/SampleSaveConfiguration.java
Sun Dec 21 21:26:14 2014
@@ -55,12 +55,13 @@ import org.apache.log.Logger;
* Holds details of which sample attributes to save.
*
* The pop-up dialogue for this is created by the class SavePropertyDialog,
which assumes:
- * For each field XXX
- * - methods have the signature "boolean saveXXX()"
- * - a corresponding "void setXXX(boolean)" method
- * - messages.properties contains the key save_XXX
- *
- *
+ * <p>
+ * For each field <em>XXX</em>
+ * <ul>
+ * <li>methods have the signature "boolean save<em>XXX</em>()"</li>
+ * <li>a corresponding "void set<em>XXX</em>(boolean)" method</li>
+ * <li>messages.properties contains the key save_<em>XXX</em></li>
+ * </ul>
*/
public class SampleSaveConfiguration implements Cloneable, Serializable {
private static final long serialVersionUID = 7L;
@@ -777,6 +778,10 @@ public class SampleSaveConfiguration imp
/**
* Only intended for use by OldSaveService (and test cases)
+ *
+ * @param fmt
+ * format of the date to be saved. If <code>null</code>
+ * milliseconds since epoch will be printed
*/
public void setFormatter(DateFormat fmt){
printMilliseconds = (fmt == null); // maintain relationship
Modified: jmeter/trunk/src/core/org/apache/jmeter/samplers/Sampler.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/samplers/Sampler.java?rev=1647215&r1=1647214&r2=1647215&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/samplers/Sampler.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/samplers/Sampler.java Sun Dec 21
21:26:14 2014
@@ -32,6 +32,10 @@ public interface Sampler extends Seriali
/**
* Obtains statistics about the given Entry, and packages the information
* into a SampleResult.
+ *
+ * @param e
+ * the Entry (TODO seems to be unused)
+ * @return information about the sample
*/
SampleResult sample(Entry e);
}
Modified:
jmeter/trunk/src/core/org/apache/jmeter/samplers/StatisticalSampleResult.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/samplers/StatisticalSampleResult.java?rev=1647215&r1=1647214&r2=1647215&view=diff
==============================================================================
---
jmeter/trunk/src/core/org/apache/jmeter/samplers/StatisticalSampleResult.java
(original)
+++
jmeter/trunk/src/core/org/apache/jmeter/samplers/StatisticalSampleResult.java
Sun Dec 21 21:26:14 2014
@@ -43,8 +43,8 @@ public class StatisticalSampleResult ext
*
* @deprecated Needs to be replaced when multiple sample results are
sorted out
*
- * @param stamp
- * @param elapsed
+ * @param stamp this may be a start time or an end time (both in
milliseconds)
+ * @param elapsed time in milliseconds
*/
@Deprecated
public StatisticalSampleResult(long stamp, long elapsed) {
Modified: jmeter/trunk/src/core/org/apache/jmeter/save/SaveGraphicsService.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/save/SaveGraphicsService.java?rev=1647215&r1=1647214&r2=1647215&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/save/SaveGraphicsService.java
(original)
+++ jmeter/trunk/src/core/org/apache/jmeter/save/SaveGraphicsService.java Sun
Dec 21 21:26:14 2014
@@ -102,8 +102,12 @@ public class SaveGraphicsService {
* TIFF.
*
* @param filename
+ * name of the file to store the image into
* @param type
+ * of the image to be stored. Can be one of {@value #PNG} for
PNG
+ * or {@value #TIFF} for TIFF
* @param component
+ * to draw the image on
*/
public void saveJComponent(String filename, int type, JComponent
component) {
Dimension size = component.getSize();
@@ -124,7 +128,9 @@ public class SaveGraphicsService {
* Use Batik to save a PNG of the graph
*
* @param filename
+ * name of the file to store the image into
* @param image
+ * to be stored
*/
public void savePNGWithBatik(String filename, BufferedImage image) {
File outfile = new File(filename);
@@ -147,7 +153,9 @@ public class SaveGraphicsService {
* Use Batik to save a TIFF file of the graph
*
* @param filename
+ * name of the file to store the image into
* @param image
+ * to be stored
*/
public void saveTIFFWithBatik(String filename, BufferedImage image) {
File outfile = new File(filename);
Modified:
jmeter/trunk/src/core/org/apache/jmeter/save/ScriptWrapperConverter.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/save/ScriptWrapperConverter.java?rev=1647215&r1=1647214&r2=1647215&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/save/ScriptWrapperConverter.java
(original)
+++ jmeter/trunk/src/core/org/apache/jmeter/save/ScriptWrapperConverter.java
Sun Dec 21 21:26:14 2014
@@ -43,6 +43,8 @@ public class ScriptWrapperConverter impl
/**
* Returns the converter version; used to check for possible
* incompatibilities
+ *
+ * @return the version of the converter
*/
public static String getVersion() {
return "$Revision$"; // $NON-NLS-1$
