Skip to content

Commit

Permalink
Fixed JavaDoc issues.
Browse files Browse the repository at this point in the history
  • Loading branch information
khmarbaise committed May 11, 2019
1 parent cb60b2d commit 5e67418
Show file tree
Hide file tree
Showing 15 changed files with 51 additions and 27 deletions.
1 change: 1 addition & 0 deletions .gitignore
Expand Up @@ -4,3 +4,4 @@ target
.project
*.iml
*~
.idea
Expand Up @@ -54,7 +54,7 @@
* Reads the appassembler manifest file from the repo, and executes the specified main class.
*
* @author <a href="mailto:kaare.nilsen@gmail.com">Kaare Nilsen</a>
* @todo get rid of all the statics
* TODO: get rid of all the statics
*/
public class AppassemblerBooter
{
Expand Down
Expand Up @@ -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 )
Expand Down Expand Up @@ -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
Expand Down
Expand Up @@ -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
* <code>binFileExtensions</code> parameter.
* @throws MojoFailureException in case of an error.
*/
protected void setBinFileExtensions()
throws MojoFailureException
Expand Down
Expand Up @@ -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
Expand Down
Expand Up @@ -56,7 +56,7 @@ public String getGenerator()
/**
* Set the generator.
*
* @param generator
* @param generator The generator.
*/
public void setGenerator( String generator )
{
Expand Down
Expand Up @@ -134,7 +134,7 @@ public void setName( String name )
/**
* Set the id.
*
* @param id
* @param id The id.
*/
public void setId( String id )
{
Expand Down
Expand Up @@ -26,7 +26,6 @@

/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugst&oslash;l</a>
* @version $Id$
*/
public interface DaemonGenerator
{
Expand All @@ -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;
Expand Down
Expand Up @@ -32,7 +32,6 @@

/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugst&oslash;l</a>
* @version $Id$
*/
public interface DaemonGeneratorService
{
Expand Down Expand Up @@ -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;
Expand Down
Expand Up @@ -29,7 +29,6 @@

/**
* @author <a href="mailto:trygve.laugstol@objectware.no">Trygve Laugst&oslash;l</a>
* @version $Id$
*/
public interface DaemonMerger
{
Expand All @@ -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;
Expand Down
Expand Up @@ -47,7 +47,6 @@

/**
* @author <a href="mailto:trygve.laugstol@objectware.no">Trygve Laugst&oslash;l</a>
* @version $Id$
*/
public class Platform
{
Expand Down Expand Up @@ -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 )
Expand Down Expand Up @@ -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 )
Expand Down
Expand Up @@ -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 )
{
Expand Down
Expand Up @@ -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 )
{
Expand Down Expand Up @@ -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 );

Expand All @@ -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 )
Expand Down
Expand Up @@ -30,10 +30,9 @@

/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugst&oslash;l</a>
* @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
Expand Down
12 changes: 12 additions & 0 deletions src/site/site.xml
Expand Up @@ -31,6 +31,18 @@
<artifactId>maven-fluido-skin</artifactId>
<version>1.3.0</version>
</skin>
<custom>
<fluidoSkin>
<googleSearch>
<sitesearch>www.mojohaus.org</sitesearch>
</googleSearch>
<gitHub>
<projectId>mojohaus/${project.artifactId}</projectId>
<ribbonOrientation>right</ribbonOrientation>
<ribbonColor>gray</ribbonColor>
</gitHub>
</fluidoSkin>
</custom>
<body>
<menu name="Appassembler">
<item name="About" href="/index.html" />
Expand Down

0 comments on commit 5e67418

Please sign in to comment.