You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by sl...@apache.org on 2021/12/08 23:33:53 UTC
[maven-war-plugin] branch master updated: (doc) javadoc fixes
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-war-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new 598650f (doc) javadoc fixes
598650f is described below
commit 598650f9959dfe0450e88fa780eb7b71a116ba49
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Thu Dec 9 00:27:36 2021 +0100
(doc) javadoc fixes
---
.../apache/maven/plugins/war/AbstractWarMojo.java | 6 ++--
.../java/org/apache/maven/plugins/war/WarMojo.java | 6 +++-
.../maven/plugins/war/overlay/OverlayManager.java | 2 +-
.../war/packaging/AbstractWarPackagingTask.java | 22 ++++++------
.../war/packaging/ClassesPackagingTask.java | 2 +-
.../war/packaging/CopyUserManifestTask.java | 10 ++++++
.../plugins/war/packaging/WarPackagingContext.java | 10 +++---
.../maven/plugins/war/util/DependencyInfo.java | 4 +--
.../maven/plugins/war/util/WebappStructure.java | 40 +++++++++++-----------
.../plugins/war/AbstractWarExplodedMojoTest.java | 2 +-
.../apache/maven/plugins/war/WarOverlaysTest.java | 8 ++---
11 files changed, 63 insertions(+), 49 deletions(-)
diff --git a/src/main/java/org/apache/maven/plugins/war/AbstractWarMojo.java b/src/main/java/org/apache/maven/plugins/war/AbstractWarMojo.java
index dc1ecb3..cb26955 100644
--- a/src/main/java/org/apache/maven/plugins/war/AbstractWarMojo.java
+++ b/src/main/java/org/apache/maven/plugins/war/AbstractWarMojo.java
@@ -256,7 +256,7 @@ public abstract class AbstractWarMojo
/**
* The overlays to apply. Each <overlay> element may contain:
* <ul>
- * <li>id (defaults to <tt>currentBuild</tt>)</li>
+ * <li>id (defaults to {@code currentBuild})</li>
* <li>groupId (if this and artifactId are null, then the current project is treated as its own overlay)</li>
* <li>artifactId (see above)</li>
* <li>classifier</li>
@@ -463,7 +463,7 @@ public abstract class AbstractWarMojo
/**
* Builds the webapp for the specified project with the new packaging task thingy.
- * Classes, libraries and tld files are copied to the <tt>webappDirectory</tt> during this phase.
+ * Classes, libraries and tld files are copied to the {@code webappDirectory} during this phase.
*
* @param mavenProject the maven project
* @param webapplicationDirectory the target directory
@@ -538,7 +538,7 @@ public abstract class AbstractWarMojo
}
/**
- * Returns a <tt>List</tt> of the {@link org.apache.maven.plugins.war.packaging.WarPackagingTask}
+ * Returns a {@code List} of the {@link org.apache.maven.plugins.war.packaging.WarPackagingTask}
* instances to invoke to perform the packaging.
*
* @param overlayManager the overlay manager
diff --git a/src/main/java/org/apache/maven/plugins/war/WarMojo.java b/src/main/java/org/apache/maven/plugins/war/WarMojo.java
index 3dda4c9..97939f9 100644
--- a/src/main/java/org/apache/maven/plugins/war/WarMojo.java
+++ b/src/main/java/org/apache/maven/plugins/war/WarMojo.java
@@ -193,7 +193,7 @@ public class WarMojo
}
/**
- * Generates the webapp according to the <tt>mode</tt> attribute.
+ * Generates the webapp according to the {@code mode} attribute.
*
* @param warFile the target WAR file
* @throws IOException if an error occurred while copying files
@@ -580,6 +580,10 @@ public class WarMojo
this.failOnMissingWebXml = failOnMissingWebXml;
}
+ /**
+ * Skip the mojo run
+ * @return {@link #skip}
+ */
public boolean isSkip()
{
return skip;
diff --git a/src/main/java/org/apache/maven/plugins/war/overlay/OverlayManager.java b/src/main/java/org/apache/maven/plugins/war/overlay/OverlayManager.java
index cf83d5e..ae0ee8e 100644
--- a/src/main/java/org/apache/maven/plugins/war/overlay/OverlayManager.java
+++ b/src/main/java/org/apache/maven/plugins/war/overlay/OverlayManager.java
@@ -170,7 +170,7 @@ public class OverlayManager
/**
* Returns the Artifact associated to the specified overlay.
*
- * If the overlay defines the current project, <tt>null</tt> is returned. If no artifact could not be found for the
+ * If the overlay defines the current project, {@code null} is returned. If no artifact could not be found for the
* overlay a InvalidOverlayConfigurationException is thrown.
*
* @param overlay an overlay
diff --git a/src/main/java/org/apache/maven/plugins/war/packaging/AbstractWarPackagingTask.java b/src/main/java/org/apache/maven/plugins/war/packaging/AbstractWarPackagingTask.java
index e230f6c..a545e52 100644
--- a/src/main/java/org/apache/maven/plugins/war/packaging/AbstractWarPackagingTask.java
+++ b/src/main/java/org/apache/maven/plugins/war/packaging/AbstractWarPackagingTask.java
@@ -74,13 +74,13 @@ public abstract class AbstractWarPackagingTask
* Copy uses a first-win strategy: files that have already been copied by previous tasks are ignored. This method
* makes sure to update the list of protected files which gives the list of files that have already been copied.
*
- * If the structure of the source directory is not the same as the root of the webapp, use the <tt>targetPrefix</tt>
- * parameter to specify in which particular directory the files should be copied. Use <tt>null</tt> to copy the
+ * If the structure of the source directory is not the same as the root of the webapp, use the {@code targetPrefix}
+ * parameter to specify in which particular directory the files should be copied. Use {@code null} to copy the
* files with the same structure
*
* @param sourceId the source id
* @param context the context to use
- * @param sourceBaseDir the base directory from which the <tt>sourceFilesSet</tt> will be copied
+ * @param sourceBaseDir the base directory from which the {@code sourceFilesSet} will be copied
* @param sourceFilesSet the files to be copied
* @param targetPrefix the prefix to add to the target file name
* @param filtered filter or not.
@@ -124,7 +124,7 @@ public abstract class AbstractWarPackagingTask
*
* @param sourceId the source id
* @param context the context to use
- * @param sourceBaseDir the base directory from which the <tt>sourceFilesSet</tt> will be copied
+ * @param sourceBaseDir the base directory from which the {@code sourceFilesSet} will be copied
* @param sourceFilesSet the files to be copied
* @param filtered filter or not.
* @throws IOException if an error occurred while copying the files
@@ -140,7 +140,7 @@ public abstract class AbstractWarPackagingTask
/**
* Copy the specified file if the target location has not yet already been used.
*
- * The <tt>targetFileName</tt> is the relative path according to the root of the generated web application.
+ * The {@code targetFileName} is the relative path according to the root of the generated web application.
*
* @param sourceId the source id
* @param context the context to use
@@ -228,7 +228,7 @@ public abstract class AbstractWarPackagingTask
* Copy the specified file if the target location has not yet already been used and filter its content with the
* configured filter properties.
*
- * The <tt>targetFileName</tt> is the relative path according to the root of the generated web application.
+ * The {@code targetFileName} is the relative path according to the root of the generated web application.
*
* @param sourceId the source id
* @param context the context to use
@@ -318,8 +318,8 @@ public abstract class AbstractWarPackagingTask
/**
* Copy file from source to destination. The directories up to <code>destination</code> will be created if they
- * don't already exist. if the <code>onlyIfModified</code> flag is <tt>false</tt>, <code>destination</code> will be
- * overwritten if it already exists. If the flag is <tt>true</tt> destination will be overwritten if it's not up to
+ * don't already exist. if the <code>onlyIfModified</code> flag is {@code false}, <code>destination</code> will be
+ * overwritten if it already exists. If the flag is {@code true} destination will be overwritten if it's not up to
* date.
*
* @param context the packaging context
@@ -392,7 +392,7 @@ public abstract class AbstractWarPackagingTask
}
/**
- * Returns the file to copy. If the includes are <tt>null</tt> or empty, the default includes are used.
+ * Returns the file to copy. If the includes are {@code null} or empty, the default includes are used.
*
* @param baseDir the base directory to start from
* @param includes the includes
@@ -405,7 +405,7 @@ public abstract class AbstractWarPackagingTask
}
/**
- * Returns the file to copy. If the includes are <tt>null</tt> or empty, the default includes are used.
+ * Returns the file to copy. If the includes are {@code null} or empty, the default includes are used.
*
* @param baseDir the base directory to start from
* @param includes the includes
@@ -450,7 +450,7 @@ public abstract class AbstractWarPackagingTask
/**
* Returns the final name of the specified artifact.
*
- * If the <tt>outputFileNameMapping</tt> is set, it is used, otherwise the standard naming scheme is used.
+ * If the {@code outputFileNameMapping} is set, it is used, otherwise the standard naming scheme is used.
*
* @param context the packaging context
* @param artifact the artifact
diff --git a/src/main/java/org/apache/maven/plugins/war/packaging/ClassesPackagingTask.java b/src/main/java/org/apache/maven/plugins/war/packaging/ClassesPackagingTask.java
index ea136a6..654469e 100644
--- a/src/main/java/org/apache/maven/plugins/war/packaging/ClassesPackagingTask.java
+++ b/src/main/java/org/apache/maven/plugins/war/packaging/ClassesPackagingTask.java
@@ -35,7 +35,7 @@ import java.io.IOException;
* Handles the classes directory that needs to be packaged in the web application.
*
* Based on the {@link WarPackagingContext#archiveClasses()} flag, the resources are either copied into to
- * <tt>WEB-INF/classes</tt> directory or archived in a jar within the <tt>WEB-INF/lib</tt> directory.
+ * {@code WEB-INF/classes} directory or archived in a jar within the {@code WEB-INF/lib} directory.
*
* @author Stephane Nicoll
*/
diff --git a/src/main/java/org/apache/maven/plugins/war/packaging/CopyUserManifestTask.java b/src/main/java/org/apache/maven/plugins/war/packaging/CopyUserManifestTask.java
index 217c18a..f98a7c5 100644
--- a/src/main/java/org/apache/maven/plugins/war/packaging/CopyUserManifestTask.java
+++ b/src/main/java/org/apache/maven/plugins/war/packaging/CopyUserManifestTask.java
@@ -38,6 +38,11 @@ public class CopyUserManifestTask
/** Instance logger */
private Log log;
+ /**
+ * Returns the logger.
+ *
+ * @return logger
+ */
public Log getLog()
{
if ( log == null )
@@ -47,6 +52,11 @@ public class CopyUserManifestTask
return log;
}
+ /**
+ * The logger.
+ *
+ * @param log the logger to set
+ */
public void setLog( Log log )
{
this.log = log;
diff --git a/src/main/java/org/apache/maven/plugins/war/packaging/WarPackagingContext.java b/src/main/java/org/apache/maven/plugins/war/packaging/WarPackagingContext.java
index 29336a2..caba428 100644
--- a/src/main/java/org/apache/maven/plugins/war/packaging/WarPackagingContext.java
+++ b/src/main/java/org/apache/maven/plugins/war/packaging/WarPackagingContext.java
@@ -90,7 +90,7 @@ public interface WarPackagingContext
File getClassesDirectory();
/**
- * Specify whether the classes resources should be archived in the <tt>WEB-INF/lib</tt> of the generated web app.
+ * Specify whether the classes resources should be archived in the {@code WEB-INF/lib} of the generated web app.
*
* @return true if the classes should be archived, false otherwise
*/
@@ -132,9 +132,9 @@ public interface WarPackagingContext
JarArchiver getJarArchiver();
/**
- * Returns the output file name mapping to use, if any. Returns <tt>null</tt> if no file name mapping is set.
+ * Returns the output file name mapping to use, if any. Returns {@code null} if no file name mapping is set.
*
- * @return the output file name mapping or <tt>null</tt>
+ * @return the output file name mapping or {@code null}
*/
String getOutputFileNameMapping();
@@ -174,10 +174,10 @@ public interface WarPackagingContext
List<FilterWrapper> getFilterWrappers();
/**
- * Specify if the given <tt>fileName</tt> belongs to the list of extensions that must not be filtered
+ * Specify if the given {@code fileName} belongs to the list of extensions that must not be filtered
*
* @param fileName the name of file
- * @return <tt>true</tt> if it should not be filtered, <tt>false</tt> otherwise
+ * @return {@code true} if it should not be filtered, {@code false} otherwise
* @since 2.1-alpha-2
*/
boolean isNonFilteredExtension( String fileName );
diff --git a/src/main/java/org/apache/maven/plugins/war/util/DependencyInfo.java b/src/main/java/org/apache/maven/plugins/war/util/DependencyInfo.java
index f38ab06..ece99dd 100644
--- a/src/main/java/org/apache/maven/plugins/war/util/DependencyInfo.java
+++ b/src/main/java/org/apache/maven/plugins/war/util/DependencyInfo.java
@@ -56,9 +56,9 @@ public class DependencyInfo
}
/**
- * Returns the target filename of the dependency. If no target file name is associated, returns <tt>null</tt>.
+ * Returns the target filename of the dependency. If no target file name is associated, returns {@code null}.
*
- * @return the target file name or <tt>null</tt>
+ * @return the target file name or {@code null}
*/
public String getTargetFileName()
{
diff --git a/src/main/java/org/apache/maven/plugins/war/util/WebappStructure.java b/src/main/java/org/apache/maven/plugins/war/util/WebappStructure.java
index 9d11650..b48e1e6 100644
--- a/src/main/java/org/apache/maven/plugins/war/util/WebappStructure.java
+++ b/src/main/java/org/apache/maven/plugins/war/util/WebappStructure.java
@@ -88,7 +88,7 @@ public class WebappStructure
}
/**
- * Specify if the specified <tt>path</tt> is registered or not.
+ * Specify if the specified {@code path} is registered or not.
*
* @param path the relative path from the webapp root directory
* @return true if the path is registered, false otherwise
@@ -100,8 +100,8 @@ public class WebappStructure
}
/**
- * Registers the specified path for the specified owner. Returns <tt>true</tt> if the path is not already
- * registered, <tt>false</tt> otherwise.
+ * Registers the specified path for the specified owner. Returns {@code true} if the path is not already
+ * registered, {@code false} otherwise.
*
* @param id the owner of the path
* @param path the relative path from the webapp root directory
@@ -125,7 +125,7 @@ public class WebappStructure
* simple registration is performed. If the file already exists, the owner changes to the specified one.
* <p>
* Beware that the semantic of the return boolean is different than the one from
- * {@link #registerFile(String, String)}; returns <tt>true</tt> if an owner replacement was made and <tt>false</tt>
+ * {@link #registerFile(String, String)}; returns {@code true} if an owner replacement was made and {@code false}
* if the file was simply registered for the first time.</p>
*
* @param id the owner of the path
@@ -150,7 +150,7 @@ public class WebappStructure
}
/**
- * Registers the specified path for the specified owner. Invokes the <tt>callback</tt> with the result of the
+ * Registers the specified path for the specified owner. Invokes the {@code callback} with the result of the
* registration.
*
* @param id the owner of the path
@@ -192,10 +192,10 @@ public class WebappStructure
}
/**
- * Returns the owner of the specified <tt>path</tt>. If the file is not registered, returns <tt>null</tt>
+ * Returns the owner of the specified {@code path}. If the file is not registered, returns {@code null}
*
* @param path the relative path from the webapp root directory
- * @return the owner or <tt>null</tt>.
+ * @return the owner or {@code null}.
*/
public String getOwner( String path )
{
@@ -319,9 +319,9 @@ public class WebappStructure
{
/**
- * Called if the <tt>targetFilename</tt> for the specified <tt>ownerId</tt> has been registered successfully.
+ * Called if the {@code targetFilename} for the specified {@code ownerId} has been registered successfully.
*
- * This means that the <tt>targetFilename</tt> was unknown and has been registered successfully.
+ * This means that the {@code targetFilename} was unknown and has been registered successfully.
*
* @param ownerId the ownerId
* @param targetFilename the relative path according to the root of the webapp
@@ -331,9 +331,9 @@ public class WebappStructure
throws IOException;
/**
- * Called if the <tt>targetFilename</tt> for the specified <tt>ownerId</tt> has already been registered.
+ * Called if the {@code targetFilename} for the specified {@code ownerId} has already been registered.
*
- * This means that the <tt>targetFilename</tt> was known and belongs to the specified owner.
+ * This means that the {@code targetFilename} was known and belongs to the specified owner.
*
* @param ownerId the ownerId
* @param targetFilename the relative path according to the root of the webapp
@@ -344,10 +344,10 @@ public class WebappStructure
/**
* <p>
- * Called if the registration of the <tt>targetFilename</tt> for the specified <tt>ownerId</tt> has been refused
- * since the path already belongs to the <tt>actualOwnerId</tt>.
+ * Called if the registration of the {@code targetFilename} for the specified {@code ownerId} has been refused
+ * since the path already belongs to the {@code actualOwnerId}.
* </p>
- * This means that the <tt>targetFilename</tt> was known and does not belong to the specified owner.
+ * This means that the {@code targetFilename} was known and does not belong to the specified owner.
*
* @param ownerId the ownerId
* @param targetFilename the relative path according to the root of the webapp
@@ -358,10 +358,10 @@ public class WebappStructure
throws IOException;
/**
- * Called if the <tt>targetFilename</tt> for the specified <tt>ownerId</tt> has been registered successfully by
- * superseding a <tt>deprecatedOwnerId</tt>, that is the previous owner of the file.
+ * Called if the {@code targetFilename} for the specified {@code ownerId} has been registered successfully by
+ * superseding a {@code deprecatedOwnerId}, that is the previous owner of the file.
*
- * This means that the <tt>targetFilename</tt> was known but for another owner. This usually happens after a
+ * This means that the {@code targetFilename} was known but for another owner. This usually happens after a
* project's configuration change. As a result, the file has been registered successfully to the new owner.
*
* @param ownerId the ownerId
@@ -373,10 +373,10 @@ public class WebappStructure
throws IOException;
/**
- * Called if the <tt>targetFilename</tt> for the specified <tt>ownerId</tt> has been registered successfully by
- * superseding a <tt>unknownOwnerId</tt>, that is an owner that does not exist anymore in the current project.
+ * Called if the {@code targetFilename} for the specified {@code ownerId} has been registered successfully by
+ * superseding a {@code unknownOwnerId}, that is an owner that does not exist anymore in the current project.
*
- * This means that the <tt>targetFilename</tt> was known but for an owner that does not exist anymore. Hence the
+ * This means that the {@code targetFilename} was known but for an owner that does not exist anymore. Hence the
* file has been registered successfully to the new owner.
*
* @param ownerId the ownerId
diff --git a/src/test/java/org/apache/maven/plugins/war/AbstractWarExplodedMojoTest.java b/src/test/java/org/apache/maven/plugins/war/AbstractWarExplodedMojoTest.java
index d7c897a..e562398 100644
--- a/src/test/java/org/apache/maven/plugins/war/AbstractWarExplodedMojoTest.java
+++ b/src/test/java/org/apache/maven/plugins/war/AbstractWarExplodedMojoTest.java
@@ -65,7 +65,7 @@ public abstract class AbstractWarExplodedMojoTest
/**
* Configures the exploded mojo for the specified test.
*
- * If the <tt>sourceFiles</tt> parameter is <tt>null</tt>, sample JSPs are created by default.
+ * If the {@code sourceFiles} parameter is {@code null}, sample JSPs are created by default.
*
* @param testId the id of the test
* @param artifactStubs the dependencies (may be null)
diff --git a/src/test/java/org/apache/maven/plugins/war/WarOverlaysTest.java b/src/test/java/org/apache/maven/plugins/war/WarOverlaysTest.java
index 5573574..aca9778 100644
--- a/src/test/java/org/apache/maven/plugins/war/WarOverlaysTest.java
+++ b/src/test/java/org/apache/maven/plugins/war/WarOverlaysTest.java
@@ -447,8 +447,8 @@ public class WarOverlaysTest
/**
* Asserts that the content of an overlayed file is correct.
*
- * Note that the <tt>filePath</tt> is relative to both the webapp directory and the overlayed directory, defined by
- * the <tt>overlayId</tt>.
+ * Note that the {@code filePath} is relative to both the webapp directory and the overlayed directory, defined by
+ * the {@code overlayId}.
*
* @param webAppDirectory the webapp directory
* @param overlayId the id of the overlay
@@ -468,8 +468,8 @@ public class WarOverlaysTest
/**
* Asserts that the content of an overlayed file is correct.
*
- * Note that the <tt>filePath</tt> is relative to both the webapp directory and the overlayed directory, defined by
- * the <tt>overlayId</tt>.
+ * Note that the {@code filePath} is relative to both the webapp directory and the overlayed directory, defined by
+ * the {@code overlayId}.
*
* @param testId te id of the test
* @param webAppDirectory the webapp directory