You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jmeter.apache.org by pm...@apache.org on 2017/11/08 20:40:26 UTC

svn commit: r1814638 - in /jmeter/trunk: src/components/org/apache/jmeter/visualizers/backend/influxdb/ src/core/org/apache/jmeter/gui/ src/core/org/apache/jmeter/gui/action/ src/core/org/apache/jmeter/report/processor/graph/ src/core/org/apache/jmeter...

Author: pmouawad
Date: Wed Nov  8 20:40:25 2017
New Revision: 1814638

URL: http://svn.apache.org/viewvc?rev=1814638&view=rev
Log:
General JavaDoc cleanup
Contributed by Graham Russell
This closes #322

Modified:
    jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/influxdb/HttpMetricsSender.java
    jmeter/trunk/src/core/org/apache/jmeter/gui/NamePanel.java
    jmeter/trunk/src/core/org/apache/jmeter/gui/action/ActionRouter.java
    jmeter/trunk/src/core/org/apache/jmeter/gui/action/Save.java
    jmeter/trunk/src/core/org/apache/jmeter/report/processor/graph/AbstractGraphConsumer.java
    jmeter/trunk/src/core/org/apache/jmeter/testbeans/gui/GenericTestBeanCustomizer.java
    jmeter/trunk/src/jorphan/org/apache/jorphan/reflect/ClassFinder.java
    jmeter/trunk/xdocs/changes.xml

