svn commit: r1802523 - /jmeter/trunk/src/functions/org/apache/jmeter/functions/StringFromFile.java

[fs...@apache.org]

Author: fschumacher
Date: Thu Jul 20 18:19:02 2017
New Revision: 1802523

URL: http://svn.apache.org/viewvc?rev=1802523&view=rev
Log:
Javadoc: markup changes and addition of the function parameters 'sequence start' and 'sequence end'

Modified:
    jmeter/trunk/src/functions/org/apache/jmeter/functions/StringFromFile.java

Modified: jmeter/trunk/src/functions/org/apache/jmeter/functions/StringFromFile.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/functions/org/apache/jmeter/functions/StringFromFile.java?rev=1802523&r1=1802522&r2=1802523&view=diff
==============================================================================
--- jmeter/trunk/src/functions/org/apache/jmeter/functions/StringFromFile.java (original)
+++ jmeter/trunk/src/functions/org/apache/jmeter/functions/StringFromFile.java Thu Jul 20 18:19:02 2017
@@ -38,18 +38,24 @@ import org.apache.jorphan.util.JMeterSto
 import org.slf4j.Logger;
 
 /**
- * StringFromFile Function to read a String from a text file.
- *
+ * <p>StringFromFile Function to read a String from a text file.</p>
+ * 
  * Parameters:
- * - file name
- * - variable name (optional - defaults to StringFromFile_)
+ * <ul>
+ *   <li>file name</li>
+ *   <li>variable name (optional - defaults to {@code StringFromFile_})</li>
+ *   <li>sequence start</li>
+ *   <li>sequence end</li>
+ * </ul>
  *
  * Returns:
- * - the next line from the file
- * - or **ERR** if an error occurs
- * - value is also saved in the variable for later re-use.
+ * <ul>
+ *   <li>the next line from the file</li>
+ *   <li>or {@code **ERR**} if an error occurs</li>
+ *   <li>value is also saved in the variable for later re-use.</li>
+ * </ul>
  *
- * Ensure that different variable names are used for each call to the function
+ * <p>Ensure that different variable names are used for each call to the function</p>
  *
  *
  * Notes: