You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by bd...@apache.org on 2023/06/06 17:18:01 UTC
[directory-server] 01/01: Update Maven plugin javadoc annotations
This is an automated email from the ASF dual-hosted git repository.
bdemers pushed a commit to branch mojo-annotations
in repository https://gitbox.apache.org/repos/asf/directory-server.git
commit 0cee26e2c6c0ab255dab1c780210f35d778f98df
Author: Brian Demers <bd...@apache.org>
AuthorDate: Tue Jun 6 13:17:42 2023 -0400
Update Maven plugin javadoc annotations
Replace the javadoc annotations with _proper_ annotations in GenerateMojo
This removes warnings from the build log
---
installers-maven-plugin/pom.xml | 8 +++
.../directory/server/installers/GenerateMojo.java | 65 +++++++++-------------
pom.xml | 6 ++
3 files changed, 39 insertions(+), 40 deletions(-)
diff --git a/installers-maven-plugin/pom.xml b/installers-maven-plugin/pom.xml
index 52165830c5..b60cf2ce77 100644
--- a/installers-maven-plugin/pom.xml
+++ b/installers-maven-plugin/pom.xml
@@ -37,11 +37,19 @@
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-plugin-api</artifactId>
+ <scope>provided</scope>
+ </dependency>
+
+ <dependency>
+ <groupId>org.apache.maven.plugin-tools</groupId>
+ <artifactId>maven-plugin-annotations</artifactId>
+ <scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-core</artifactId>
+ <scope>provided</scope>
</dependency>
<dependency>
diff --git a/installers-maven-plugin/src/main/java/org/apache/directory/server/installers/GenerateMojo.java b/installers-maven-plugin/src/main/java/org/apache/directory/server/installers/GenerateMojo.java
index 718ff4c1e4..a87888e945 100644
--- a/installers-maven-plugin/src/main/java/org/apache/directory/server/installers/GenerateMojo.java
+++ b/installers-maven-plugin/src/main/java/org/apache/directory/server/installers/GenerateMojo.java
@@ -40,114 +40,99 @@ import org.apache.directory.server.installers.rpm.RpmTarget;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
+import org.apache.maven.plugins.annotations.LifecyclePhase;
+import org.apache.maven.plugins.annotations.Mojo;
+import org.apache.maven.plugins.annotations.Parameter;
+import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.util.FileUtils;
/**
- * Maven 2 mojo creating the platform specific installation layout images.
- *
- * @goal generate
- * @description Creates platform specific installation layout images.
- * @phase package
- * @requiresDependencyResolution runtime
- *
+ * Creates platform specific installation layout images.
+ *
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
+@Mojo(name = "generate", defaultPhase = LifecyclePhase.PACKAGE, requiresDependencyResolution = ResolutionScope.RUNTIME)
public class GenerateMojo extends AbstractMojo
{
/**
* The target directory into which the mojo creates os and platform
* specific images.
- *
- * @parameter default-value="${project.build.directory}/installers"
*/
+ @Parameter(defaultValue = "${project.build.directory}/installers")
private File outputDirectory;
/**
* The associated maven project.
- *
- * @parameter property="project" default-value="${project}"
- * @required
*/
+ @Parameter(property = "project", readonly = true, required = true)
private MavenProject project;
/**
* The RPM installer targets.
- *
- * @parameter
*/
+ @Parameter
private RpmTarget[] rpmTargets;
/**
* The Mac OS X installer targets.
- *
- * @parameter
*/
+ @Parameter
private MacOsXPkgTarget[] macOsXPkgTargets;
/**
* The NSIS installer targets.
- *
- * @parameter
*/
+ @Parameter
private NsisTarget[] nsisTargets;
/**
* The Debian installer targets.
- *
- * @parameter
*/
+ @Parameter
private DebTarget[] debTargets;
/**
* The Binary installer targets.
- *
- * @parameter
*/
+ @Parameter
private BinTarget[] binTargets;
/**
* The Archive installers targets.
- *
- * @parameter
*/
+ @Parameter
private ArchiveTarget[] archiveTargets;
/**
* The dpkg utility executable.
- *
- * @parameter
- * property="installers.dpkg"
- * default-value="/usr/bin/dpkg"
*/
+ @Parameter(property = "installers.dpkg", defaultValue = "/usr/bin/dpkg")
private File dpkgUtility;
/**
* The PackageMaker utility executable.
- *
- * @parameter
- * property="installers.packageMaker"
- * default-value="/Developer/Applications/Utilities/PackageMaker.app/Contents/MacOS/PackageMaker"
*/
+ @Parameter(
+ property = "installers.packageMaker",
+ defaultValue = "/Developer/Applications/Utilities/PackageMaker.app/Contents/MacOS/PackageMaker")
private File packageMakerUtility;
/**
* The makensis utility executable.
- *
- * @parameter
- * property="installers.makensis"
- * default-value="/usr/bin/makensis"
*/
+ @Parameter(
+ property = "installers.makensis",
+ defaultValue = "/usr/bin/makensis")
private File makensisUtility;
/**
* The rpmbuild utility executable.
- *
- * @parameter
- * property="installers.rpmbuild"
- * default-value="/usr/bin/rpmbuild"
*/
+ @Parameter(
+ property = "installers.rpmbuild",
+ defaultValue = "/usr/bin/rpmbuild")
private File rpmbuildUtility;
/** The list containing all the targets */
diff --git a/pom.xml b/pom.xml
index 4b272e364a..2f96187fc7 100644
--- a/pom.xml
+++ b/pom.xml
@@ -1211,6 +1211,12 @@
<version>${maven.version}</version>
</dependency>
+ <dependency>
+ <groupId>org.apache.maven.plugin-tools</groupId>
+ <artifactId>maven-plugin-annotations</artifactId>
+ <version>${maven.plugin.tools.version}</version>
+ </dependency>
+
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-core</artifactId>