Fix javadoc in org.eclipse.jgit events package

Change-Id: Ifcb9c67daeb9da84a1461a4f731523ac5df3a223
Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/events/ConfigChangedEvent.java b/org.eclipse.jgit/src/org/eclipse/jgit/events/ConfigChangedEvent.java
index 79598eacb3bbb65ab6dbe8b8f7b16e7b6bd32d8c..69f6ff82ced36f74da988af99dd821a42db32b66 100644 (file)
--- a/org.eclipse.jgit/src/org/eclipse/jgit/events/ConfigChangedEvent.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/events/ConfigChangedEvent.java
@@ -43,13 +43,17 @@
 
 package org.eclipse.jgit.events;
 
-/** Describes a change to one or more keys in the configuration. */
+/**
+ * Describes a change to one or more keys in the configuration.
+ */
 public class ConfigChangedEvent extends RepositoryEvent<ConfigChangedListener> {
+       /** {@inheritDoc} */
        @Override
        public Class<ConfigChangedListener> getListenerType() {
                return ConfigChangedListener.class;
        }
 
+       /** {@inheritDoc} */
        @Override
        public void dispatch(ConfigChangedListener listener) {
                listener.onConfigChanged(this);

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/events/ConfigChangedListener.java b/org.eclipse.jgit/src/org/eclipse/jgit/events/ConfigChangedListener.java
index 322cf7f6d609f357b25382f6e0c8bc31c3a88a02..34fe90a58d7c610c1ad781ef75b267b1e815f66c 100644 (file)
--- a/org.eclipse.jgit/src/org/eclipse/jgit/events/ConfigChangedListener.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/events/ConfigChangedListener.java
@@ -43,7 +43,9 @@
 
 package org.eclipse.jgit.events;
 
-/** Receives {@link ConfigChangedEvent}s. */
+/**
+ * Receives {@link org.eclipse.jgit.events.ConfigChangedEvent}s.
+ */
 public interface ConfigChangedListener extends RepositoryListener {
        /**
         * Invoked when any change is made to the configuration.

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/events/IndexChangedEvent.java b/org.eclipse.jgit/src/org/eclipse/jgit/events/IndexChangedEvent.java
index a54288ee9ea41a2dc059250550983f9704b81539..647ec8a20c4a7fc28b256179ff36007c84f8452a 100644 (file)
--- a/org.eclipse.jgit/src/org/eclipse/jgit/events/IndexChangedEvent.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/events/IndexChangedEvent.java
@@ -43,13 +43,17 @@
 
 package org.eclipse.jgit.events;
 
-/** Describes a change to one or more paths in the index file. */
+/**
+ * Describes a change to one or more paths in the index file.
+ */
 public class IndexChangedEvent extends RepositoryEvent<IndexChangedListener> {
+       /** {@inheritDoc} */
        @Override
        public Class<IndexChangedListener> getListenerType() {
                return IndexChangedListener.class;
        }
 
+       /** {@inheritDoc} */
        @Override
        public void dispatch(IndexChangedListener listener) {
                listener.onIndexChanged(this);

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/events/IndexChangedListener.java b/org.eclipse.jgit/src/org/eclipse/jgit/events/IndexChangedListener.java
index d41ef74ee9edb232fa2a51f1eb3f4e37601e16c8..682cea563ac8d766b9584047e88f614730bbdfb3 100644 (file)
--- a/org.eclipse.jgit/src/org/eclipse/jgit/events/IndexChangedListener.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/events/IndexChangedListener.java
@@ -43,7 +43,9 @@
 
 package org.eclipse.jgit.events;
 
-/** Receives {@link IndexChangedEvent}s. */
+/**
+ * Receives {@link org.eclipse.jgit.events.IndexChangedEvent}s.
+ */
 public interface IndexChangedListener extends RepositoryListener {
        /**
         * Invoked when any change is made to the index.

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/events/ListenerHandle.java b/org.eclipse.jgit/src/org/eclipse/jgit/events/ListenerHandle.java
index d8cd756d998b8b92f08d91ea7ddd7a5af69ec198..dcd5374073f2400fc27d7bc1113d89c3c1e43447 100644 (file)
--- a/org.eclipse.jgit/src/org/eclipse/jgit/events/ListenerHandle.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/events/ListenerHandle.java
@@ -43,7 +43,9 @@
 
 package org.eclipse.jgit.events;
 
-/** Tracks a previously registered {@link RepositoryListener}. */
+/**
+ * Tracks a previously registered {@link org.eclipse.jgit.events.RepositoryListener}.
+ */
 public class ListenerHandle {
        private final ListenerList parent;
 
@@ -59,11 +61,14 @@ public class ListenerHandle {
                this.listener = listener;
        }
 
-       /** Remove the listener and stop receiving events. */
+       /**
+        * Remove the listener and stop receiving events.
+        */
        public void remove() {
                parent.remove(this);
        }
 
+       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/events/ListenerList.java b/org.eclipse.jgit/src/org/eclipse/jgit/events/ListenerList.java
index cea03db2ec14db95648658499f9b709db924f55a..9be1c96e913292ad07c08709151fe5b92637b4e3 100644 (file)
--- a/org.eclipse.jgit/src/org/eclipse/jgit/events/ListenerList.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/events/ListenerList.java
@@ -48,12 +48,14 @@ import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentMap;
 import java.util.concurrent.CopyOnWriteArrayList;
 
-/** Manages a thread-safe list of {@link RepositoryListener}s. */
+/**
+ * Manages a thread-safe list of {@link org.eclipse.jgit.events.RepositoryListener}s.
+ */
 public class ListenerList {
        private final ConcurrentMap<Class<? extends RepositoryListener>, CopyOnWriteArrayList<ListenerHandle>> lists = new ConcurrentHashMap<>();
 
        /**
-        * Register a {@link WorkingTreeModifiedListener}.
+        * Register a {@link org.eclipse.jgit.events.WorkingTreeModifiedListener}.
         *
         * @param listener
         *            the listener implementation.
@@ -102,8 +104,6 @@ public class ListenerList {
        /**
         * Add a listener to the list.
         *
-        * @param <T>
-        *            the type of listener being registered.
         * @param type
         *            type of listener being registered.
         * @param listener

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/events/RefsChangedEvent.java b/org.eclipse.jgit/src/org/eclipse/jgit/events/RefsChangedEvent.java
index 36af3f8b77bca66a20561240be1c51b92d9b8c0e..f1923afc2089180cbde68d64a966d7885f0f65b7 100644 (file)
--- a/org.eclipse.jgit/src/org/eclipse/jgit/events/RefsChangedEvent.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/events/RefsChangedEvent.java
@@ -43,13 +43,17 @@
 
 package org.eclipse.jgit.events;
 
-/** Describes a change to one or more references of a repository. */
+/**
+ * Describes a change to one or more references of a repository.
+ */
 public class RefsChangedEvent extends RepositoryEvent<RefsChangedListener> {
+       /** {@inheritDoc} */
        @Override
        public Class<RefsChangedListener> getListenerType() {
                return RefsChangedListener.class;
        }
 
+       /** {@inheritDoc} */
        @Override
        public void dispatch(RefsChangedListener listener) {
                listener.onRefsChanged(this);

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/events/RefsChangedListener.java b/org.eclipse.jgit/src/org/eclipse/jgit/events/RefsChangedListener.java
index 9c0f4ed588c214ddc1818dbb03671fa8499f87a0..f3cdad12e5a33b50f9b315104d38c00d776df035 100644 (file)
--- a/org.eclipse.jgit/src/org/eclipse/jgit/events/RefsChangedListener.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/events/RefsChangedListener.java
@@ -43,7 +43,9 @@
 
 package org.eclipse.jgit.events;
 
-/** Receives {@link RefsChangedEvent}s. */
+/**
+ * Receives {@link org.eclipse.jgit.events.RefsChangedEvent}s.
+ */
 public interface RefsChangedListener extends RepositoryListener {
        /**
         * Invoked when any reference changes.

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/events/RepositoryEvent.java b/org.eclipse.jgit/src/org/eclipse/jgit/events/RepositoryEvent.java
index 1b7d28c333abdbeb6dca421f6a718e160c9cfed7..576b21ba617a094b739061968d89ba519d697a70 100644 (file)
--- a/org.eclipse.jgit/src/org/eclipse/jgit/events/RepositoryEvent.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/events/RepositoryEvent.java
@@ -59,7 +59,8 @@ public abstract class RepositoryEvent<T extends RepositoryListener> {
         * Set the repository this event occurred on.
         * <p>
         * This method should only be invoked once on each event object, and is
-        * automatically set by {@link Repository#fireEvent(RepositoryEvent)}.
+        * automatically set by
+        * {@link org.eclipse.jgit.lib.Repository#fireEvent(RepositoryEvent)}.
         *
         * @param r
         *            the repository.
@@ -69,12 +70,20 @@ public abstract class RepositoryEvent<T extends RepositoryListener> {
                        repository = r;
        }
 
-       /** @return the repository that was changed. */
+       /**
+        * Get the repository that was changed
+        *
+        * @return the repository that was changed
+        */
        public Repository getRepository() {
                return repository;
        }
 
-       /** @return type of listener this event dispatches to. */
+       /**
+        * Get type of listener this event dispatches to
+        *
+        * @return type of listener this event dispatches to
+        */
        public abstract Class<T> getListenerType();
 
        /**
@@ -85,6 +94,7 @@ public abstract class RepositoryEvent<T extends RepositoryListener> {
         */
        public abstract void dispatch(T listener);
 
+       /** {@inheritDoc} */
        @SuppressWarnings("nls")
        @Override
        public String toString() {

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/events/RepositoryListener.java b/org.eclipse.jgit/src/org/eclipse/jgit/events/RepositoryListener.java
index 4f951e5f879edce92426d8ffc5ae0fbce5fb7e9d..a2cf0cc664bb893f4e8225d01ff6b76823ab4588 100644 (file)
--- a/org.eclipse.jgit/src/org/eclipse/jgit/events/RepositoryListener.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/events/RepositoryListener.java
@@ -43,7 +43,9 @@
 
 package org.eclipse.jgit.events;
 
-/** A listener can register for event delivery. */
+/**
+ * A listener can register for event delivery.
+ */
 public interface RepositoryListener {
        // Empty marker interface; see extensions for actual methods.
 }

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/events/WorkingTreeModifiedEvent.java b/org.eclipse.jgit/src/org/eclipse/jgit/events/WorkingTreeModifiedEvent.java
index 6517823db20feeb1abbfeb63d109b9733158467d..9fbcc4dd5069400ceed3063c36d3be3820d20075 100644 (file)
--- a/org.eclipse.jgit/src/org/eclipse/jgit/events/WorkingTreeModifiedEvent.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/events/WorkingTreeModifiedEvent.java
@@ -48,8 +48,9 @@ import java.util.Collections;
 import org.eclipse.jgit.annotations.NonNull;
 
 /**
- * A {@link RepositoryEvent} describing changes to the working tree. It is fired
- * whenever a {@link org.eclipse.jgit.dircache.DirCacheCheckout} modifies
+ * A {@link org.eclipse.jgit.events.RepositoryEvent} describing changes to the
+ * working tree. It is fired whenever a
+ * {@link org.eclipse.jgit.dircache.DirCacheCheckout} modifies
  * (adds/deletes/updates) files in the working tree.
  *
  * @since 4.9
@@ -62,8 +63,8 @@ public class WorkingTreeModifiedEvent
        private Collection<String> deleted;
 
        /**
-        * Creates a new {@link WorkingTreeModifiedEvent} with the given
-        * collections.
+        * Creates a new {@link org.eclipse.jgit.events.WorkingTreeModifiedEvent}
+        * with the given collections.
         *
         * @param modified
         *            repository-relative paths that were added or updated
@@ -88,8 +89,8 @@ public class WorkingTreeModifiedEvent
        }
 
        /**
-        * Retrieves the {@link Collection} of repository-relative paths of files
-        * that were modified (added or updated).
+        * Retrieves the {@link java.util.Collection} of repository-relative paths
+        * of files that were modified (added or updated).
         *
         * @return the set
         */
@@ -103,8 +104,8 @@ public class WorkingTreeModifiedEvent
        }
 
        /**
-        * Retrieves the {@link Collection} of repository-relative paths of files
-        * that were deleted.
+        * Retrieves the {@link java.util.Collection} of repository-relative paths
+        * of files that were deleted.
         *
         * @return the set
         */
@@ -117,11 +118,13 @@ public class WorkingTreeModifiedEvent
                return result;
        }
 
+       /** {@inheritDoc} */
        @Override
        public Class<WorkingTreeModifiedListener> getListenerType() {
                return WorkingTreeModifiedListener.class;
        }
 
+       /** {@inheritDoc} */
        @Override
        public void dispatch(WorkingTreeModifiedListener listener) {
                listener.onWorkingTreeModified(this);

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/events/WorkingTreeModifiedListener.java b/org.eclipse.jgit/src/org/eclipse/jgit/events/WorkingTreeModifiedListener.java
index 402a9002262b4a363d0d528b44cd7732895a04a0..728ce26a2cd9f449991d97993f66aaaa848867c1 100644 (file)
--- a/org.eclipse.jgit/src/org/eclipse/jgit/events/WorkingTreeModifiedListener.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/events/WorkingTreeModifiedListener.java
@@ -44,8 +44,8 @@
 package org.eclipse.jgit.events;
 
 /**
- * Receives {@link WorkingTreeModifiedEvent}s, which are fired whenever a
- * {@link org.eclipse.jgit.dircache.DirCacheCheckout} modifies
+ * Receives {@link org.eclipse.jgit.events.WorkingTreeModifiedEvent}s, which are
+ * fired whenever a {@link org.eclipse.jgit.dircache.DirCacheCheckout} modifies
  * (adds/deletes/updates) files in the working tree.
  *
  * @since 4.9
@@ -56,6 +56,8 @@ public interface WorkingTreeModifiedListener extends RepositoryListener {
         * Respond to working tree modifications.
         *
         * @param event
+        *            a {@link org.eclipse.jgit.events.WorkingTreeModifiedEvent}
+        *            object.
         */
        void onWorkingTreeModified(WorkingTreeModifiedEvent event);
 }