jmeter-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From fschumac...@apache.org
Subject svn commit: r1649775 - in /jmeter/trunk/src: core/org/apache/jmeter/config/gui/ core/org/apache/jmeter/control/ core/org/apache/jmeter/gui/ core/org/apache/jmeter/gui/action/ core/org/apache/jmeter/samplers/ core/org/apache/jmeter/testbeans/ core/org/a...
Date Tue, 06 Jan 2015 11:02:23 GMT
Author: fschumacher
Date: Tue Jan  6 11:02:22 2015
New Revision: 1649775

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

Modified:
    jmeter/trunk/src/core/org/apache/jmeter/config/gui/RowDetailDialog.java
    jmeter/trunk/src/core/org/apache/jmeter/control/ReplaceableController.java
    jmeter/trunk/src/core/org/apache/jmeter/gui/AbstractScopedJMeterGuiComponent.java
    jmeter/trunk/src/core/org/apache/jmeter/gui/Searchable.java
    jmeter/trunk/src/core/org/apache/jmeter/gui/UndoHistory.java
    jmeter/trunk/src/core/org/apache/jmeter/gui/action/AbstractAction.java
    jmeter/trunk/src/core/org/apache/jmeter/samplers/AsynchSampleSender.java
    jmeter/trunk/src/core/org/apache/jmeter/samplers/BatchSampleSender.java
    jmeter/trunk/src/core/org/apache/jmeter/samplers/DataStrippingSampleSender.java
    jmeter/trunk/src/core/org/apache/jmeter/samplers/DiskStoreSampleSender.java
    jmeter/trunk/src/core/org/apache/jmeter/samplers/HoldSampleSender.java
    jmeter/trunk/src/core/org/apache/jmeter/samplers/RemoteSampleListener.java
    jmeter/trunk/src/core/org/apache/jmeter/samplers/StandardSampleSender.java
    jmeter/trunk/src/core/org/apache/jmeter/samplers/StatisticalSampleSender.java
    jmeter/trunk/src/core/org/apache/jmeter/testbeans/BeanInfoSupport.java
    jmeter/trunk/src/core/org/apache/jmeter/testelement/TestElement.java
    jmeter/trunk/src/core/org/apache/jmeter/testelement/TestIterationListener.java
    jmeter/trunk/src/core/org/apache/jmeter/testelement/property/NumberProperty.java
    jmeter/trunk/src/core/org/apache/jmeter/threads/RemoteThreadsListener.java
    jmeter/trunk/src/core/org/apache/jmeter/threads/TestCompilerHelper.java
    jmeter/trunk/src/core/org/apache/jmeter/util/JSR223TestElement.java
    jmeter/trunk/src/core/org/apache/jmeter/util/SSLManager.java
    jmeter/trunk/src/jorphan/org/apache/jorphan/collections/HashTree.java
    jmeter/trunk/src/jorphan/org/apache/jorphan/gui/TreeTableModel.java
    jmeter/trunk/src/jorphan/org/apache/jorphan/test/UnitTestManager.java
    jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/SamplerCreator.java
    jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HTTPSamplerBaseConverter.java
    jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/HTTPResultConverter.java
    jmeter/trunk/src/reports/org/apache/jmeter/JMeterReport.java
    jmeter/trunk/src/reports/org/apache/jmeter/gui/ReportGuiPackage.java
    jmeter/trunk/src/reports/org/apache/jmeter/gui/util/DirectoryPanel.java
    jmeter/trunk/src/reports/org/apache/jmeter/gui/util/ReportFileDialoger.java
    jmeter/trunk/src/reports/org/apache/jmeter/gui/util/ReportFilePanel.java
    jmeter/trunk/src/reports/org/apache/jmeter/testelement/JTLData.java

Modified: jmeter/trunk/src/core/org/apache/jmeter/config/gui/RowDetailDialog.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/config/gui/RowDetailDialog.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/config/gui/RowDetailDialog.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/config/gui/RowDetailDialog.java Tue Jan  6 11:02:22
2015
@@ -231,7 +231,7 @@ public class RowDetailDialog extends JDi
 
     /**
      * Update model values
-     * @param actionEvent
+     * @param actionEvent the event that led to this call
      */
     protected void doUpdate(ActionEvent actionEvent) {
         tableModel.setValueAt(nameTF.getText(), selectedRow, 0);

Modified: jmeter/trunk/src/core/org/apache/jmeter/control/ReplaceableController.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/control/ReplaceableController.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/control/ReplaceableController.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/control/ReplaceableController.java Tue Jan  6
11:02:22 2015
@@ -42,7 +42,7 @@ public interface ReplaceableController {
     /**
      * Compute the replacement tree.
      *
-     * @param context
+     * @param context the starting point of the replacement
      */
     void resolveReplacementSubTree(JMeterTreeNode context);
 }

Modified: jmeter/trunk/src/core/org/apache/jmeter/gui/AbstractScopedJMeterGuiComponent.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/gui/AbstractScopedJMeterGuiComponent.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/gui/AbstractScopedJMeterGuiComponent.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/gui/AbstractScopedJMeterGuiComponent.java Tue
Jan  6 11:02:22 2015
@@ -89,6 +89,7 @@ public abstract class AbstractScopedJMet
      * Save the scope settings in the test element.
      *
      * @param testElement
+     *            the test element to save the settings into
      */
     protected void saveScopeSettings(AbstractScopedTestElement testElement) {
         if (scopePanel.isScopeParent()){
@@ -108,6 +109,7 @@ public abstract class AbstractScopedJMet
      * Show the scope settings from the test element.
      *
      * @param testElement
+     *            the test element from which the settings should be shown
      */
     protected void showScopeSettings(AbstractScopedTestElement testElement) {
         showScopeSettings(testElement, false);
@@ -117,7 +119,9 @@ public abstract class AbstractScopedJMet
      * Show the scope settings from the test element with variable scope
      *
      * @param testElement
+     *            the test element from which the settings should be shown
      * @param enableVariableButton
+     *            set true to enable the variable panel
      */
     protected void showScopeSettings(AbstractScopedTestElement testElement,
             boolean enableVariableButton) {

Modified: jmeter/trunk/src/core/org/apache/jmeter/gui/Searchable.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/gui/Searchable.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/gui/Searchable.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/gui/Searchable.java Tue Jan  6 11:02:22 2015
@@ -21,12 +21,19 @@ package org.apache.jmeter.gui;
 import java.util.List;
 
 /**
- * Interface for nodes that are searchable
+ * Interface for nodes that are searchable.
+ * <p>
+ * A {@link Searchable} component will get asked for tokens, that should be used
+ * in a search. These tokens will then be matched against a user given search
+ * string.
  */
 public interface Searchable {
     /**
+     * Get a list of all tokens that should be visible to searching
+     *
      * @return List of searchable tokens
      * @throws Exception
+     *             when something fails while getting the searchable tokens
      */
     List<String> getSearchableTokens()
         throws Exception;

Modified: jmeter/trunk/src/core/org/apache/jmeter/gui/UndoHistory.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/gui/UndoHistory.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/gui/UndoHistory.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/gui/UndoHistory.java Tue Jan  6 11:02:22 2015
@@ -56,7 +56,7 @@ public class UndoHistory implements Tree
     /**
      * Avoid storing too many elements
      *
-     * @param <T>
+     * @param <T> Class that should be held in this container
      */
     private static class LimitedArrayList<T> extends ArrayList<T> {
         /**
@@ -224,7 +224,7 @@ public class UndoHistory implements Tree
      * Load the undo item into acceptorModel tree
      *
      * @param acceptorModel tree to accept the data
-     * @param guiInstance
+     * @param guiInstance {@link GuiPackage} to be used
      */
     private void loadHistoricalTree(JMeterTreeModel acceptorModel, GuiPackage guiInstance)
{
         HashTree newModel = history.get(position).getTree();
@@ -306,7 +306,7 @@ public class UndoHistory implements Tree
     /**
      * Save tree expanded and selected state
      *
-     * @param guiPackage
+     * @param guiPackage {@link GuiPackage} to be used
      */
     private void saveTreeState(GuiPackage guiPackage) {
         savedExpanded.clear();
@@ -327,7 +327,7 @@ public class UndoHistory implements Tree
     /**
      * Restore tree expanded and selected state
      *
-     * @param guiPackage
+     * @param guiInstance GuiPackage to be used
      */
     private void restoreTreeState(GuiPackage guiInstance) {
         final JTree tree = guiInstance.getMainFrame().getTree();

Modified: jmeter/trunk/src/core/org/apache/jmeter/gui/action/AbstractAction.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/gui/action/AbstractAction.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/gui/action/AbstractAction.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/gui/action/AbstractAction.java Tue Jan  6 11:02:22
2015
@@ -45,7 +45,7 @@ public abstract class AbstractAction imp
     abstract public Set<String> getActionNames();
 
     /**
-     * @param e
+     * @param e the event that led to the call of this method
      */
     protected void popupShouldSave(ActionEvent e) {
         log.debug("popupShouldSave");

Modified: jmeter/trunk/src/core/org/apache/jmeter/samplers/AsynchSampleSender.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/samplers/AsynchSampleSender.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/samplers/AsynchSampleSender.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/samplers/AsynchSampleSender.java Tue Jan  6 11:02:22
2015
@@ -60,7 +60,9 @@ public class AsynchSampleSender extends
 
     /**
      * Processed by the RMI server code.
-     * @throws ObjectStreamException  
+     *
+     * @return this
+     * @throws ObjectStreamException never
      */
     private Object readResolve() throws ObjectStreamException{
         int capacity = getCapacity();

Modified: jmeter/trunk/src/core/org/apache/jmeter/samplers/BatchSampleSender.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/samplers/BatchSampleSender.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/samplers/BatchSampleSender.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/samplers/BatchSampleSender.java Tue Jan  6 11:02:22
2015
@@ -191,7 +191,10 @@ public class BatchSampleSender extends A
     
     /**
      * Processed by the RMI server code; acts as testStarted().
-     * @throws ObjectStreamException  
+     *
+     * @return this
+     * @throws ObjectStreamException
+     *             never
      */
     private Object readResolve() throws ObjectStreamException{
         if (isClientConfigured()) {

Modified: jmeter/trunk/src/core/org/apache/jmeter/samplers/DataStrippingSampleSender.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/samplers/DataStrippingSampleSender.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/samplers/DataStrippingSampleSender.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/samplers/DataStrippingSampleSender.java Tue Jan
 6 11:02:22 2015
@@ -95,7 +95,10 @@ public class DataStrippingSampleSender e
 
     /**
      * Processed by the RMI server code; acts as testStarted().
-     * @throws ObjectStreamException  
+     *
+     * @return this
+     * @throws ObjectStreamException
+     *             never
      */
     private Object readResolve() throws ObjectStreamException{
         log.info("Using DataStrippingSampleSender for this run");

Modified: jmeter/trunk/src/core/org/apache/jmeter/samplers/DiskStoreSampleSender.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/samplers/DiskStoreSampleSender.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/samplers/DiskStoreSampleSender.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/samplers/DiskStoreSampleSender.java Tue Jan  6
11:02:22 2015
@@ -144,7 +144,10 @@ public class DiskStoreSampleSender exten
 
     /**
      * Processed by the RMI server code; acts as testStarted().
-     * @throws ObjectStreamException  
+     *
+     * @return this
+     * @throws ObjectStreamException
+     *             never
      */
     // TODO should errors be thrown back through RMI?
     private Object readResolve() throws ObjectStreamException{

Modified: jmeter/trunk/src/core/org/apache/jmeter/samplers/HoldSampleSender.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/samplers/HoldSampleSender.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/samplers/HoldSampleSender.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/samplers/HoldSampleSender.java Tue Jan  6 11:02:22
2015
@@ -84,7 +84,10 @@ public class HoldSampleSender extends Ab
 
     /**
      * Processed by the RMI server code; acts as testStarted().
-     * @throws ObjectStreamException  
+     *
+     * @return this
+     * @throws ObjectStreamException
+     *             never
      */
     private Object readResolve() throws ObjectStreamException{
         log.warn("Using HoldSampleSender for this test run, ensure you have configured enough
memory (-Xmx) for your test"); // server        

Modified: jmeter/trunk/src/core/org/apache/jmeter/samplers/RemoteSampleListener.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/samplers/RemoteSampleListener.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/samplers/RemoteSampleListener.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/samplers/RemoteSampleListener.java Tue Jan  6
11:02:22 2015
@@ -49,7 +49,7 @@ public interface RemoteSampleListener ex
      *
      * @param samples
      *            the list of sample events to be fired locally.
-     * @throws RemoteException
+     * @throws RemoteException when calling the remote method fails
      */
     void processBatch(List<SampleEvent> samples) throws RemoteException;
 
@@ -58,7 +58,7 @@ public interface RemoteSampleListener ex
      * 
      * @param e
      *            the event with data about the completed sample
-     * @throws RemoteException
+     * @throws RemoteException when calling the remote method fails
      */
     void sampleOccurred(SampleEvent e) throws RemoteException;
 
@@ -67,7 +67,7 @@ public interface RemoteSampleListener ex
      * 
      * @param e
      *            the event with data about the started sample
-     * @throws RemoteException
+     * @throws RemoteException when calling the remote method fails
      */
     void sampleStarted(SampleEvent e) throws RemoteException;
 
@@ -76,7 +76,7 @@ public interface RemoteSampleListener ex
      * 
      * @param e
      *            the event with data about the stopped sample
-     * @throws RemoteException
+     * @throws RemoteException when calling the remote method fails
      */
     void sampleStopped(SampleEvent e) throws RemoteException;
 }

Modified: jmeter/trunk/src/core/org/apache/jmeter/samplers/StandardSampleSender.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/samplers/StandardSampleSender.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/samplers/StandardSampleSender.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/samplers/StandardSampleSender.java Tue Jan  6
11:02:22 2015
@@ -75,7 +75,10 @@ public class StandardSampleSender extend
 
     /**
      * Processed by the RMI server code; acts as testStarted().
-     * @throws ObjectStreamException  
+     *
+     * @return this
+     * @throws ObjectStreamException
+     *             never
      */
     private Object readResolve() throws ObjectStreamException{
         log.info("Using StandardSampleSender for this test run");        

Modified: jmeter/trunk/src/core/org/apache/jmeter/samplers/StatisticalSampleSender.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/samplers/StatisticalSampleSender.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/samplers/StatisticalSampleSender.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/samplers/StatisticalSampleSender.java Tue Jan
 6 11:02:22 2015
@@ -203,7 +203,8 @@ public class StatisticalSampleSender ext
 
     /**
      * Processed by the RMI server code; acts as testStarted().
-     * @throws ObjectStreamException
+     * @return this
+     * @throws ObjectStreamException never
      */
     private Object readResolve() throws ObjectStreamException{
         if (isClientConfigured()) {

Modified: jmeter/trunk/src/core/org/apache/jmeter/testbeans/BeanInfoSupport.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/testbeans/BeanInfoSupport.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/testbeans/BeanInfoSupport.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/testbeans/BeanInfoSupport.java Tue Jan  6 11:02:22
2015
@@ -102,6 +102,9 @@ public abstract class BeanInfoSupport ex
 
     /**
      * Construct a BeanInfo for the given class.
+     *
+     * @param beanClass
+     *            class for which to construct a BeanInfo
      */
     protected BeanInfoSupport(Class<? extends TestBean> beanClass) {
         this.beanClass= beanClass;

Modified: jmeter/trunk/src/core/org/apache/jmeter/testelement/TestElement.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/testelement/TestElement.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/testelement/TestElement.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/testelement/TestElement.java Tue Jan  6 11:02:22
2015
@@ -86,7 +86,8 @@ public interface TestElement extends Clo
      * TestElement
      *
      * @param property
-     * @return boolean
+     *            the property to be tested
+     * @return <code>true</code> if property is temporary
      */
     boolean isTemporary(JMeterProperty property);
 

Modified: jmeter/trunk/src/core/org/apache/jmeter/testelement/TestIterationListener.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/testelement/TestIterationListener.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/testelement/TestIterationListener.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/testelement/TestIterationListener.java Tue Jan
 6 11:02:22 2015
@@ -29,7 +29,7 @@ public interface TestIterationListener {
      * This will be after the test elements have been cloned, so in general
      * the instance will not be the same as the ones the start/end methods call.
      *
-     * @param event
+     * @param event the iteration event
      */
     void testIterationStart(LoopIterationEvent event);
 }

Modified: jmeter/trunk/src/core/org/apache/jmeter/testelement/property/NumberProperty.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/testelement/property/NumberProperty.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/testelement/property/NumberProperty.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/testelement/property/NumberProperty.java Tue Jan
 6 11:02:22 2015
@@ -34,11 +34,19 @@ public abstract class NumberProperty ext
 
     /**
      * Set the value of the property with a Number object.
+     *
+     * @param n the value to set
      */
     protected abstract void setNumberValue(Number n);
 
     /**
      * Set the value of the property with a String object.
+     *
+     * @param n
+     *            the number to set as a string representation
+     * @throws NumberFormatException
+     *             if the number <code>n</code> can not be converted to a
+     *             {@link Number}
      */
     protected abstract void setNumberValue(String n) throws NumberFormatException;
 

Modified: jmeter/trunk/src/core/org/apache/jmeter/threads/RemoteThreadsListener.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/threads/RemoteThreadsListener.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/threads/RemoteThreadsListener.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/threads/RemoteThreadsListener.java Tue Jan  6
11:02:22 2015
@@ -28,13 +28,13 @@ public interface RemoteThreadsListener e
     
     /**
      * @see org.apache.jmeter.testelement.ThreadListener#threadStarted()
-     * @throws RemoteException
+     * @throws RemoteException when remote calling of the method fails
      */
     void threadStarted() throws RemoteException;
 
     /**
      * @see org.apache.jmeter.testelement.ThreadListener#threadFinished()
-     * @throws RemoteException
+     * @throws RemoteException when remote calling of the method fails
      */
     void threadFinished() throws RemoteException;
 }

Modified: jmeter/trunk/src/core/org/apache/jmeter/threads/TestCompilerHelper.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/threads/TestCompilerHelper.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/threads/TestCompilerHelper.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/threads/TestCompilerHelper.java Tue Jan  6 11:02:22
2015
@@ -40,7 +40,8 @@ public interface TestCompilerHelper {
      * Only for use by TestCompiler.
      * 
      * @param child
-     * @return true if the child was added
+     *            the {@link TestElement} to be added
+     * @return <code>true</code> if the child was added
      */
     boolean addTestElementOnce(TestElement child);
     

Modified: jmeter/trunk/src/core/org/apache/jmeter/util/JSR223TestElement.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/util/JSR223TestElement.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/util/JSR223TestElement.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/util/JSR223TestElement.java Tue Jan  6 11:02:22
2015
@@ -132,8 +132,8 @@ public abstract class JSR223TestElement
      * @param scriptEngine ScriptEngine
      * @param bindings {@link Bindings} might be null
      * @return Object returned by script
-     * @throws IOException
-     * @throws ScriptException
+     * @throws IOException when reading the script fails
+     * @throws ScriptException when compiling or evaluation of the script fails
      */
     protected Object processFileOrScript(ScriptEngine scriptEngine, Bindings bindings) throws
IOException, ScriptException {
         if (bindings == null) {

Modified: jmeter/trunk/src/core/org/apache/jmeter/util/SSLManager.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/util/SSLManager.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/util/SSLManager.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/util/SSLManager.java Tue Jan  6 11:02:22 2015
@@ -94,6 +94,9 @@ public abstract class SSLManager {
 
     /**
      * Default implementation of setting the Provider
+     *
+     * @param provider
+     *            the provider to use
      */
     protected void setProvider(Provider provider) {
         if (null != provider) {
@@ -105,6 +108,8 @@ public abstract class SSLManager {
      * Opens and initializes the KeyStore. If the password for the KeyStore is
      * not set, this method will prompt you to enter it. Unfortunately, there is
      * no PasswordEntryField available from JOptionPane.
+     *
+     * @return the configured {@link JmeterKeyStore}
      */
     protected synchronized JmeterKeyStore getKeyStore() {
         if (null == this.keyStore) {

Modified: jmeter/trunk/src/jorphan/org/apache/jorphan/collections/HashTree.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/jorphan/org/apache/jorphan/collections/HashTree.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/jorphan/org/apache/jorphan/collections/HashTree.java (original)
+++ jmeter/trunk/src/jorphan/org/apache/jorphan/collections/HashTree.java Tue Jan  6 11:02:22
2015
@@ -84,9 +84,15 @@ public class HashTree implements Seriali
     }
     
     /**
-     * Uses the new HashTree if not null and adds the given object as a top-level node if
not null
+     * Uses the new HashTree if not null and adds the given object as a
+     * top-level node if not null
+     *
      * @param _map
+     *            the map to be used. If <code>null</code> a new {@link HashMap}
+     *            will be created
      * @param key
+     *            the object to be used as the key for the root node (may be
+     *            <code>null</code>, in which case no root node will be created)
      */
     private HashTree(Map<Object, HashTree> _map, Object key) {
         if(_map != null) {
@@ -933,6 +939,13 @@ public class HashTree implements Seriali
 
     /**
      * Method readObject.
+     *
+     * @param ois
+     *            the stream to read the objects from
+     * @throws ClassNotFoundException
+     *             when the class for the deserialization can not be found
+     * @throws IOException
+     *             when I/O error occurs
      */
     private void readObject(ObjectInputStream ois) throws ClassNotFoundException, IOException
{
         ois.defaultReadObject();
@@ -971,6 +984,9 @@ public class HashTree implements Seriali
     /**
      * The recursive method that accomplishes the tree-traversal and performs
      * the callbacks to the HashTreeTraverser.
+     *
+     * @param visitor
+     *            the {@link HashTreeTraverser} to be notified
      */
     private void traverseInto(HashTreeTraverser visitor) {
 

Modified: jmeter/trunk/src/jorphan/org/apache/jorphan/gui/TreeTableModel.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/jorphan/org/apache/jorphan/gui/TreeTableModel.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/jorphan/org/apache/jorphan/gui/TreeTableModel.java (original)
+++ jmeter/trunk/src/jorphan/org/apache/jorphan/gui/TreeTableModel.java Tue Jan  6 11:02:22
2015
@@ -28,29 +28,39 @@ import javax.swing.table.TableModel;
 public interface TreeTableModel extends TableModel {
 
     /**
-     * The method is similar to getValueAt(int,int). Instead of int,
-     * the row is an object.
+     * The method is similar to getValueAt(int,int). Instead of int, the row is
+     * an object.
+     *
      * @param node
+     *            the node which value is to be fetched
      * @param col
+     *            the column of the node
      * @return the value at the column
      */
     Object getValueAt(Object node, int col);
 
     /**
-     * the method is similar to isCellEditable(int,int). Instead of int,
-     * the row is an object.
+     * the method is similar to isCellEditable(int,int). Instead of int, the row
+     * is an object.
+     *
      * @param node
+     *            the node which value is to be fetched
      * @param col
-     * @return if cell is editable
+     *            the column of the node
+     * @return <code>true</code> if cell is editable
      */
     boolean isCellEditable(Object node, int col);
 
     /**
-     * the method is similar to isCellEditable(int,int). Instead of int,
-     * the row is an object.
+     * the method is similar to isCellEditable(int,int). Instead of int, the row
+     * is an object.
+     *
      * @param val
+     *            the value to be set
      * @param node
+     *            the node which value is to be set
      * @param column
+     *            the column of the node
      */
     void setValueAt(Object val, Object node, int column);
 }

Modified: jmeter/trunk/src/jorphan/org/apache/jorphan/test/UnitTestManager.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/jorphan/org/apache/jorphan/test/UnitTestManager.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/jorphan/org/apache/jorphan/test/UnitTestManager.java (original)
+++ jmeter/trunk/src/jorphan/org/apache/jorphan/test/UnitTestManager.java Tue Jan  6 11:02:22
2015
@@ -35,6 +35,7 @@ public interface UnitTestManager {
      * need to configure your system prior to the unit tests running.
      *
      * @param filename
+     *            path to the configuration file
      */
     void initializeProperties(String filename);
 }

Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/SamplerCreator.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/SamplerCreator.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/SamplerCreator.java
(original)
+++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/SamplerCreator.java
Tue Jan  6 11:02:22 2015
@@ -49,7 +49,7 @@ public interface SamplerCreator {
      * @param request {@link HttpRequestHdr}
      * @param pageEncodings Map of page encodings
      * @param formEncodings Map of form encodings
-     * @throws Exception
+     * @throws Exception when something fails
      */
     void populateSampler(HTTPSamplerBase sampler,
             HttpRequestHdr request, Map<String, String> pageEncodings,
@@ -75,7 +75,7 @@ public interface SamplerCreator {
      * @param pageEncodings Map of page encodings
      * @param formEncodings Map of form encodings
      * @return {@link HTTPSamplerBase}
-     * @throws Exception
+     * @throws Exception when something fails
      * @since 2.9
      */
     HTTPSamplerBase createAndPopulateSampler(HttpRequestHdr request,

Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HTTPSamplerBaseConverter.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HTTPSamplerBaseConverter.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HTTPSamplerBaseConverter.java
(original)
+++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HTTPSamplerBaseConverter.java
Tue Jan  6 11:02:22 2015
@@ -37,6 +37,8 @@ public class HTTPSamplerBaseConverter ex
     /**
      * Returns the converter version; used to check for possible
      * incompatibilities
+     *
+     * @return the version of this component
      */
     public static String getVersion() {
         return "$Revision$";  //$NON-NLS-1$

Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/HTTPResultConverter.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/HTTPResultConverter.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/HTTPResultConverter.java
(original)
+++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/HTTPResultConverter.java
Tue Jan  6 11:02:22 2015
@@ -43,6 +43,8 @@ public class HTTPResultConverter extends
     /**
      * Returns the converter version; used to check for possible
      * incompatibilities
+     *
+     * @return the version of this component
      */
     public static String getVersion() {
         return "$Revision$";  //$NON-NLS-1$

Modified: jmeter/trunk/src/reports/org/apache/jmeter/JMeterReport.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/reports/org/apache/jmeter/JMeterReport.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/reports/org/apache/jmeter/JMeterReport.java (original)
+++ jmeter/trunk/src/reports/org/apache/jmeter/JMeterReport.java Tue Jan  6 11:02:22 2015
@@ -296,7 +296,7 @@ public class JMeterReport implements JMe
 
     /**
      *
-     * @param args
+     * @param args the arguments to parse
      */
     public void start(String[] args) {
         CLArgsParser parser = new CLArgsParser(args, options);

Modified: jmeter/trunk/src/reports/org/apache/jmeter/gui/ReportGuiPackage.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/reports/org/apache/jmeter/gui/ReportGuiPackage.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/reports/org/apache/jmeter/gui/ReportGuiPackage.java (original)
+++ jmeter/trunk/src/reports/org/apache/jmeter/gui/ReportGuiPackage.java Tue Jan  6 11:02:22
2015
@@ -340,8 +340,6 @@ public final class ReportGuiPackage impl
      * @throws IllegalAccessException
      *             if access rights do not allow the default constructor to be
      *             called
-     * @throws ClassNotFoundException
-     *             if the specified GUI class cannot be found
      */
     private JMeterGUIComponent getGuiFromCache(Class<?> guiClass, Class<?> testClass)
throws InstantiationException,
             IllegalAccessException {
@@ -600,7 +598,7 @@ public final class ReportGuiPackage impl
      * Sets the filepath of the current test plan. It's shown in the main frame
      * title and used on saving.
      *
-     * @param f
+     * @param f the path of the file to save the test plan
      */
     public void setReportPlanFile(String f) {
         reportPlanFile = f;

Modified: jmeter/trunk/src/reports/org/apache/jmeter/gui/util/DirectoryPanel.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/reports/org/apache/jmeter/gui/util/DirectoryPanel.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/reports/org/apache/jmeter/gui/util/DirectoryPanel.java (original)
+++ jmeter/trunk/src/reports/org/apache/jmeter/gui/util/DirectoryPanel.java Tue Jan  6 11:02:22
2015
@@ -60,8 +60,11 @@ public class DirectoryPanel extends Hori
     }
 
     /**
-     * Constructor for the FilePanel object. No {@link ChangeListener} is registered.
+     * Constructor for the FilePanel object. No {@link ChangeListener} is
+     * registered.
+     *
      * @param title
+     *            the title of this component
      */
     public DirectoryPanel(String title) {
         this(title, null);

Modified: jmeter/trunk/src/reports/org/apache/jmeter/gui/util/ReportFileDialoger.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/reports/org/apache/jmeter/gui/util/ReportFileDialoger.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/reports/org/apache/jmeter/gui/util/ReportFileDialoger.java (original)
+++ jmeter/trunk/src/reports/org/apache/jmeter/gui/util/ReportFileDialoger.java Tue Jan  6
11:02:22 2015
@@ -48,6 +48,9 @@ public final class ReportFileDialoger {
      * the caller's responsibility to check to see if the selected file is
      * non-null.
      *
+     * @param exts
+     *            non <code>null</code> array of allowed file extensions. If
+     *            empty, all extensions are allowed
      * @return the JFileChooser that interacted with the user, after they are
      *         finished using it (accept or otherwise).
      */
@@ -92,6 +95,7 @@ public final class ReportFileDialoger {
      * the caller's responsibility to check to see if the selected file is
      * non-null.
      *
+     * @param filename name of selected file
      * @return the JFileChooser that interacted with the user, after they are
      *         finished using it (accept or otherwise).
      * @see #promptToOpenFile()
@@ -104,7 +108,10 @@ public final class ReportFileDialoger {
      * Get a JFileChooser with a new FileFilter.
      *
      * @param filename
+     *            name of a selected file
      * @param extensions
+     *            list of extensions to allow. If <code>null</code>, files with
+     *            <em>.jmx</em> extension will be allowed only
      * @return JFileChooser
      */
     public static JFileChooser promptToSaveFile(String filename, String[] extensions) {

Modified: jmeter/trunk/src/reports/org/apache/jmeter/gui/util/ReportFilePanel.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/reports/org/apache/jmeter/gui/util/ReportFilePanel.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/reports/org/apache/jmeter/gui/util/ReportFilePanel.java (original)
+++ jmeter/trunk/src/reports/org/apache/jmeter/gui/util/ReportFilePanel.java Tue Jan  6 11:02:22
2015
@@ -69,6 +69,11 @@ public class ReportFilePanel extends Hor
 
     /**
      * Constructor for the FilePanel object.
+     *
+     * @param l
+     *            {@link ChangeListener} to be notified of changes
+     * @param title
+     *            the title of this component
      */
     public ReportFilePanel(ChangeListener l, String title) {
         this(title);
@@ -95,7 +100,7 @@ public class ReportFilePanel extends Hor
     /**
      * If the gui needs to enable/disable the FilePanel, call the method.
      *
-     * @param enable
+     * @param enable flag whether to enable the FilePanel
      */
     public void enableFile(boolean enable) {
         browse.setEnabled(enable);

Modified: jmeter/trunk/src/reports/org/apache/jmeter/testelement/JTLData.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/reports/org/apache/jmeter/testelement/JTLData.java?rev=1649775&r1=1649774&r2=1649775&view=diff
==============================================================================
--- jmeter/trunk/src/reports/org/apache/jmeter/testelement/JTLData.java (original)
+++ jmeter/trunk/src/reports/org/apache/jmeter/testelement/JTLData.java Tue Jan  6 11:02:22
2015
@@ -74,13 +74,16 @@ public class JTLData implements Serializ
     }
 
     /**
-     * The purpose of the method is to make it convienant to pass a list
-     * of the URLs and return a list of the SamplingStatCalculators. If
-     * no URLs match, the list is empty.
-     * TODO - this method seems to be wrong - it does not agree with the Javadoc
-     * The SamplingStatCalculators will be returned in the same sequence
-     * as the url list.
+     * The purpose of the method is to make it convienant to pass a list of the
+     * URLs and return a list of the SamplingStatCalculators. If no URLs match,
+     * the list is empty.
+     * <p>
+     * TODO - this method seems to be wrong - it does not
+     * agree with the Javadoc The SamplingStatCalculators will be returned in
+     * the same sequence as the url list.
+     *
      * @param urls
+     *            the URLs for which to get statistics
      * @return array list of non-null entries (may be empty)
      */
     @SuppressWarnings({ "rawtypes", "unchecked" }) // Method is broken anyway
@@ -167,7 +170,7 @@ public class JTLData implements Serializ
     /**
      * The method will SamplingStatCalculator for the given URL. If the URL
      * doesn't exist, the method returns null.
-     * @param url
+     * @param url the URL for which to get statistics
      * @return data for this URL
      */
     @Override



Mime
View raw message