From 9f42099e31a0b6be3cf001131b60780ab746a6f8 Mon Sep 17 00:00:00 2001
From: Sebastian Sdorra <sebastian.sdorra@cloudogu.com>
Date: Tue, 10 Jul 2012 21:10:46 +0200
Subject: [PATCH] improve javadoc

---
 .../java/sonia/scm/repository/Branch.java     | 20 +++++++------
 .../java/sonia/scm/repository/Branches.java   | 28 ++++++++++---------
 .../main/java/sonia/scm/repository/Tag.java   |  5 ++--
 3 files changed, 29 insertions(+), 24 deletions(-)

diff --git a/scm-core/src/main/java/sonia/scm/repository/Branch.java b/scm-core/src/main/java/sonia/scm/repository/Branch.java
index e15d76a7f1..1012dc9db6 100644
--- a/scm-core/src/main/java/sonia/scm/repository/Branch.java
+++ b/scm-core/src/main/java/sonia/scm/repository/Branch.java
@@ -43,6 +43,7 @@ import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlRootElement;
 
 /**
+ * Represents a tag in a repository.
  *
  * @author Sebastian Sdorra
  * @since 1.18
@@ -53,16 +54,17 @@ public final class Branch implements Serializable
 {
 
   /**
-   * Constructs ...
+   * Constructs a new instance of branch.
+   * This constructor should only be called from JAXB.
    *
    */
   public Branch() {}
 
   /**
-   * Constructs ...
+   * Constructs a new branch.
    *
    *
-   * @param name
+   * @param name name of the branch
    */
   public Branch(String name)
   {
@@ -72,7 +74,7 @@ public final class Branch implements Serializable
   //~--- methods --------------------------------------------------------------
 
   /**
-   * Method description
+   * {@inheritDoc}
    *
    *
    * @param obj
@@ -98,7 +100,7 @@ public final class Branch implements Serializable
   }
 
   /**
-   * Method description
+   * {@inheritDoc}
    *
    *
    * @return
@@ -110,7 +112,7 @@ public final class Branch implements Serializable
   }
 
   /**
-   * Method description
+   * {@inheritDoc}
    *
    *
    * @return
@@ -128,10 +130,10 @@ public final class Branch implements Serializable
   //~--- get methods ----------------------------------------------------------
 
   /**
-   * Method description
+   * Returns the name of the branch
    *
    *
-   * @return
+   * @return name of the branch
    */
   public String getName()
   {
@@ -140,6 +142,6 @@ public final class Branch implements Serializable
 
   //~--- fields ---------------------------------------------------------------
 
-  /** Field description */
+  /** name of the branch */
   private String name;
 }
diff --git a/scm-core/src/main/java/sonia/scm/repository/Branches.java b/scm-core/src/main/java/sonia/scm/repository/Branches.java
index 624d37cbb7..bcd2d4da11 100644
--- a/scm-core/src/main/java/sonia/scm/repository/Branches.java
+++ b/scm-core/src/main/java/sonia/scm/repository/Branches.java
@@ -46,6 +46,7 @@ import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlRootElement;
 
 /**
+ * Represents all branches of a repository.
  *
  * @author Sebastian Sdorra
  * @since 1.18
@@ -56,16 +57,17 @@ public final class Branches implements Iterable<Branch>
 {
 
   /**
-   * Constructs ...
+   * Constructs a new instance of branches.
+   * This constructor should only be called from JAXB.
    *
    */
   public Branches() {}
 
   /**
-   * Constructs ...
+   * Constructs a new instance of branches.
    *
    *
-   * @param branches
+   * @param branches list of branches.
    */
   public Branches(Branch... branches)
   {
@@ -73,10 +75,10 @@ public final class Branches implements Iterable<Branch>
   }
 
   /**
-   * Constructs ...
+   * Constructs a new instance of branches.
    *
    *
-   * @param branches
+   * @param branches list of branches.
    */
   public Branches(List<Branch> branches)
   {
@@ -86,7 +88,7 @@ public final class Branches implements Iterable<Branch>
   //~--- methods --------------------------------------------------------------
 
   /**
-   * Method description
+   * {@inheritDoc}
    *
    *
    * @param obj
@@ -112,7 +114,7 @@ public final class Branches implements Iterable<Branch>
   }
 
   /**
-   * Method description
+   * {@inheritDoc}
    *
    *
    * @return
@@ -136,7 +138,7 @@ public final class Branches implements Iterable<Branch>
   }
 
   /**
-   * Method description
+   * {@inheritDoc}
    *
    *
    * @return
@@ -154,10 +156,10 @@ public final class Branches implements Iterable<Branch>
   //~--- get methods ----------------------------------------------------------
 
   /**
-   * Method description
+   * Returns all branches of a repository.
    *
    *
-   * @return
+   * @return all branches
    */
   public List<Branch> getBranches()
   {
@@ -172,10 +174,10 @@ public final class Branches implements Iterable<Branch>
   //~--- set methods ----------------------------------------------------------
 
   /**
-   * Method description
+   * Sets all branches.
    *
    *
-   * @param branches
+   * @param branches branches
    */
   public void setBranches(List<Branch> branches)
   {
@@ -184,7 +186,7 @@ public final class Branches implements Iterable<Branch>
 
   //~--- fields ---------------------------------------------------------------
 
-  /** Field description */
+  /** branches */
   @XmlElement(name="branch")
   private List<Branch> branches;
 }
diff --git a/scm-core/src/main/java/sonia/scm/repository/Tag.java b/scm-core/src/main/java/sonia/scm/repository/Tag.java
index 3f8945a5f2..8dd44e81a1 100644
--- a/scm-core/src/main/java/sonia/scm/repository/Tag.java
+++ b/scm-core/src/main/java/sonia/scm/repository/Tag.java
@@ -42,7 +42,7 @@ import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlRootElement;
 
 /**
- * Represents a tag in repository.
+ * Represents a tag in a repository.
  *
  * @author Sebastian Sdorra
  * @since 1.18
@@ -53,7 +53,8 @@ public final class Tag
 {
 
   /**
-   * Constructs ...
+   * Constructs a new instance of tag.
+   * This constructor should only be called from JAXB.
    *
    */
   public Tag() {}