[sling-org-apache-sling-testing-clients] branch master updated: trivial: fix javadoc

[du...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

dulvac pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-testing-clients.git


The following commit(s) were added to refs/heads/master by this push:
     new a472a17  trivial: fix javadoc
a472a17 is described below

commit a472a1772db9c08c099ccdef6dd8d0eb847d5d78
Author: Andrei Dulvac <ad...@adobe.com>
AuthorDate: Thu Mar 29 13:27:48 2018 +0200

    trivial: fix javadoc
---
 .../org/apache/sling/testing/clients/indexing/IndexingClient.java   | 5 ++---
 .../java/org/apache/sling/testing/clients/query/QueryClient.java    | 6 ++++++
 .../org/apache/sling/testing/clients/util/TimeoutsProvider.java     | 5 ++++-
 3 files changed, 12 insertions(+), 4 deletions(-)

diff --git a/src/main/java/org/apache/sling/testing/clients/indexing/IndexingClient.java b/src/main/java/org/apache/sling/testing/clients/indexing/IndexingClient.java
index 7808891..de1782b 100644
--- a/src/main/java/org/apache/sling/testing/clients/indexing/IndexingClient.java
+++ b/src/main/java/org/apache/sling/testing/clients/indexing/IndexingClient.java
@@ -47,14 +47,13 @@ import static org.apache.http.HttpStatus.SC_OK;
  * <p>Exposes {@link #waitForAsyncIndexing(long, long)} for waiting all the indexing lanes to finish
  * indexing and to guarantee all the indices are up to date</p>
  *
- * <p>For using {@link #waitForAsyncIndexing(long, long)}, the user must have access rights to:
+ * <p>For using {@link #waitForAsyncIndexing(long, long)}, the user must have access rights to:</p>
  *  <ul>
  *      <li>read/write in {@code /tmp}</li>
  *      <li>install bundles via {@link org.apache.sling.testing.clients.osgi.OsgiConsoleClient}
  *      (if the query servlet was not previously installed)</li>
  *  </ul>
- *  In short, it requires administrative rights.
- * </p>
+ *  <p>In short, it requires administrative rights.</p>
  */
 public class IndexingClient extends SlingClient {
     private static final Logger LOG = LoggerFactory.getLogger(IndexingClient.class);
diff --git a/src/main/java/org/apache/sling/testing/clients/query/QueryClient.java b/src/main/java/org/apache/sling/testing/clients/query/QueryClient.java
index a6b5d2e..bfad020 100644
--- a/src/main/java/org/apache/sling/testing/clients/query/QueryClient.java
+++ b/src/main/java/org/apache/sling/testing/clients/query/QueryClient.java
@@ -117,6 +117,7 @@ public class QueryClient extends SlingClient {
      * @param type type of the query
      * @return the results in json as exported by {@link QueryServlet}
      * @throws ClientException if the request failed to execute
+     * @throws InterruptedException to mark that this method blocks
      */
     public JsonNode doQuery(final String query, final QueryType type) throws ClientException, InterruptedException {
         return doQuery(query, type, true, false);
@@ -129,6 +130,7 @@ public class QueryClient extends SlingClient {
      * @param type type of the query
      * @return total results returned by the query
      * @throws ClientException if the request failed to execute
+     * @throws InterruptedException to mark that this method blocks
      */
     public long doCount(final String query, final QueryType type) throws ClientException, InterruptedException {
         return doQuery(query, type, false, false).get("total").getLongValue();
@@ -141,6 +143,7 @@ public class QueryClient extends SlingClient {
      * @param type type of the query
      * @return total results returned by the query
      * @throws ClientException if the request failed to execute
+     * @throws InterruptedException to mark that this method blocks
      */
     public String getPlan(final String query, final QueryType type) throws ClientException, InterruptedException {
         return doQuery(query, type, false, true).get("plan").toString();
@@ -179,7 +182,9 @@ public class QueryClient extends SlingClient {
      * <p>By default, methods of this client automatically install the servlet if needed,
      * so there is no need to explicitly call from outside</p>
      *
+     * @return this
      * @throws ClientException if the installation fails
+     * @throws InterruptedException to mark that this method blocks
      */
     public QueryClient installServlet() throws ClientException, InterruptedException {
         InputStream bundleStream = TinyBundles.bundle()
@@ -209,6 +214,7 @@ public class QueryClient extends SlingClient {
     /**
      * Deletes all the resources created by {@link #installServlet()}
      *
+     * @return this
      * @throws ClientException if any of the resources fails to uninstall
      */
     public QueryClient uninstallServlet() throws ClientException {
diff --git a/src/main/java/org/apache/sling/testing/clients/util/TimeoutsProvider.java b/src/main/java/org/apache/sling/testing/clients/util/TimeoutsProvider.java
index fa6f99a..6a90633 100644
--- a/src/main/java/org/apache/sling/testing/clients/util/TimeoutsProvider.java
+++ b/src/main/java/org/apache/sling/testing/clients/util/TimeoutsProvider.java
@@ -68,9 +68,12 @@ public class TimeoutsProvider {
         final int result = (int)(nomimalValue * timeoutFactor);
         return result;
     }
-    
+
     /**
      * Get timeout from a system property, with default value
+     * @param systemPropertyName Name of the system property that holds the timeout multiplier
+     * @param defaultNominalValue The default timeout multiplier
+     * @return the total timeout value
      */
     public int getTimeout(String systemPropertyName, int defaultNominalValue) {
         int result = defaultNominalValue;

-- 
To stop receiving notification emails like this one, please contact
dulvac@apache.org.