diff --git a/scm-core/src/main/java/sonia/scm/repository/api/BranchesCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/BranchesCommandBuilder.java index f009fb0136..78cb21b1dc 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/BranchesCommandBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/BranchesCommandBuilder.java @@ -53,8 +53,18 @@ import sonia.scm.repository.spi.BranchesCommand; import java.io.IOException; /** - * + * The branches command list all repository branches.
+ *
+ * Samples: + *
+ *
+ * Return all branches of a repository:
+ *

+ * BranchesCommandBuilder branchesCommand = repositoryService.getBranchesCommand();
+ * Branches branches = tagsCommand.getBranches();
+ * 
* @author Sebastian Sdorra + * @since 1.18 */ public final class BranchesCommandBuilder { @@ -92,10 +102,10 @@ public final class BranchesCommandBuilder //~--- get methods ---------------------------------------------------------- /** - * Method description + * Returns all branches from the repository. * * - * @return + * @return branches from the repository * * @throws IOException * @throws RepositoryException @@ -266,15 +276,15 @@ public final class BranchesCommandBuilder //~--- fields --------------------------------------------------------------- - /** Field description */ + /** branches command implementation */ private BranchesCommand branchesCommand; - /** Field description */ + /** cache for branches */ private Cache cache; - /** Field description */ + /** disable cache */ private boolean disableCache = false; - /** Field description */ + /** repository */ private Repository repository; } diff --git a/scm-core/src/main/java/sonia/scm/repository/api/TagsCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/TagsCommandBuilder.java index 4a4b99ae70..24b3a5d8f5 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/TagsCommandBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/TagsCommandBuilder.java @@ -54,17 +54,18 @@ import java.io.IOException; import java.util.List; /** - * The tags command list all repository tag.
+ * The tags command list all repository tags.
*
* Samples: *
*
* Return all tags of a repository:
*

- * TagsCommandBuilder tagsCommand = repositoryService.getLogCommand();
+ * TagsCommandBuilder tagsCommand = repositoryService.getTagsCommand();
  * Tags tags = tagsCommand.getTags();
  * 
* @author Sebastian Sdorra + * @since 1.18 */ public final class TagsCommandBuilder {