diff --git a/scm-core/src/main/java/sonia/scm/repository/api/AbstractPushOrPullResponse.java b/scm-core/src/main/java/sonia/scm/repository/api/AbstractPushOrPullResponse.java index 5c037a1454..e56c892722 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/AbstractPushOrPullResponse.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/AbstractPushOrPullResponse.java @@ -38,25 +38,28 @@ import javax.xml.bind.annotation.XmlAccessorType; import javax.xml.bind.annotation.XmlElement; /** + * Abstract base class for {@link PushResponse} and {@link PullResponse}. * * @author Sebastian Sdorra - * @since 1.31 + * @since 1.31 */ @XmlAccessorType(XmlAccessType.FIELD) public abstract class AbstractPushOrPullResponse { /** - * Constructs ... + * Constructs a new AbstractPushOrPullResponse. * */ public AbstractPushOrPullResponse() {} /** - * Constructs ... + * Constructs a new AbstractPushOrPullResponse. * * - * @param pushedChangesetCount + * @param pushedChangesetCount count of pushed/pulled changesets + * + * @param changesetCount */ public AbstractPushOrPullResponse(long changesetCount) { @@ -66,10 +69,10 @@ public abstract class AbstractPushOrPullResponse //~--- get methods ---------------------------------------------------------- /** - * Method description + * Returns the count of pushed/pulled changesets. * * - * @return + * @return count of pushed/pulled changesets */ public long getChangesetCount() { @@ -78,7 +81,7 @@ public abstract class AbstractPushOrPullResponse //~--- fields --------------------------------------------------------------- - /** Field description */ + /** count of pushed/pulled changesets */ @XmlElement(name = "changeset-count") private long changesetCount; } diff --git a/scm-core/src/main/java/sonia/scm/repository/api/PullCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/PullCommandBuilder.java index baf3ab7875..0f78385904 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/PullCommandBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/PullCommandBuilder.java @@ -51,6 +51,7 @@ import sonia.scm.security.RepositoryPermission; import java.io.IOException; /** + * The pull command pull changes from a other repository. * * @author Sebastian Sdorra * @since 1.31 @@ -67,11 +68,11 @@ public final class PullCommandBuilder //~--- constructors --------------------------------------------------------- /** - * Constructs ... + * Constructs a new PullCommandBuilder. * * - * @param command - * @param localRepository + * @param command pull command implementation + * @param localRepository local repository */ PullCommandBuilder(PullCommand command, Repository localRepository) { @@ -82,12 +83,12 @@ public final class PullCommandBuilder //~--- methods -------------------------------------------------------------- /** - * Method description + * Pull all changes from the given remote repository. * * - * @param remoteRepository + * @param remoteRepository remote repository * - * @return + * @return informations over the executed pull command * * @throws IOException * @throws RepositoryException @@ -115,12 +116,12 @@ public final class PullCommandBuilder //~--- fields --------------------------------------------------------------- - /** Field description */ + /** pull command implementation */ private PullCommand command; - /** Field description */ + /** local repository */ private Repository localRepository; - /** Field description */ + /** pull command request */ private PullCommandRequest request = new PullCommandRequest(); } diff --git a/scm-core/src/main/java/sonia/scm/repository/api/PullResponse.java b/scm-core/src/main/java/sonia/scm/repository/api/PullResponse.java index 29c7009ea5..e280088f3c 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/PullResponse.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/PullResponse.java @@ -32,6 +32,9 @@ package sonia.scm.repository.api; /** + * The {@link PullResponse} is the result of the + * {@link PullCommandBuilder#pull(sonia.scm.repository.Repository)} method and + * contains informations over the executed pull command. * * @author Sebastian Sdorra * @since 1.31 @@ -40,16 +43,16 @@ public final class PullResponse extends AbstractPushOrPullResponse { /** - * Constructs ... + * Constructs a new PullResponse. * */ public PullResponse() {} /** - * Constructs ... + * Constructs a new PullResponse. * * - * @param changesetCount + * @param changesetCount count of pulled changesets */ public PullResponse(long changesetCount) { diff --git a/scm-core/src/main/java/sonia/scm/repository/api/PushCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/PushCommandBuilder.java index 7f1096139a..7ad3d0242c 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/PushCommandBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/PushCommandBuilder.java @@ -48,17 +48,18 @@ import sonia.scm.security.RepositoryPermission; import java.io.IOException; /** - * + * The push command push changes to a other repository. + * * @author Sebastian Sdorra + * @since 1.31 */ public final class PushCommandBuilder { /** - * Constructs ... + * Constructs a new PushCommandBuilder. * - * - * @param command + * @param command implementation of the {@link PushCommand} */ PushCommandBuilder(PushCommand command) { @@ -68,12 +69,11 @@ public final class PushCommandBuilder //~--- methods -------------------------------------------------------------- /** - * Method description + * Push all changes to the given remote repository. * + * @param remoteRepository remote repository * - * @param remoteRepository - * - * @return + * @return informations of the executed push command * * @throws IOException * @throws RepositoryException @@ -96,9 +96,9 @@ public final class PushCommandBuilder //~--- fields --------------------------------------------------------------- - /** Field description */ + /** push command implementation */ private PushCommand command; - /** Field description */ + /** push command request */ private PushCommandRequest request = new PushCommandRequest(); } diff --git a/scm-core/src/main/java/sonia/scm/repository/api/PushResponse.java b/scm-core/src/main/java/sonia/scm/repository/api/PushResponse.java index 1345c2b30d..58c2d29a25 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/PushResponse.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/PushResponse.java @@ -36,7 +36,10 @@ package sonia.scm.repository.api; import javax.xml.bind.annotation.XmlRootElement; /** - * + * The {@link PushResponse} is the result of the + * {@link PushCommandBuilder#push(sonia.scm.repository.Repository)} method and + * contains informations over the executed push command. + * * @author Sebastian Sdorra * @since 1.31 */ @@ -45,16 +48,16 @@ public final class PushResponse extends AbstractPushOrPullResponse { /** - * Constructs ... + * Constructs a new PushResponse. * */ public PushResponse() {} /** - * Constructs ... + * Constructs a new PushResponse. * * - * @param changesetCount + * @param changesetCount count of pushed changesets */ public PushResponse(long changesetCount) { diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/RepositoryServiceProvider.java b/scm-core/src/main/java/sonia/scm/repository/spi/RepositoryServiceProvider.java index 4ff54f012e..f29af95ef2 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/RepositoryServiceProvider.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/RepositoryServiceProvider.java @@ -177,6 +177,7 @@ public abstract class RepositoryServiceProvider implements Closeable * * * @return + * @since 1.31 */ public PullCommand getPullCommand() { @@ -188,6 +189,7 @@ public abstract class RepositoryServiceProvider implements Closeable * * * @return + * @since 1.31 */ public PushCommand getPushCommand() {