diff --git a/.gitignore b/.gitignore index f80959c8..1373474c 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ target .project *.iml *~ +.idea diff --git a/appassembler-booter/src/main/java/org/codehaus/mojo/appassembler/booter/AppassemblerBooter.java b/appassembler-booter/src/main/java/org/codehaus/mojo/appassembler/booter/AppassemblerBooter.java index a0a89e25..97455b0e 100644 --- a/appassembler-booter/src/main/java/org/codehaus/mojo/appassembler/booter/AppassemblerBooter.java +++ b/appassembler-booter/src/main/java/org/codehaus/mojo/appassembler/booter/AppassemblerBooter.java @@ -54,7 +54,7 @@ * Reads the appassembler manifest file from the repo, and executes the specified main class. * * @author Kaare Nilsen - * @todo get rid of all the statics + * TODO: get rid of all the statics */ public class AppassemblerBooter { diff --git a/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/AbstractAppAssemblerMojo.java b/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/AbstractAppAssemblerMojo.java index ab14bfe5..4dc93e13 100644 --- a/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/AbstractAppAssemblerMojo.java +++ b/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/AbstractAppAssemblerMojo.java @@ -169,7 +169,7 @@ protected ArtifactRepositoryLayout getArtifactRepositoryLayout() * @param artifact The artifact to install. * @param artifactRepository The repository where to install. * @param useTimestampInSnapshotFileName Using timestamp for SNAPSHOT's. - * @throws MojoExecutionException + * @throws MojoExecutionException in case of an error. */ protected void installArtifact( Artifact artifact, ArtifactRepository artifactRepository, boolean useTimestampInSnapshotFileName ) @@ -228,9 +228,9 @@ protected void installArtifact( Artifact artifact, ArtifactRepository artifactRe /** * Copy artifact to another repository. * - * @param artifact - * @param artifactRepository - * @throws MojoExecutionException + * @param artifact {@link Artifact} + * @param artifactRepository {@link ArtifactRepository} + * @throws MojoExecutionException in case of an error. */ protected void installArtifact( Artifact artifact, ArtifactRepository artifactRepository ) throws MojoExecutionException diff --git a/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/AbstractScriptGeneratorMojo.java b/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/AbstractScriptGeneratorMojo.java index f803cf05..58d9d84e 100644 --- a/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/AbstractScriptGeneratorMojo.java +++ b/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/AbstractScriptGeneratorMojo.java @@ -402,6 +402,7 @@ protected void installDependencies( final String outputDirectory, final String r /** * Set the extensions for bin files for the supported platforms. The values are taken from the Mojo's * binFileExtensions parameter. + * @throws MojoFailureException in case of an error. */ protected void setBinFileExtensions() throws MojoFailureException diff --git a/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/AssembleMojo.java b/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/AssembleMojo.java index 81236a33..1a514259 100644 --- a/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/AssembleMojo.java +++ b/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/AssembleMojo.java @@ -217,8 +217,8 @@ public void checkDeprecatedParameterAndFailIfOneOfThemIsUsed() * calling from Maven. * * @see org.apache.maven.plugin.AbstractMojo#execute() - * @throws {@link MojoExecutionException} - * @throws {@link MojoFailureException} + * @throws MojoExecutionException in case of an error. + * @throws MojoFailureException in case of an error. */ public void execute() throws MojoExecutionException, MojoFailureException diff --git a/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/GeneratorConfiguration.java b/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/GeneratorConfiguration.java index 4b03c056..b3128e05 100644 --- a/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/GeneratorConfiguration.java +++ b/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/GeneratorConfiguration.java @@ -56,7 +56,7 @@ public String getGenerator() /** * Set the generator. * - * @param generator + * @param generator The generator. */ public void setGenerator( String generator ) { diff --git a/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/Program.java b/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/Program.java index 3f82193d..0efb0378 100644 --- a/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/Program.java +++ b/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/Program.java @@ -134,7 +134,7 @@ public void setName( String name ) /** * Set the id. * - * @param id + * @param id The id. */ public void setId( String id ) { diff --git a/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/daemon/DaemonGenerator.java b/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/daemon/DaemonGenerator.java index 15f3ab6c..252ecc10 100644 --- a/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/daemon/DaemonGenerator.java +++ b/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/daemon/DaemonGenerator.java @@ -26,7 +26,6 @@ /** * @author Trygve Laugstøl - * @version $Id$ */ public interface DaemonGenerator { @@ -37,7 +36,7 @@ public interface DaemonGenerator /** * @param generationRequest The request to which is used for the Daemon. - * @throws DaemonGeneratorException + * @throws DaemonGeneratorException in case of an error. */ void generate( DaemonGenerationRequest generationRequest ) throws DaemonGeneratorException; diff --git a/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/daemon/DaemonGeneratorService.java b/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/daemon/DaemonGeneratorService.java index 5e5f1dff..06e6d37d 100644 --- a/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/daemon/DaemonGeneratorService.java +++ b/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/daemon/DaemonGeneratorService.java @@ -32,7 +32,6 @@ /** * @author Trygve Laugstøl - * @version $Id$ */ public interface DaemonGeneratorService { @@ -61,7 +60,7 @@ Daemon loadModel( File stubDescriptor ) /** * @param daemon The daemon to validate * @param descriptor An optional file reference that will be used in the exception messages. - * @throws DaemonGeneratorException + * @throws DaemonGeneratorException in case of an error. */ void validateDaemon( Daemon daemon, File descriptor ) throws DaemonGeneratorException; diff --git a/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/daemon/merge/DaemonMerger.java b/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/daemon/merge/DaemonMerger.java index cab101b2..9ff430e2 100644 --- a/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/daemon/merge/DaemonMerger.java +++ b/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/daemon/merge/DaemonMerger.java @@ -29,7 +29,6 @@ /** * @author Trygve Laugstøl - * @version $Id$ */ public interface DaemonMerger { @@ -41,10 +40,10 @@ public interface DaemonMerger /** * Merge two Daemons into a single one. * - * @param dominant - * @param recessive + * @param dominant {@link Daemon} + * @param recessive {@link Daemon} * @return The merged Daemon instance. - * @throws DaemonGeneratorException + * @throws DaemonGeneratorException in case of an error. */ Daemon mergeDaemons( Daemon dominant, Daemon recessive ) throws DaemonGeneratorException; diff --git a/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/daemon/script/Platform.java b/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/daemon/script/Platform.java index a0eedbbd..ad45ca13 100644 --- a/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/daemon/script/Platform.java +++ b/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/daemon/script/Platform.java @@ -47,7 +47,6 @@ /** * @author Trygve Laugstøl - * @version $Id$ */ public class Platform { @@ -455,6 +454,7 @@ private String addJvmSetting( String argType, String extraJvmArgument, String vm * Get the environment setup file. * * @param daemon The instance of the Daemon for which this is beeing produced. + * @param binFolder The binary folder. * @return The created string which contains the path to the setup file. */ public String getEnvSetup( Daemon daemon, String binFolder ) @@ -528,7 +528,7 @@ public String getName() /** * ShowConsole window. * - * @param daemon + * @param daemon {@link Daemon} * @return true yes false otherwise. */ public boolean isShowConsoleWindow( Daemon daemon ) diff --git a/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/util/ArtifactUtils.java b/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/util/ArtifactUtils.java index 30293567..c81489ff 100644 --- a/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/util/ArtifactUtils.java +++ b/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/util/ArtifactUtils.java @@ -40,9 +40,9 @@ private ArtifactUtils() * get relative path the copied artifact using base version. This is mainly use to SNAPSHOT instead of timestamp in * the file name * - * @param artifactRepositoryLayout - * @param artifact - * @return + * @param artifactRepositoryLayout {@link ArtifactRepositoryLayout} + * @param artifact {@link Artifact} + * @return The base version. */ public static String pathBaseVersionOf( ArtifactRepositoryLayout artifactRepositoryLayout, Artifact artifact ) { diff --git a/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/util/DependencyFactory.java b/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/util/DependencyFactory.java index b7c08d43..5e7e0f52 100644 --- a/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/util/DependencyFactory.java +++ b/appassembler-maven-plugin/src/main/java/org/codehaus/mojo/appassembler/util/DependencyFactory.java @@ -49,6 +49,10 @@ private DependencyFactory() /** * Used by GenericDaemonGenerator. + * @param artifact {@link Artifact} + * @param layout {@link ArtifactRepositoryLayout} + * @param outputFileNameMapping The name mapping. + * @return the dependency. */ public static Dependency create( Artifact artifact, ArtifactRepositoryLayout layout, String outputFileNameMapping ) { @@ -84,9 +88,14 @@ public static Dependency create( Artifact artifact, ArtifactRepositoryLayout lay /** * Used by AssembleMojo and JavaServiceWrapperDaemonGenerator. + * @param artifact {@link Artifact} + * @param layout {@link ArtifactRepositoryLayout} + * @param useTimestampInSnapshotFileName timestamp or not. + * @param outputFileNameMapping The name mapping. + * @return the dependency. */ - public static Dependency create( Artifact artifact, ArtifactRepositoryLayout layout, - boolean useTimestampInSnapshotFileName, String outputFileNameMapping ) + public static Dependency create(Artifact artifact, ArtifactRepositoryLayout layout, + boolean useTimestampInSnapshotFileName, String outputFileNameMapping) { Dependency dependency = create( artifact, layout, outputFileNameMapping ); @@ -100,6 +109,11 @@ public static Dependency create( Artifact artifact, ArtifactRepositoryLayout lay /** * Used by AbstractBooterDaemonGenerator. + * @param project {@link MavenProject} + * @param id The id. + * @param layout {@link ArtifactRepositoryLayout} + * @param outputFileNameMapping The name mapping. + * @return the dependency. */ public static Dependency create( MavenProject project, String id, ArtifactRepositoryLayout layout, String outputFileNameMapping ) diff --git a/appassembler-maven-plugin/src/test/java/org/codehaus/mojo/appassembler/daemon/jsw/JavaServiceWrapperDaemonGeneratorTest.java b/appassembler-maven-plugin/src/test/java/org/codehaus/mojo/appassembler/daemon/jsw/JavaServiceWrapperDaemonGeneratorTest.java index dd717c72..2e67daa7 100644 --- a/appassembler-maven-plugin/src/test/java/org/codehaus/mojo/appassembler/daemon/jsw/JavaServiceWrapperDaemonGeneratorTest.java +++ b/appassembler-maven-plugin/src/test/java/org/codehaus/mojo/appassembler/daemon/jsw/JavaServiceWrapperDaemonGeneratorTest.java @@ -30,10 +30,9 @@ /** * @author Trygve Laugstøl - * @version $Id$ - * @todo test could be improved - there are other conditions like + * TODO: test could be improved - there are other conditions like * "check if extra properties can override those from template" - * @todo reading POM/model should not be necessary? + * TODO: reading POM/model should not be necessary? */ public class JavaServiceWrapperDaemonGeneratorTest extends AbstractDaemonGeneratorTest diff --git a/src/site/site.xml b/src/site/site.xml index bb683f38..c07fcf06 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -31,6 +31,18 @@ maven-fluido-skin 1.3.0 + + + + www.mojohaus.org + + + mojohaus/${project.artifactId} + right + gray + + +