Author: fschumacher
Date: Sat Feb 9 12:38:44 2019
New Revision: 1853263
URL: http://svn.apache.org/viewvc?rev=1853263&view=rev
Log:
Javadoc
Modified:
jmeter/trunk/src/functions/org/apache/jmeter/functions/FileToString.java
Modified:
jmeter/trunk/src/functions/org/apache/jmeter/functions/FileToString.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/functions/org/apache/jmeter/functions/FileToString.java?rev=1853263&r1=1853262&r2=1853263&view=diff
==============================================================================
--- jmeter/trunk/src/functions/org/apache/jmeter/functions/FileToString.java
(original)
+++ jmeter/trunk/src/functions/org/apache/jmeter/functions/FileToString.java
Sat Feb 9 12:38:44 2019
@@ -35,16 +35,20 @@ import org.slf4j.LoggerFactory;
/**
* FileToString Function to read a complete file into a String.
- *
+ * <p>
* Parameters:
- * - file name
- * - file encoding (optional)
- * - variable name (optional)
+ * <ul>
+ * <li>file name</li>
+ * <li>file encoding (optional)</li>
+ * <li>variable name (optional)</li>
+ * </ul>
*
* Returns:
- * - the whole text from a file
- * - or **ERR** if an error occurs
- * - value is also optionally saved in the variable for later re-use.
+ * <ul>
+ * <li>the whole text from a file</li>
+ * <li>or {@code **ERR**} if an error occurs</li>
+ * <li>value is also optionally saved in the variable for later re-use.</li>
+ * </ul>
* @since 2.4
*/
public class FileToString extends AbstractFunction {