Modified: jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/influxdb/HttpMetricsSender.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/influxdb/HttpMetricsSender.java?rev=1814638&r1=1814637&r2=1814638&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/influxdb/HttpMetricsSender.java (original)
+++ jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/influxdb/HttpMetricsSender.java Wed Nov  8 20:40:25 2017
@@ -111,8 +111,8 @@ class HttpMetricsSender extends Abstract
     }
 
     /**
-     * @param influxdbUrl
-     * @return 
+     * @param url {@link URL} Influxdb Url
+     * @return {@link HttpPost}
      * @throws URISyntaxException 
      */
     private HttpPost createRequest(URL url) throws URISyntaxException {

Modified: jmeter/trunk/src/core/org/apache/jmeter/gui/NamePanel.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/gui/NamePanel.java?rev=1814638&r1=1814637&r2=1814638&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/gui/NamePanel.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/gui/NamePanel.java Wed Nov  8 20:40:25 2017
@@ -53,7 +53,7 @@ public class NamePanel extends JPanel im
      */
     private void init() { // WARNING: called from ctor so must not be overridden (i.e. must be private or final)
         setLayout(new BorderLayout(5, 0));
-        /** The label for the text field. */
+        // The label for the text field.
         JLabel nameLabel = new JLabel(JMeterUtils.getResString("name")); // $NON-NLS-1$
         nameLabel.setName("name");
         nameLabel.setLabelFor(nameField);

Modified: jmeter/trunk/src/core/org/apache/jmeter/gui/action/ActionRouter.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/gui/action/ActionRouter.java?rev=1814638&r1=1814637&r2=1814638&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/gui/action/ActionRouter.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/gui/action/ActionRouter.java Wed Nov  8 20:40:25 2017
@@ -217,9 +217,10 @@ public final class ActionRouter implemen
     }
 
     /**
+     * Remove listener from actionsListeners associated to action
      * @param action {@link Class}
-     * @param e {@link ActionListener}
-     * @param actionListeners {@link Set}
+     * @param listener {@link ActionListener}
+     * @param actionListeners {@link Set} of {@link ActionListener}
      */
     private void removeActionListener(Class<?> action, ActionListener listener, Map<String, Set<ActionListener>> actionListeners) {
         if (action != null) {
@@ -248,7 +249,7 @@ public final class ActionRouter implemen
 
     /**
      * @param action {@link Class}
-     * @param list {@link ActionListener}
+     * @param listener {@link ActionListener}
      * @param actionListeners {@link Set}
      */
     private void addActionListener(Class<?> action, ActionListener listener, Map<String, Set<ActionListener>> actionListeners) {

Modified: jmeter/trunk/src/core/org/apache/jmeter/gui/action/Save.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/gui/action/Save.java?rev=1814638&r1=1814637&r2=1814638&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/gui/action/Save.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/gui/action/Save.java Wed Nov  8 20:40:25 2017
@@ -329,11 +329,9 @@ public class Save extends AbstractAction
                     backupDir.getAbsolutePath()); //$NON-NLS-2$
         }
 
-        /**
-         *  select files matching
-         * {baseName}{versionSeparator}{version}{jmxExtension}
-         * where {version} is a 6 digits number
-         */
+        // select files matching
+        // {baseName}{versionSeparator}{version}{jmxExtension}
+        // where {version} is a 6 digits number
         String backupPatternRegex = Pattern.quote(baseName + versionSeparator) + "([\\d]{6})" + Pattern.quote(JMX_FILE_EXTENSION); //$NON-NLS-1$
         Pattern backupPattern = Pattern.compile(backupPatternRegex);
         // create a file filter that select files matching a given regex pattern

Modified: jmeter/trunk/src/core/org/apache/jmeter/report/processor/graph/AbstractGraphConsumer.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/report/processor/graph/AbstractGraphConsumer.java?rev=1814638&r1=1814637&r2=1814638&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/report/processor/graph/AbstractGraphConsumer.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/report/processor/graph/AbstractGraphConsumer.java Wed Nov  8 20:40:25 2017
@@ -252,11 +252,11 @@ public abstract class AbstractGraphConsu
 
     /**
      * Adds a value map build from specified parameters to the result map.
-     *
+     * @param result {@link MapResultData}
+     * @param group 
+     * @param series
      * @param seriesData
-     *            the seriesData
-     * @param map
-     *            the groupData map
+     * @param aggregated
      */
     private void addKeyData(MapResultData result, String group, String series,
             SeriesData seriesData, boolean aggregated) {
@@ -387,13 +387,6 @@ public abstract class AbstractGraphConsu
 
     /**
      * Aggregate a value to the aggregator defined by the specified parameters.
-     *
-     * @param groupData
-     *            the map
-     * @param key
-     *            the key
-     * @param value
-     *            the value
      */
     private void aggregateValue(AggregatorFactory factory, SeriesData data,
             Double key, double value) {

Modified: jmeter/trunk/src/core/org/apache/jmeter/testbeans/gui/GenericTestBeanCustomizer.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/testbeans/gui/GenericTestBeanCustomizer.java?rev=1814638&r1=1814637&r2=1814638&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/testbeans/gui/GenericTestBeanCustomizer.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/testbeans/gui/GenericTestBeanCustomizer.java Wed Nov  8 20:40:25 2017
@@ -202,9 +202,7 @@ public class GenericTestBeanCustomizer e
     }
     /**
      * Create a customizer for a given test bean type.
-     *
-     * @param testBeanClass
-     *            a subclass of TestBean
+     * @param beanInfo {@link BeanInfo}
      * @see org.apache.jmeter.testbeans.TestBean
      */
     GenericTestBeanCustomizer(BeanInfo beanInfo) {

Modified: jmeter/trunk/src/jorphan/org/apache/jorphan/reflect/ClassFinder.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/jorphan/org/apache/jorphan/reflect/ClassFinder.java?rev=1814638&r1=1814637&r2=1814638&view=diff
==============================================================================
--- jmeter/trunk/src/jorphan/org/apache/jorphan/reflect/ClassFinder.java (original)
+++ jmeter/trunk/src/jorphan/org/apache/jorphan/reflect/ClassFinder.java Wed Nov  8 20:40:25 2017
@@ -307,7 +307,7 @@ public final class ClassFinder {
 
     /**
      * Returns the classpath entries that match the search list of jars and paths
-     * @param List can contain {@code null} element but must not be {@code null}
+     * @param strPathsOrJars can contain {@code null} element but must not be {@code null}
      * @return List of paths (jars or folders) that ends with one of the rows of strPathsOrJars
      */
     private static List<String> getClasspathMatches(List<String> strPathsOrJars) {

Modified: jmeter/trunk/xdocs/changes.xml
URL: http://svn.apache.org/viewvc/jmeter/trunk/xdocs/changes.xml?rev=1814638&r1=1814637&r2=1814638&view=diff
==============================================================================
--- jmeter/trunk/xdocs/changes.xml [utf-8] (original)
+++ jmeter/trunk/xdocs/changes.xml [utf-8] Wed Nov  8 20:40:25 2017
@@ -162,6 +162,7 @@ Summary
     <li><bug>61651</bug>Improve TCP test coverage</li>
     <li><bug>61651</bug>Improve OS test coverage. Partly contributed by Aleksei Balan (abalanonline at gmail.com)</li> 
     <li><pr>319</pr> Removed commented out code. Contributed by Graham Russell (graham at ham1.co.uk)</li>
+    <li><pr>322</pr> General JavaDoc cleanup. Contributed by Graham Russell (graham at ham1.co.uk)</li>
 </ul>
 
  <!-- =================== Bug fixes =================== -->