From d9eb76d7260514ea6e7d341d3e77885b8d76538e Mon Sep 17 00:00:00 2001 From: Aleksandr Mashchenko Date: Thu, 24 Mar 2016 22:04:36 +0200 Subject: [PATCH] documentation improvement --- .../plugin/gitflow/AbstractGitFlowMojo.java | 32 +++++++++++++++---- .../gitflow/GitFlowFeatureFinishMojo.java | 6 +++- .../gitflow/GitFlowFeatureStartMojo.java | 2 ++ .../gitflow/GitFlowHotfixFinishMojo.java | 6 +++- .../gitflow/GitFlowReleaseFinishMojo.java | 6 +++- .../plugin/gitflow/GitFlowReleaseMojo.java | 8 +++-- .../gitflow/GitFlowReleaseStartMojo.java | 2 ++ 7 files changed, 51 insertions(+), 11 deletions(-) diff --git a/src/main/java/com/amashchenko/maven/plugin/gitflow/AbstractGitFlowMojo.java b/src/main/java/com/amashchenko/maven/plugin/gitflow/AbstractGitFlowMojo.java index 19eb6ce7..58f4c668 100644 --- a/src/main/java/com/amashchenko/maven/plugin/gitflow/AbstractGitFlowMojo.java +++ b/src/main/java/com/amashchenko/maven/plugin/gitflow/AbstractGitFlowMojo.java @@ -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; diff --git a/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowFeatureFinishMojo.java b/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowFeatureFinishMojo.java index bba402e9..541bccc2 100644 --- a/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowFeatureFinishMojo.java +++ b/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowFeatureFinishMojo.java @@ -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; diff --git a/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowFeatureStartMojo.java b/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowFeatureStartMojo.java index 4b4e262c..93cc8261 100644 --- a/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowFeatureStartMojo.java +++ b/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowFeatureStartMojo.java @@ -38,6 +38,8 @@ public class GitFlowFeatureStartMojo extends AbstractGitFlowMojo { /** * Whether to skip changing project version. Default is false * (the feature name will be appended to project version). + * + * @since 1.0.5 */ @Parameter(property = "skipFeatureVersion", defaultValue = "false") private boolean skipFeatureVersion = false; diff --git a/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowHotfixFinishMojo.java b/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowHotfixFinishMojo.java index 19fd26d9..c2d04006 100644 --- a/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowHotfixFinishMojo.java +++ b/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowHotfixFinishMojo.java @@ -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; diff --git a/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowReleaseFinishMojo.java b/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowReleaseFinishMojo.java index 676ee35f..84292460 100644 --- a/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowReleaseFinishMojo.java +++ b/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowReleaseFinishMojo.java @@ -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; diff --git a/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowReleaseMojo.java b/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowReleaseMojo.java index 93b8880a..ebe9de40 100644 --- a/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowReleaseMojo.java +++ b/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowReleaseMojo.java @@ -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 { @@ -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; diff --git a/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowReleaseStartMojo.java b/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowReleaseStartMojo.java index 1d67e941..0d3fa737 100644 --- a/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowReleaseStartMojo.java +++ b/src/main/java/com/amashchenko/maven/plugin/gitflow/GitFlowReleaseStartMojo.java @@ -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 true * . + * + * @since 1.2.0 */ @Parameter(property = "sameBranchName", defaultValue = "false") private boolean sameBranchName = false;