improve javadoc

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

View File

@@ -53,8 +53,18 @@ import sonia.scm.repository.spi.BranchesCommand;
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
* @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<CacheKey, Branches> cache;
/** Field description */
/** disable cache */
private boolean disableCache = false;
/** Field description */
/** repository */
private Repository repository;
}

View File

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