Formatted and cleaned up sources

src/main/java/org/rometools/certiorem/hub/DeltaFeedInfoCache.java

@@ -10,9 +10,9 @@ import com.rometools.fetcher.impl.FeedFetcherCache;
 import com.rometools.fetcher.impl.SyndFeedInfo;
 
 /**
- * Wrapper FeedFetcherCache that wraps a backing FeedFetcherCache and makes sure
+ * Wrapper FeedFetcherCache that wraps a backing FeedFetcherCache and makes sure that any
- * that any SyndFeedInfo used within it are replaced with a DeltaSyndFeedInfo
+ * SyndFeedInfo used within it are replaced with a DeltaSyndFeedInfo which is capable of tracking
- * which is capable of tracking changes to entries in the underlying feed.
+ * changes to entries in the underlying feed.
  *
  * @author najmi
  */

src/main/java/org/rometools/certiorem/hub/DeltaSyndFeedInfo.java

@@ -17,9 +17,9 @@ import com.sun.syndication.feed.synd.SyndEntry;
 import com.sun.syndication.feed.synd.SyndFeed;
 
 /**
- * Extends SyndFeedInfo to also track etags for individual entries. This may be
+ * Extends SyndFeedInfo to also track etags for individual entries. This may be used with
- * used with DeltaFeedInfoCache to only return feed with a subset of entries
+ * DeltaFeedInfoCache to only return feed with a subset of entries that have changed since last
- * that have changed since last fetch.
+ * fetch.
  *
  * @author najmi
  */
@@ -40,8 +40,8 @@ public class DeltaSyndFeedInfo extends SyndFeedInfo {
     }
 
     /**
-     * Gets a filtered version of the SyndFeed that only has entries that were
+     * Gets a filtered version of the SyndFeed that only has entries that were changed in the last
-     * changed in the last setSyndFeed() call.
+     * setSyndFeed() call.
      *
      * @return
      */
@@ -68,8 +68,8 @@ public class DeltaSyndFeedInfo extends SyndFeedInfo {
     }
 
     /**
-     * Overrides super class method to update changedMap and entryTagsMap for
+     * Overrides super class method to update changedMap and entryTagsMap for tracking changed
-     * tracking changed entries.
+     * entries.
      *
      * @param feed
      */

src/main/java/org/rometools/certiorem/hub/Notifier.java

@@ -31,13 +31,11 @@ import com.sun.syndication.feed.synd.SyndFeed;
  */
 public interface Notifier {
     /**
-     * Instructs the notifier to begin sending notifications to the list of
+     * Instructs the notifier to begin sending notifications to the list of subscribers
-     * subscribers
      *
      * @param subscribers Subscribers to notify
      * @param value The SyndFeed to send them
-     * @param callback A callback that is invoked each time a subscriber is
+     * @param callback A callback that is invoked each time a subscriber is notified.
-     *            notified.
      */
     public void notifySubscribers(List<? extends Subscriber> subscribers, SyndFeed value, SubscriptionSummaryCallback callback);
 

src/main/java/org/rometools/certiorem/hub/Verifier.java

@@ -69,8 +69,7 @@ public interface Verifier {
     public boolean verifyUnsubcribeSyncronously(Subscriber subscriber);
 
     /**
-     * An interface for capturing the result of a verification (subscribe or
+     * An interface for capturing the result of a verification (subscribe or unsubscribe)
-     * unsubscribe)
      */
     public static interface VerificationCallback {
         /**

src/main/java/org/rometools/certiorem/hub/notify/standard/ThreadPoolNotifier.java

@@ -28,8 +28,7 @@ import java.util.concurrent.TimeUnit;
 import org.rometools.certiorem.hub.data.SubscriptionSummary;
 
 /**
- * A notifier implementation that uses a thread pool to deliver notifications to
+ * A notifier implementation that uses a thread pool to deliver notifications to subscribers
- * subscribers
  *
  * @author robert.cooper
  */
@@ -52,9 +51,9 @@ public class ThreadPoolNotifier extends AbstractNotifier {
     }
 
     /**
-     * Enqueues a notification to run. If the notification fails, it will be
+     * Enqueues a notification to run. If the notification fails, it will be retried every two
-     * retried every two minutes until 5 attempts are completed. Notifications
+     * minutes until 5 attempts are completed. Notifications to the same callback should be
-     * to the same callback should be delivered successfully in order.
+     * delivered successfully in order.
      *
      * @param not
      */

src/main/java/org/rometools/certiorem/hub/notify/standard/UnthreadedNotifier.java

@@ -28,9 +28,8 @@ import org.rometools.certiorem.hub.data.SubscriptionSummary;
 public class UnthreadedNotifier extends AbstractNotifier {
 
     /**
-     * A blocking call that performs a notification. If there are pending
+     * A blocking call that performs a notification. If there are pending retries that are older
-     * retries that are older than two minutes old, they will be retried before
+     * than two minutes old, they will be retried before the method returns.
-     * the method returns.
      *
      * @param not
      */