This is an automated email from the ASF dual-hosted git repository.
elharo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-rar-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new 8ba34c8 Follow Oracle Javadoc conventions (#147)
8ba34c8 is described below
commit 8ba34c8148fb0730bf0fc901a3fa993ebf3fff83
Author: Elliotte Rusty Harold <[email protected]>
AuthorDate: Tue Nov 11 13:45:55 2025 -0600
Follow Oracle Javadoc conventions (#147)
* Follow Oracle Javadoc conventions
---
.../java/org/apache/maven/plugins/rar/RarMojo.java | 41 +++++++---------------
1 file changed, 12 insertions(+), 29 deletions(-)
diff --git a/src/main/java/org/apache/maven/plugins/rar/RarMojo.java
b/src/main/java/org/apache/maven/plugins/rar/RarMojo.java
index 1344aed..d9132b9 100644
--- a/src/main/java/org/apache/maven/plugins/rar/RarMojo.java
+++ b/src/main/java/org/apache/maven/plugins/rar/RarMojo.java
@@ -18,25 +18,6 @@
*/
package org.apache.maven.plugins.rar;
-/*
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
import javax.inject.Inject;
import java.io.File;
@@ -139,13 +120,13 @@ public class RarMojo extends AbstractMojo {
/**
* The archive configuration to use.
- * See <a
href="http://maven.apache.org/shared/maven-archiver/index.html";>Maven Archiver
Reference</a>.
+ * See <a
href="https://maven.apache.org/shared/maven-archiver/index.html";>Maven Archiver
Reference</a>.
*/
@Parameter
private MavenArchiveConfiguration archive = new
MavenArchiveConfiguration();
/**
- * allow filtering of link{rarSourceDirectory}
+ * Allow filtering of {@link rarSourceDirectory}.
*
* @since 2.3
*/
@@ -198,7 +179,7 @@ public class RarMojo extends AbstractMojo {
protected boolean includeEmptyDirs;
/**
- * stop searching endToken at the end of line
+ * Stop searching endToken at the end of line.
*
* @since 2.3
*/
@@ -262,7 +243,7 @@ public class RarMojo extends AbstractMojo {
protected List<String> nonFilteredFileExtensions;
/**
- * extra resource to include in rar archive
+ * Extra resource to include in rar archive.
*
* @since 2.3
*/
@@ -330,7 +311,9 @@ public class RarMojo extends AbstractMojo {
this.projectHelper = projectHelper;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void execute() throws MojoExecutionException {
if (skip) {
@@ -449,7 +432,7 @@ public class RarMojo extends AbstractMojo {
}
/**
- * @return The buildDir.
+ * @return the buildDir
*/
protected File getBuildDir() {
if (buildDir == null) {
@@ -459,10 +442,10 @@ public class RarMojo extends AbstractMojo {
}
/**
- * @param basedir The basedir.
- * @param finalName The finalName.
- * @param classifier The classifier.
- * @return the resulting file which contains classifier.
+ * @param basedir the base directory
+ * @param finalName the final name
+ * @param classifier the classifier
+ * @return the resulting file which contains classifier
*/
protected static File getRarFile(File basedir, String finalName, String
classifier) {
if (classifier == null) {
