svn commit: r1673648 - /jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/graphite/AbstractGraphiteMetricsSender.java

[fs...@apache.org]

Author: fschumacher
Date: Wed Apr 15 04:56:56 2015
New Revision: 1673648

URL: http://svn.apache.org/r1673648
Log:
Addition of javadoc

Modified:
    jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/graphite/AbstractGraphiteMetricsSender.java

Modified: jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/graphite/AbstractGraphiteMetricsSender.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/graphite/AbstractGraphiteMetricsSender.java?rev=1673648&r1=1673647&r2=1673648&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/graphite/AbstractGraphiteMetricsSender.java (original)
+++ jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/graphite/AbstractGraphiteMetricsSender.java Wed Apr 15 04:56:56 2015
@@ -31,8 +31,11 @@ import org.apache.commons.pool2.impl.Gen
 abstract class AbstractGraphiteMetricsSender implements GraphiteMetricsSender {
 
     /**
-     * @return GenericKeyedObjectPool
-     * 
+     * Create a new keyed pool of {@link SocketOutputStream}s using a
+     * {@link SocketOutputStreamPoolFactory}. The keys for the pool are
+     * {@link SocketConnectionInfos} instances.
+     *
+     * @return GenericKeyedObjectPool the newly generated pool
      */
     protected GenericKeyedObjectPool<SocketConnectionInfos, SocketOutputStream> createSocketOutputStreamPool() {
         GenericKeyedObjectPoolConfig config = new GenericKeyedObjectPoolConfig();
@@ -55,8 +58,10 @@ abstract class AbstractGraphiteMetricsSe
      * <li>'\\' by '-'</li>
      * <li>'.' by '_'</li>
      * </ul>
+     * 
      * @param s
-     * @return
+     *            text to be sanitized
+     * @return the sanitized text
      */
     static final String sanitizeString(String s) {
         // String#replace uses regexp