Skip to content

Commit

Permalink
documentation improvement
Browse files Browse the repository at this point in the history
  • Loading branch information
aleksandr-m committed Mar 24, 2016
1 parent c210e68 commit d9eb76d
Show file tree
Hide file tree
Showing 7 changed files with 51 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -66,23 +66,43 @@ public abstract class AbstractGitFlowMojo extends AbstractMojo {
@Parameter(defaultValue = "${gitFlowConfig}")
protected GitFlowConfig gitFlowConfig;

/** Git commit messages. */
/**
* Git commit messages.
*
* @since 1.2.1
*/
@Parameter(defaultValue = "${commitMessages}")
protected CommitMessages commitMessages;

/** Whether this is Tycho build. */
/**
* Whether this is Tycho build.
*
* @since 1.1.0
*/
@Parameter(defaultValue = "false")
protected boolean tychoBuild;

/** Whether to call Maven install goal during the mojo execution. */
/**
* Whether to call Maven install goal during the mojo execution.
*
* @since 1.0.5
*/
@Parameter(property = "installProject", defaultValue = "false")
protected boolean installProject = false;

/** Whether to allow SNAPSHOT versions in dependencies. */
/**
* Whether to allow SNAPSHOT versions in dependencies.
*
* @since 1.2.2
*/
@Parameter(property = "allowSnapshots", defaultValue = "false")
protected boolean allowSnapshots = false;

/** Whether to print commands output into the console. */

/**
* Whether to print commands output into the console.
*
* @since 1.0.7
*/
@Parameter(property = "verbose", defaultValue = "false")
private boolean verbose = false;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,11 @@ public class GitFlowFeatureFinishMojo extends AbstractGitFlowMojo {
@Parameter(property = "keepBranch", defaultValue = "false")
private boolean keepBranch = false;

/** Whether to skip calling Maven test goal before merging the branch. */
/**
* Whether to skip calling Maven test goal before merging the branch.
*
* @since 1.0.5
*/
@Parameter(property = "skipTestProject", defaultValue = "false")
private boolean skipTestProject = false;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ public class GitFlowFeatureStartMojo extends AbstractGitFlowMojo {
/**
* Whether to skip changing project version. Default is <code>false</code>
* (the feature name will be appended to project version).
*
* @since 1.0.5
*/
@Parameter(property = "skipFeatureVersion", defaultValue = "false")
private boolean skipFeatureVersion = false;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,11 @@ public class GitFlowHotfixFinishMojo extends AbstractGitFlowMojo {
@Parameter(property = "keepBranch", defaultValue = "false")
private boolean keepBranch = false;

/** Whether to skip calling Maven test goal before merging the branch. */
/**
* Whether to skip calling Maven test goal before merging the branch.
*
* @since 1.0.5
*/
@Parameter(property = "skipTestProject", defaultValue = "false")
private boolean skipTestProject = false;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,11 @@ public class GitFlowReleaseFinishMojo extends AbstractGitFlowMojo {
@Parameter(property = "keepBranch", defaultValue = "false")
private boolean keepBranch = false;

/** Whether to skip calling Maven test goal before merging the branch. */
/**
* Whether to skip calling Maven test goal before merging the branch.
*
* @since 1.0.5
*/
@Parameter(property = "skipTestProject", defaultValue = "false")
private boolean skipTestProject = false;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* The git flow release mojo.
*
* @author Aleksandr Mashchenko
*
* @since 1.2.0
*/
@Mojo(name = "release", aggregator = true)
public class GitFlowReleaseMojo extends AbstractGitFlowMojo {
Expand All @@ -40,7 +40,11 @@ public class GitFlowReleaseMojo extends AbstractGitFlowMojo {
@Parameter(property = "skipTag", defaultValue = "false")
private boolean skipTag = false;

/** Whether to skip calling Maven test goal before releasing. */
/**
* Whether to skip calling Maven test goal before releasing.
*
* @since 1.0.5
*/
@Parameter(property = "skipTestProject", defaultValue = "false")
private boolean skipTestProject = false;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ public class GitFlowReleaseStartMojo extends AbstractGitFlowMojo {
* Note: By itself the default releaseBranchPrefix is not a valid branch
* name. You must change it when setting sameBranchName to <code>true</code>
* .
*
* @since 1.2.0
*/
@Parameter(property = "sameBranchName", defaultValue = "false")
private boolean sameBranchName = false;
Expand Down

0 comments on commit d9eb76d

Please sign in to comment.