Fix Javadoc issues per Oracle conventions
diff --git a/src/main/java/org/apache/maven/shared/archiver/BuildHelper.java b/src/main/java/org/apache/maven/shared/archiver/BuildHelper.java
index 27cae40..090cb8b 100644
--- a/src/main/java/org/apache/maven/shared/archiver/BuildHelper.java
+++ b/src/main/java/org/apache/maven/shared/archiver/BuildHelper.java
@@ -97,7 +97,7 @@
* @param plugin can be null
* @param parameter the parameter name when configured in plugin's configuration
* @param defaultValueProperty the property name when default value is used for the plugin parameter
- * @return the value, or null if not configured at all, but using internal default from plugin.
+ * @return the value, or null if not configured at all, but using internal default from plugin
*/
public static String getPluginParameter(Model model, Plugin plugin, String parameter, String defaultValueProperty) {
String value = getPluginParameter(plugin, parameter);
diff --git a/src/main/java/org/apache/maven/shared/archiver/ManifestConfiguration.java b/src/main/java/org/apache/maven/shared/archiver/ManifestConfiguration.java
index 63a6191..8e2c056 100644
--- a/src/main/java/org/apache/maven/shared/archiver/ManifestConfiguration.java
+++ b/src/main/java/org/apache/maven/shared/archiver/ManifestConfiguration.java
@@ -30,7 +30,7 @@
public static final String CLASSPATH_LAYOUT_TYPE_SIMPLE = "simple";
/**
- * The layout type
+ * The layout type.
*/
public static final String CLASSPATH_LAYOUT_TYPE_REPOSITORY = "repository";
diff --git a/src/main/java/org/apache/maven/shared/archiver/MavenArchiveConfiguration.java b/src/main/java/org/apache/maven/shared/archiver/MavenArchiveConfiguration.java
index 8093f3d..70593fc 100644
--- a/src/main/java/org/apache/maven/shared/archiver/MavenArchiveConfiguration.java
+++ b/src/main/java/org/apache/maven/shared/archiver/MavenArchiveConfiguration.java
@@ -287,7 +287,7 @@
/**
* Returns the location of the "pom.properties" file. May be null, in which case a default value is choosen.
*
- * @return "pom.properties" location or null.
+ * @return "pom.properties" location or null
*/
public Path getPomPropertiesFile() {
return pomPropertiesFile;
@@ -296,7 +296,7 @@
/**
* Sets the location of the "pom.properties" file. May be null, in which case a default value is choosen.
*
- * @param pomPropertiesFile "pom.properties" location or null.
+ * @param pomPropertiesFile "pom.properties" location or null
*/
public void setPomPropertiesFile(Path pomPropertiesFile) {
this.pomPropertiesFile = pomPropertiesFile;
diff --git a/src/main/java/org/apache/maven/shared/archiver/MavenArchiver.java b/src/main/java/org/apache/maven/shared/archiver/MavenArchiver.java
index 7b4f053..b3b2ec2 100644
--- a/src/main/java/org/apache/maven/shared/archiver/MavenArchiver.java
+++ b/src/main/java/org/apache/maven/shared/archiver/MavenArchiver.java
@@ -85,7 +85,7 @@
+ "${artifact.version}${dashClassifier?}.${artifact.extension}";
/**
- * simple layout non unique.
+ * Simple layout non unique.
*/
public static final String SIMPLE_LAYOUT_NONUNIQUE =
"${artifact.artifactId}-${artifact.baseVersion}${dashClassifier?}.${artifact.extension}";
@@ -186,7 +186,7 @@
* @param project {@link org.apache.maven.api.Project}
* @param config {@link ManifestConfiguration}
* @return {@link org.codehaus.plexus.archiver.jar.Manifest}
- * @throws MavenArchiverException exception.
+ * @throws MavenArchiverException exception
*/
// TODO Add user attributes list and user groups list
public Manifest getManifest(Project project, ManifestConfiguration config) throws MavenArchiverException {
@@ -224,7 +224,7 @@
* @param session {@link org.apache.maven.api.Session}
* @param project {@link org.apache.maven.api.Project}
* @param config {@link ManifestConfiguration}
- * @param entries The entries.
+ * @param entries the entries
* @return {@link org.codehaus.plexus.archiver.jar.Manifest}
* @throws MavenArchiverException exception
*/
@@ -472,7 +472,7 @@
/**
* <p>setOutputFile.</p>
*
- * @param outputFile Set output file.
+ * @param outputFile set output file
*/
public void setOutputFile(File outputFile) {
archiveFile = outputFile;
@@ -484,7 +484,7 @@
* @param session {@link org.apache.maven.api.Session}
* @param project {@link org.apache.maven.api.Project}
* @param archiveConfiguration {@link MavenArchiveConfiguration}
- * @throws MavenArchiverException Archiver Exception.
+ * @throws MavenArchiverException archiver Exception
*/
public void createArchive(Session session, Project project, MavenArchiveConfiguration archiveConfiguration)
throws MavenArchiverException {
@@ -676,10 +676,10 @@
* @param outputTimestamp the value of {@code ${project.build.outputTimestamp}} (may be {@code null})
* @return the parsed timestamp as an {@code Optional<Instant>}, {@code empty} if input is {@code null} or input
* contains only 1 character (not a number)
- * @since 3.6.0
- * @throws IllegalArgumentException if the outputTimestamp is neither ISO 8601 nor an integer.
+ * @throws IllegalArgumentException if the outputTimestamp is neither ISO 8601 nor an integer
* @see <a href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=74682318">Maven Wiki "Reproducible/Verifiable
* Builds"</a>
+ * @since 3.6.0
*/
public static Optional<Instant> parseBuildOutputTimestamp(String outputTimestamp) {
// Fail fast on null and no timestamp configured (1 character configuration is useful to override
@@ -729,8 +729,8 @@
* Configure Reproducible Builds archive creation if a timestamp is provided.
*
* @param outputTimestamp the value of {@code project.build.outputTimestamp} (may be {@code null})
- * @since 3.6.0
* @see #parseBuildOutputTimestamp(String)
+ * @since 3.6.0
*/
public void configureReproducibleBuild(String outputTimestamp) {
parseBuildOutputTimestamp(outputTimestamp).map(FileTime::from).ifPresent(modifiedTime -> getArchiver()
diff --git a/src/main/java/org/apache/maven/shared/archiver/PomPropertiesUtil.java b/src/main/java/org/apache/maven/shared/archiver/PomPropertiesUtil.java
index 983c089..84b5e17 100644
--- a/src/main/java/org/apache/maven/shared/archiver/PomPropertiesUtil.java
+++ b/src/main/java/org/apache/maven/shared/archiver/PomPropertiesUtil.java
@@ -76,9 +76,9 @@
* @param project {@link org.apache.maven.api.Project}
* @param archiver {@link org.codehaus.plexus.archiver.Archiver}
* @param customPomPropertiesFile optional custom pom properties file
- * @param pomPropertiesFile The pom properties file.
- * @throws org.codehaus.plexus.archiver.ArchiverException archiver exception.
- * @throws java.io.IOException IO exception.
+ * @param pomPropertiesFile the pom properties file
+ * @throws java.io.IOException IO exception
+ * @throws org.codehaus.plexus.archiver.ArchiverException archiver exception
*/
public void createPomProperties(
Project project, Archiver archiver, Path customPomPropertiesFile, Path pomPropertiesFile)
