Nemcio/SCM-Manager
1
0
Fork 0
mirror of https://github.com/scm-manager/scm-manager.git synced 2025-11-16 10:16:16 +01:00
Code Issues Packages Projects Releases Activity

improve javadoc

Browse Source
This commit is contained in:
Sebastian Sdorra
2012-07-10 21:06:47 +02:00
parent 7a0ec93c1c
commit 396e4d5226
2 changed files with 20 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
scm-core/src/main/java/sonia/scm/repository/api/BranchesCommandBuilder.java
View File

@@ -53,8 +53,18 @@ import sonia.scm.repository.spi.BranchesCommand;
import java.io.IOException; import java.io.IOException;
/** /**
* * The branches command list all repository branches.<br />
* <br />
* <b>Samples:</b>
* <br />
* <br />
* Return all branches of a repository:<br />
* <pre><code>
* BranchesCommandBuilder branchesCommand = repositoryService.getBranchesCommand();
* Branches branches = tagsCommand.getBranches();
* </code></pre>
* @author Sebastian Sdorra * @author Sebastian Sdorra
* @since 1.18
*/ */
public final class BranchesCommandBuilder public final class BranchesCommandBuilder
{ {
@@ -92,10 +102,10 @@ public final class BranchesCommandBuilder
//~--- get methods ---------------------------------------------------------- //~--- get methods ----------------------------------------------------------
/** /**
* Method description * Returns all branches from the repository.
* *
* *
* @return * @return branches from the repository
* *
* @throws IOException * @throws IOException
* @throws RepositoryException * @throws RepositoryException
@@ -266,15 +276,15 @@ public final class BranchesCommandBuilder
//~--- fields --------------------------------------------------------------- //~--- fields ---------------------------------------------------------------
/** Field description */ /** branches command implementation */
private BranchesCommand branchesCommand; private BranchesCommand branchesCommand;
/** Field description */ /** cache for branches */
private Cache<CacheKey, Branches> cache; private Cache<CacheKey, Branches> cache;
/** Field description */ /** disable cache */
private boolean disableCache = false; private boolean disableCache = false;
/** Field description */ /** repository */
private Repository repository; private Repository repository;
} }

5
scm-core/src/main/java/sonia/scm/repository/api/TagsCommandBuilder.java
View File

@@ -54,17 +54,18 @@ import java.io.IOException;
import java.util.List; import java.util.List;
/** /**
* The tags command list all repository tag.<br /> * The tags command list all repository tags.<br />
* <br /> * <br />
* <b>Samples:</b> * <b>Samples:</b>
* <br /> * <br />
* <br /> * <br />
* Return all tags of a repository:<br /> * Return all tags of a repository:<br />
* <pre><code> * <pre><code>
* TagsCommandBuilder tagsCommand = repositoryService.getLogCommand(); * TagsCommandBuilder tagsCommand = repositoryService.getTagsCommand();
* Tags tags = tagsCommand.getTags(); * Tags tags = tagsCommand.getTags();
* </code></pre> * </code></pre>
* @author Sebastian Sdorra * @author Sebastian Sdorra
* @since 1.18
*/ */
public final class TagsCommandBuilder public final class TagsCommandBuilder
{ {