From 57276d093b3d5d05e05dc2c912ef4e4361bd14cc Mon Sep 17 00:00:00 2001
From: Sebastian Sdorra <sebastian.sdorra@cloudogu.com>
Date: Sat, 8 Dec 2012 14:42:20 +0100
Subject: [PATCH] javadoc for AbstractUserManager class

---
 .../sonia/scm/user/AbstractUserManager.java   | 23 +++++++++++--------
 1 file changed, 13 insertions(+), 10 deletions(-)

diff --git a/scm-core/src/main/java/sonia/scm/user/AbstractUserManager.java b/scm-core/src/main/java/sonia/scm/user/AbstractUserManager.java
index ed1e24405e..2c3cb0b17d 100644
--- a/scm-core/src/main/java/sonia/scm/user/AbstractUserManager.java
+++ b/scm-core/src/main/java/sonia/scm/user/AbstractUserManager.java
@@ -45,6 +45,8 @@ import java.util.HashSet;
 import java.util.Set;
 
 /**
+ * Abstract base class for {@link UserManager} implementations. This class
+ * implements the listener methods of the {@link UserManager} interface.
  *
  * @author Sebastian Sdorra
  */
@@ -52,10 +54,10 @@ public abstract class AbstractUserManager implements UserManager
 {
 
   /**
-   * Method description
+   * Register a {@link UserListener}.
    *
    *
-   * @param listener
+   * @param listener {@link UserListener} to register
    */
   @Override
   public void addListener(UserListener listener)
@@ -64,10 +66,10 @@ public abstract class AbstractUserManager implements UserManager
   }
 
   /**
-   * Method description
+   * Register a {@link java.util.Collection} of {@link UserListener}s.
    *
    *
-   * @param listeners
+   * @param listeners listeners to register
    */
   @Override
   public void addListeners(Collection<UserListener> listeners)
@@ -76,10 +78,10 @@ public abstract class AbstractUserManager implements UserManager
   }
 
   /**
-   * Method description
+   * Remove specified {@link UserListener}.
    *
    *
-   * @param listener
+   * @param listener to remove
    */
   @Override
   public void removeListener(UserListener listener)
@@ -88,11 +90,12 @@ public abstract class AbstractUserManager implements UserManager
   }
 
   /**
-   * Method description
+   * Calls the {@link UserListener#onEvent(User,sonia.scm.HandlerEvent)}
+   * method of all registered listeners and send a {@link UserEvent} to
+   * the {@link ScmEventBus}.
    *
-   *
-   * @param user
-   * @param event
+   * @param user user that has changed
+   * @param event type of change event
    */
   protected void fireEvent(User user, HandlerEvent event)
   {