Author: fschumacher
Date: Sat May 12 11:57:22 2018
New Revision: 1831471
URL: http://svn.apache.org/viewvc?rev=1831471&view=rev
Log:
javadoc: add description to parameter
Modified:
jmeter/trunk/src/jorphan/org/apache/jorphan/util/JOrphanUtils.java
jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/AuthManager.java
Modified: jmeter/trunk/src/jorphan/org/apache/jorphan/util/JOrphanUtils.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/jorphan/org/apache/jorphan/util/JOrphanUtils.java?rev=1831471&r1=1831470&r2=1831471&view=diff
==============================================================================
--- jmeter/trunk/src/jorphan/org/apache/jorphan/util/JOrphanUtils.java
(original)
+++ jmeter/trunk/src/jorphan/org/apache/jorphan/util/JOrphanUtils.java Sat May
12 11:57:22 2018
@@ -601,16 +601,17 @@ public final class JOrphanUtils {
canSafelyWriteToFolder(folder, false);
}
/**
- * Throw {@link IllegalArgumentException} if folder cannot be written to
either:
+ * Check whether we can write to a folder.
+ *
+ * @param folder which should be checked for writability and emptyness
+ * @param deleteFolderIfExists flag whether the folder should be emptied
or a file with the same name deleted
+ *
+ * @throws IllegalArgumentException when folder can't be written to. That
could have the following reasons:
* <ul>
- * <li>Because it exists but is not a folder</li>
- * <li>Because it exists but is not empty</li>
- * <li>Because it does not exist but cannot be created</li>
+ * <li>it exists but is not a folder</li>
+ * <li>it exists but is not empty</li>
+ * <li>it does not exist but cannot be created</li>
* </ul>
- * @param folder {@link File}
- * @param deleteFolderIfExists
- *
- * @throws IllegalArgumentException when folder can't be written to
*/
public static void canSafelyWriteToFolder(File folder, boolean
deleteFolderIfExists) {
if(folder.exists()) {
Modified:
jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/AuthManager.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/AuthManager.java?rev=1831471&r1=1831470&r2=1831471&view=diff
==============================================================================
---
jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/AuthManager.java
(original)
+++
jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/AuthManager.java
Sat May 12 11:57:22 2018
@@ -462,11 +462,11 @@ public class AuthManager extends ConfigT
/**
* Configure credentials and auth scheme on client if an authorization is
- * @param auth
- * @param url
- * @param localContext
- * @param credentialsProvider
- * @param localhost
+ * @param auth information about the authorization to use
+ * @param url the URL for which the authorization info should be used
+ * @param localContext http client context which should be set up
+ * @param credentialsProvider provider which should be set up
+ * @param localhost name of the workstation to be used for {@link
NTCredentials}
*/
public void setupCredentials(Authorization auth, URL url,
HttpClientContext localContext,
