[sling-org-apache-sling-discovery-commons] 06/16: Fix some javadoc.

[ro...@apache.org]

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

rombert pushed a commit to annotated tag org.apache.sling.discovery.commons-1.0.20
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-discovery-commons.git

commit a7aa35ccf2bb2c2ffd2361815e312029f91cb156
Author: Karl Pauls <pa...@apache.org>
AuthorDate: Sun May 7 21:28:01 2017 +0000

    Fix some javadoc.
    
    git-svn-id: https://svn.apache.org/repos/asf/sling/trunk/bundles/extensions/discovery/commons@1794262 13f79535-47bb-0310-9956-ffa450edef68
---
 .../sling/discovery/commons/providers/ViewStateManager.java      | 3 +--
 .../discovery/commons/providers/spi/ClusterSyncService.java      | 2 +-
 .../commons/providers/spi/base/OakBacklogClusterSyncService.java | 9 ---------
 3 files changed, 2 insertions(+), 12 deletions(-)

diff --git a/src/main/java/org/apache/sling/discovery/commons/providers/ViewStateManager.java b/src/main/java/org/apache/sling/discovery/commons/providers/ViewStateManager.java
index 50f20a0..a2568a8 100644
--- a/src/main/java/org/apache/sling/discovery/commons/providers/ViewStateManager.java
+++ b/src/main/java/org/apache/sling/discovery/commons/providers/ViewStateManager.java
@@ -83,7 +83,6 @@ public interface ViewStateManager {
      * listeners (in the latter case, also sends a TOPOLOGY_CHANGING if that has not yet been 
      * done)
      * @param newView the new, established view
-     * @return false if the newView was the same as previous and we were not in 'changing' mode,
      * true if we were either in changing mode or the newView was different from the previous one.
      */
     void handleNewView(BaseTopologyView newView);
@@ -94,7 +93,7 @@ public interface ViewStateManager {
      * <p>
      * @param timeout time in millis to wait for at max - 0 to not wait at all - -1 
      * to wait indefinitely
-     * @return 0 if no more async events exist, >0 the number of queued or in-flight (being sent)
+     * @return 0 if no more async events exist, or the number of queued or in-flight (being sent)
      * events if the timeout hit early
      */
     int waitForAsyncEvents(long timeout);
diff --git a/src/main/java/org/apache/sling/discovery/commons/providers/spi/ClusterSyncService.java b/src/main/java/org/apache/sling/discovery/commons/providers/spi/ClusterSyncService.java
index 7bf9ce1..3b6f205 100644
--- a/src/main/java/org/apache/sling/discovery/commons/providers/spi/ClusterSyncService.java
+++ b/src/main/java/org/apache/sling/discovery/commons/providers/spi/ClusterSyncService.java
@@ -32,7 +32,7 @@ import org.apache.sling.discovery.commons.providers.BaseTopologyView;
  * important that one listener doesn't do activity based on
  * an older incarnation of the topologyView than another listener
  * on another instance. they should change from one view to the
- * next view based on the same repository state.</li>
+ * next view based on the same repository state.
  * </li>
  * <li>when an instance leaves the cluster (eg crashes), then 
  * depending on the repository it might have left a backlog around
diff --git a/src/main/java/org/apache/sling/discovery/commons/providers/spi/base/OakBacklogClusterSyncService.java b/src/main/java/org/apache/sling/discovery/commons/providers/spi/base/OakBacklogClusterSyncService.java
index 696d2f3..3185043 100644
--- a/src/main/java/org/apache/sling/discovery/commons/providers/spi/base/OakBacklogClusterSyncService.java
+++ b/src/main/java/org/apache/sling/discovery/commons/providers/spi/base/OakBacklogClusterSyncService.java
@@ -76,15 +76,6 @@ public class OakBacklogClusterSyncService extends AbstractServiceWithBackgroundC
 
     /**
      * for testing only!
-     * @param resourceResolverFactory
-     * @param slingId the local slingId
-     * @param syncTokenTimeoutMillis timeout value in millis after which the
-     * sync-token process is cancelled - or -1 if no timeout should be used there
-     * @param backlogWaitTimeoutMillis timeout value in millis after which
-     * the waiting-while-backlog should be cancelled - or -1 if no timeout should be
-     * used there
-     * @throws LoginException when the login for initialization failed
-     * @throws JSONException when the descriptor wasn't proper json at init time
      */
     public static OakBacklogClusterSyncService testConstructor(
             final DiscoveryLiteConfig commonsConfig,

-- 
To stop receiving notification emails like this one, please contact
"commits@sling.apache.org" <co...@sling.apache.org>.