Oracle javadoc guidelines
diff --git a/src/main/java/org/apache/maven/plugins/shade/DefaultShader.java b/src/main/java/org/apache/maven/plugins/shade/DefaultShader.java
index 5400b42..4360980 100644
--- a/src/main/java/org/apache/maven/plugins/shade/DefaultShader.java
+++ b/src/main/java/org/apache/maven/plugins/shade/DefaultShader.java
@@ -727,7 +727,7 @@
private interface PackageMapper {
/**
- * Map an entity name according to the mapping rules known to this package mapper
+ * Map an entity name according to the mapping rules known to this package mapper.
*
* @param entityName entity name to be mapped
* @param mapPaths map "slashy" names like paths or internal Java class names, e.g. {@code com/acme/Foo}?
@@ -738,7 +738,7 @@
}
/**
- * A package mapper based on a list of {@link Relocator}s
+ * A package mapper based on a list of {@link Relocator}s.
*/
private static class DefaultPackageMapper implements PackageMapper {
private static final Pattern CLASS_PATTERN = Pattern.compile("(\\[*)?L(.+);");
diff --git a/src/main/java/org/apache/maven/plugins/shade/ShadeRequest.java b/src/main/java/org/apache/maven/plugins/shade/ShadeRequest.java
index c778145..97ce6eb 100644
--- a/src/main/java/org/apache/maven/plugins/shade/ShadeRequest.java
+++ b/src/main/java/org/apache/maven/plugins/shade/ShadeRequest.java
@@ -28,6 +28,7 @@
/**
* Parameter object used to pass multitude of args to Shader.shade()
+ *
* @since 2.0
*/
public class ShadeRequest {
@@ -51,7 +52,7 @@
/**
* Which jars to shade.
*
- * @param jars The jars.
+ * @param jars the jars
*/
public void setJars(Set<File> jars) {
this.jars = jars;
@@ -64,7 +65,7 @@
/**
* Output jar.
*
- * @param uberJar The ueberJar file.
+ * @param uberJar the ueberJar file
*/
public void setUberJar(File uberJar) {
this.uberJar = uberJar;
@@ -77,7 +78,7 @@
/**
* The filters.
*
- * @param filters The filters
+ * @param filters the filters
*/
public void setFilters(List<Filter> filters) {
this.filters = filters;
@@ -90,7 +91,7 @@
/**
* The relocators.
*
- * @param relocators The relocators.
+ * @param relocators the relocators
*/
public void setRelocators(List<Relocator> relocators) {
this.relocators = relocators;
@@ -103,7 +104,7 @@
/**
* The transformers.
*
- * @param resourceTransformers List of resourceTransformers.
+ * @param resourceTransformers list of resourceTransformers
*/
public void setResourceTransformers(List<ResourceTransformer> resourceTransformers) {
this.resourceTransformers = resourceTransformers;
@@ -118,7 +119,7 @@
* When false, it will just relocate the java source files to the shaded paths, but will not modify the
* actual contents of the java source files.
*
- * @param shadeSourcesContent {@code true} or {@code false}.
+ * @param shadeSourcesContent {@code true} or {@code false}
*/
public void setShadeSourcesContent(boolean shadeSourcesContent) {
this.shadeSourcesContent = shadeSourcesContent;
diff --git a/src/main/java/org/apache/maven/plugins/shade/Shader.java b/src/main/java/org/apache/maven/plugins/shade/Shader.java
index 35d6fcf..6441c78 100644
--- a/src/main/java/org/apache/maven/plugins/shade/Shader.java
+++ b/src/main/java/org/apache/maven/plugins/shade/Shader.java
@@ -31,7 +31,7 @@
*
* @param shadeRequest holds the many parameters to this method
* @throws IOException for IO errors reading the thing
- * @throws MojoExecutionException for anything else that goes wrong.
+ * @throws MojoExecutionException for anything else that goes wrong
*/
void shade(ShadeRequest shadeRequest) throws IOException, MojoExecutionException;
}
diff --git a/src/main/java/org/apache/maven/plugins/shade/filter/Filter.java b/src/main/java/org/apache/maven/plugins/shade/filter/Filter.java
index e107080..efa45c9 100644
--- a/src/main/java/org/apache/maven/plugins/shade/filter/Filter.java
+++ b/src/main/java/org/apache/maven/plugins/shade/filter/Filter.java
@@ -25,14 +25,14 @@
*/
public interface Filter {
/**
- * @param jar The jar file.
- * @return true if we can filter false otherwise.
+ * @param jar the jar file
+ * @return true if we can filter false otherwise
*/
boolean canFilter(File jar);
/**
- * @param classFile The classFile.
- * @return true if the file has been filtered false otherwise.
+ * @param classFile the classFile
+ * @return true if the file has been filtered false otherwise
*/
boolean isFiltered(String classFile);
diff --git a/src/main/java/org/apache/maven/plugins/shade/filter/MinijarFilter.java b/src/main/java/org/apache/maven/plugins/shade/filter/MinijarFilter.java
index bfc0122..c924229 100644
--- a/src/main/java/org/apache/maven/plugins/shade/filter/MinijarFilter.java
+++ b/src/main/java/org/apache/maven/plugins/shade/filter/MinijarFilter.java
@@ -68,7 +68,7 @@
/**
* @param project {@link MavenProject}
* @param log {@link Log}
- * @throws IOException in case of error.
+ * @throws IOException in case of error
*/
public MinijarFilter(MavenProject project, Log log) throws IOException {
this(project, log, Collections.<SimpleFilter>emptyList(), Collections.<String>emptySet());
@@ -78,7 +78,7 @@
* @param project {@link MavenProject}
* @param log {@link Log}
* @param entryPoints
- * @throws IOException in case of error.
+ * @throws IOException in case of error
*/
public MinijarFilter(MavenProject project, Log log, Set<String> entryPoints) throws IOException {
this(project, log, Collections.<SimpleFilter>emptyList(), entryPoints);
@@ -89,7 +89,7 @@
* @param log {@link Log}
* @param simpleFilters {@link SimpleFilter}
* @param entryPoints
- * @throws IOException in case of errors.
+ * @throws IOException in case of errors
* @since 1.6
*/
public MinijarFilter(MavenProject project, Log log, List<SimpleFilter> simpleFilters, Set<String> entryPoints)
diff --git a/src/main/java/org/apache/maven/plugins/shade/filter/SimpleFilter.java b/src/main/java/org/apache/maven/plugins/shade/filter/SimpleFilter.java
index 3364e97..7c2a1ac 100644
--- a/src/main/java/org/apache/maven/plugins/shade/filter/SimpleFilter.java
+++ b/src/main/java/org/apache/maven/plugins/shade/filter/SimpleFilter.java
@@ -31,7 +31,6 @@
*/
/**
* @author kama
- *
*/
public class SimpleFilter implements Filter {
@@ -44,10 +43,10 @@
private boolean excludeDefaults = true;
/**
- * @deprecated As of release 3.2.2, replaced by {@link #SimpleFilter(Set, ArchiveFilter)}}
- * @param jars set of {@link File}s.
- * @param includes set of includes.
- * @param excludes set of excludes.
+ * @param jars set of {@link File}s
+ * @param includes set of includes
+ * @param excludes set of excludes
+ * @deprecated as of release 3.2.2, replaced by {@link #SimpleFilter(Set, ArchiveFilter)}}
*/
@Deprecated
public SimpleFilter(Set<File> jars, Set<String> includes, Set<String> excludes) {
@@ -55,18 +54,18 @@
}
/**
- * @param jars set of {@link File}s.
- * @param archiveFilter set of {@link ArchiveFilter}s.
+ * @param jars set of {@link File}s
+ * @param archiveFilter set of {@link ArchiveFilter}s
*/
public SimpleFilter(final Set<File> jars, final ArchiveFilter archiveFilter) {
this(jars, archiveFilter.getIncludes(), archiveFilter.getExcludes(), archiveFilter.getExcludeDefaults());
}
/**
- * @param jars set of {@link File}s.
- * @param includes set of includes.
- * @param excludes set of excludes.
- * @param excludeDefaults whether to exclude default includes once includes are provided explicitly.
+ * @param jars set of {@link File}s
+ * @param includes set of includes
+ * @param excludes set of excludes
+ * @param excludeDefaults whether to exclude default includes once includes are provided explicitly
*/
private SimpleFilter(
final Set<File> jars,
@@ -79,13 +78,17 @@
this.excludeDefaults = excludeDefaults;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public boolean canFilter(File jar) {
return jars.contains(jar);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public boolean isFiltered(String classFile) {
String path = normalizePath(classFile);
@@ -94,8 +97,8 @@
}
/**
- * @param classFile The class file.
- * @return true if included false otherwise.
+ * @param classFile the class file
+ * @return true if included false otherwise
*/
public boolean isSpecificallyIncluded(String classFile) {
if (includes == null || includes.isEmpty()) {
@@ -156,7 +159,9 @@
return result;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public void finished() {}
}
diff --git a/src/main/java/org/apache/maven/plugins/shade/mojo/RelativizePath.java b/src/main/java/org/apache/maven/plugins/shade/mojo/RelativizePath.java
index ee3290b..bd81215 100644
--- a/src/main/java/org/apache/maven/plugins/shade/mojo/RelativizePath.java
+++ b/src/main/java/org/apache/maven/plugins/shade/mojo/RelativizePath.java
@@ -23,17 +23,15 @@
import java.util.Collections;
import java.util.List;
-/**
- *
- */
public final class RelativizePath {
private RelativizePath() {
//
}
/**
- * relativize a pathname.
- * @param thing Absolute File of something. (e.g., a parent pom)
+ * Relativize a pathname.
+ *
+ * @param thing absolute File of something. (e.g., a parent pom)
* @param relativeTo base to relativize it do. (e.g., a pom into which a relative pathname to the 'thing' is to be
* installed).
* @return
diff --git a/src/main/java/org/apache/maven/plugins/shade/mojo/ShadeMojo.java b/src/main/java/org/apache/maven/plugins/shade/mojo/ShadeMojo.java
index 312c76a..3a18f4c 100644
--- a/src/main/java/org/apache/maven/plugins/shade/mojo/ShadeMojo.java
+++ b/src/main/java/org/apache/maven/plugins/shade/mojo/ShadeMojo.java
@@ -219,7 +219,7 @@
/**
* Defines whether the shaded artifact should be attached as classifier to the original artifact. If false, the
- * shaded jar will be the main artifact of the project
+ * shaded jar will be the main artifact of the project.
*/
@Parameter
private boolean shadedArtifactAttached;
@@ -283,7 +283,7 @@
private String shadedClassifierName;
/**
- * When true, it will attempt to create a sources jar as well
+ * When true, it will attempt to create a sources jar as well.
*/
@Parameter
private boolean createSourcesJar;
@@ -372,7 +372,7 @@
* When true, the version of each dependency of the reduced pom will be based on the baseVersion of the original
* dependency instead of its resolved version. For example, if the original pom (transitively) depends on
* a:a:2.7-SNAPSHOT, if useBaseVersion is set to false, the reduced pom will depend on a:a:2.7-20130312.222222-12
- * whereas if useBaseVersion is set to true, the reduced pom will depend on a:a:2.7-SNAPSHOT
+ * whereas if useBaseVersion is set to true, the reduced pom will depend on a:a:2.7-SNAPSHOT.
*
* @since 3.0
*/
@@ -387,6 +387,7 @@
/**
* When true, skips the execution of this MOJO.
+ *
* @since 3.3.0
*/
@Parameter(defaultValue = "false")
@@ -445,7 +446,7 @@
private Map<String, Shader> shaders;
/**
- * @throws MojoExecutionException in case of an error.
+ * @throws MojoExecutionException in case of an error
*/
@SuppressWarnings("checkstyle:methodlength")
@Override
diff --git a/src/main/java/org/apache/maven/plugins/shade/pom/Counter.java b/src/main/java/org/apache/maven/plugins/shade/pom/Counter.java
index 80ec570..ec8a673 100644
--- a/src/main/java/org/apache/maven/plugins/shade/pom/Counter.java
+++ b/src/main/java/org/apache/maven/plugins/shade/pom/Counter.java
@@ -28,12 +28,12 @@
// --------------------------/
/**
- * Field currentIndex
+ * Field currentIndex.
*/
private int currentIndex = 0;
/**
- * Field level
+ * Field level.
*/
private int level;
@@ -50,14 +50,15 @@
// -----------/
/**
- * Method getCurrentIndex
+ * Method getCurrentIndex.
*/
public int getCurrentIndex() {
return currentIndex;
} // -- int getCurrentIndex()
/**
- * Method getDepth
+ * Method getDepth.
+ *
* @return {@link #level}
*/
public int getDepth() {
@@ -65,7 +66,7 @@
} // -- int getDepth()
/**
- * Method increaseCount
+ * Method increaseCount.
*/
public void increaseCount() {
currentIndex = currentIndex + 1;
diff --git a/src/main/java/org/apache/maven/plugins/shade/pom/MavenJDOMWriter.java b/src/main/java/org/apache/maven/plugins/shade/pom/MavenJDOMWriter.java
index 5d3db04..6a4243c 100644
--- a/src/main/java/org/apache/maven/plugins/shade/pom/MavenJDOMWriter.java
+++ b/src/main/java/org/apache/maven/plugins/shade/pom/MavenJDOMWriter.java
@@ -83,16 +83,15 @@
/**
* Class MavenJDOMWriter.
- *
*/
public class MavenJDOMWriter {
/**
- * Field factory
+ * Field factory.
*/
private final DefaultJDOMFactory factory;
/**
- * Field lineSeparator
+ * Field lineSeparator.
*/
private final String lineSeparator;
@@ -106,11 +105,11 @@
}
/**
- * Method findAndReplaceProperties
+ * Method findAndReplaceProperties.
*
* @param counter {@link Counter}
* @param props {@link Map}
- * @param name The name.
+ * @param name the name
* @param parent {@link Element}
* @return {@link Element}
*/
@@ -138,13 +137,13 @@
}
/**
- * Method findAndReplaceSimpleElement
+ * Method findAndReplaceSimpleElement.
*
* @param counter {@link Counter}
- * @param defaultValue The default value.
- * @param text The text.
- * @param name The name.
- * @param parent The parent.
+ * @param defaultValue the default value
+ * @param text the text
+ * @param name the name
+ * @param parent the parent
* @return {@link Element}
*/
protected Element findAndReplaceSimpleElement(
@@ -165,13 +164,13 @@
}
/**
- * Method findAndReplaceSimpleLists
+ * Method findAndReplaceSimpleLists.
*
* @param counter {@link Counter}
- * @param childName The childName
- * @param parentName The parentName
- * @param list The list of elements.
- * @param parent The parent.
+ * @param childName the childName
+ * @param parentName the parentName
+ * @param list the list of elements
+ * @param parent the parent
* @return {@link Element}
*/
protected Element findAndReplaceSimpleLists(
@@ -210,12 +209,12 @@
}
/**
- * Method findAndReplaceXpp3DOM
+ * Method findAndReplaceXpp3DOM.
*
* @param counter {@link Counter}
* @param dom {@link Xpp3Dom}
- * @param name The name.
- * @param parent The parent.
+ * @param name the name
+ * @param parent the parent
* @return {@link Element}
*/
protected Element findAndReplaceXpp3DOM(Counter counter, Element parent, String name, Xpp3Dom dom) {
@@ -228,9 +227,9 @@
}
/**
- * Method insertAtPreferredLocation
+ * Method insertAtPreferredLocation.
*
- * @param parent The parent.
+ * @param parent the parent
* @param counter {@link Counter}
* @param child {@link Element}
*/
@@ -272,13 +271,13 @@
}
/**
- * Method iterateContributor
+ * Method iterateContributor.
*
* @param counter {@link Counter}
- * @param childTag The childTag
- * @param parentTag The parentTag
- * @param list The list of elements.
- * @param parent The parent.
+ * @param childTag the childTag
+ * @param parentTag the parentTag
+ * @param list the list of elements
+ * @param parent the parent
*/
protected void iterateContributor(
Counter counter, Element parent, Collection<Contributor> list, String parentTag, String childTag) {
@@ -315,13 +314,13 @@
}
/**
- * Method iterateDependency
+ * Method iterateDependency.
*
* @param counter {@link Counter}
- * @param childTag The childTag
- * @param parentTag The parentTag
- * @param list The list of elements.
- * @param parent The parent.
+ * @param childTag the childTag
+ * @param parentTag the parentTag
+ * @param list the list of elements
+ * @param parent the parent
*/
protected void iterateDependency(
Counter counter, Element parent, Collection<Dependency> list, String parentTag, String childTag) {
@@ -358,13 +357,13 @@
}
/**
- * Method iterateDeveloper
+ * Method iterateDeveloper.
*
* @param counter {@link Counter}
- * @param childTag The childTag
- * @param parentTag The parentTag
- * @param list The list of elements.
- * @param parent The parent.
+ * @param childTag the childTag
+ * @param parentTag the parentTag
+ * @param list the list of elements
+ * @param parent the parent
*/
protected void iterateDeveloper(
Counter counter, Element parent, Collection<Developer> list, String parentTag, String childTag) {
@@ -401,13 +400,13 @@
}
/**
- * Method iterateExclusion
+ * Method iterateExclusion.
*
* @param counter {@link Counter}
- * @param childTag The childTag
- * @param parentTag The parentTag
- * @param list The list of elements.
- * @param parent The parent.
+ * @param childTag the childTag
+ * @param parentTag the parentTag
+ * @param list the list of elements
+ * @param parent the parent
*/
protected void iterateExclusion(
Counter counter, Element parent, Collection<Exclusion> list, String parentTag, String childTag) {
@@ -444,13 +443,13 @@
}
/**
- * Method iterateExtension
+ * Method iterateExtension.
*
* @param counter {@link Counter}
- * @param childTag The childTag
- * @param parentTag The parentTag
- * @param list The list of elements.
- * @param parent The parent.
+ * @param childTag the childTag
+ * @param parentTag the parentTag
+ * @param list the list of elements
+ * @param parent the parent
*/
protected void iterateExtension(
Counter counter, Element parent, Collection<Extension> list, String parentTag, String childTag) {
@@ -487,13 +486,13 @@
}
/**
- * Method iterateLicense
+ * Method iterateLicense.
*
* @param counter {@link Counter}
- * @param childTag The childTag
- * @param parentTag The parentTag
- * @param list The list of elements.
- * @param parent The parent.
+ * @param childTag the childTag
+ * @param parentTag the parentTag
+ * @param list the list of elements
+ * @param parent the parent
*/
protected void iterateLicense(
Counter counter, Element parent, Collection<License> list, String parentTag, String childTag) {
@@ -530,13 +529,13 @@
}
/**
- * Method iterateMailingList
+ * Method iterateMailingList.
*
* @param counter {@link Counter}
- * @param childTag The childTag
- * @param parentTag The parentTag
- * @param list The list of elements.
- * @param parent The parent.
+ * @param childTag the childTag
+ * @param parentTag the parentTag
+ * @param list the list of elements
+ * @param parent the parent
*/
protected void iterateMailingList(
Counter counter, Element parent, Collection<MailingList> list, String parentTag, String childTag) {
@@ -573,13 +572,13 @@
}
/**
- * Method iterateNotifier
+ * Method iterateNotifier.
*
* @param counter {@link Counter}
- * @param childTag The childTag
- * @param parentTag The parentTag
- * @param list The list of elements.
- * @param parent The parent.
+ * @param childTag the childTag
+ * @param parentTag the parentTag
+ * @param list the list of elements
+ * @param parent the parent
*/
protected void iterateNotifier(
Counter counter, Element parent, Collection<Notifier> list, String parentTag, String childTag) {
@@ -616,13 +615,13 @@
}
/**
- * Method iteratePlugin
+ * Method iteratePlugin.
*
* @param counter {@link Counter}
- * @param childTag The childTag
- * @param parentTag The parentTag
- * @param list The list of elements.
- * @param parent The parent.
+ * @param childTag the childTag
+ * @param parentTag the parentTag
+ * @param list the list of elements
+ * @param parent the parent
*/
protected void iteratePlugin(
Counter counter, Element parent, Collection<Plugin> list, String parentTag, String childTag) {
@@ -659,13 +658,13 @@
}
/**
- * Method iteratePluginExecution
+ * Method iteratePluginExecution.
*
* @param counter {@link Counter}
- * @param childTag The childTag
- * @param parentTag The parentTag
- * @param list The list of elements.
- * @param parent The parent.
+ * @param childTag the childTag
+ * @param parentTag the parentTag
+ * @param list the list of elements
+ * @param parent the parent
*/
protected void iteratePluginExecution(
Counter counter, Element parent, Collection<PluginExecution> list, String parentTag, String childTag) {
@@ -702,13 +701,13 @@
}
/**
- * Method iterateProfile
+ * Method iterateProfile.
*
* @param counter {@link Counter}
- * @param childTag The childTag
- * @param parentTag The parentTag
- * @param list The list of elements.
- * @param parent The parent.
+ * @param childTag the childTag
+ * @param parentTag the parentTag
+ * @param list the list of elements
+ * @param parent the parent
*/
protected void iterateProfile(
Counter counter, Element parent, Collection<Profile> list, String parentTag, String childTag) {
@@ -745,13 +744,13 @@
}
/**
- * Method iterateReportPlugin
+ * Method iterateReportPlugin.
*
* @param counter {@link Counter}
- * @param childTag The childTag
- * @param parentTag The parentTag
- * @param list The list of elements.
- * @param parent The parent.
+ * @param childTag the childTag
+ * @param parentTag the parentTag
+ * @param list the list of elements
+ * @param parent the parent
*/
protected void iterateReportPlugin(
Counter counter, Element parent, Collection<ReportPlugin> list, String parentTag, String childTag) {
@@ -788,13 +787,13 @@
}
/**
- * Method iterateReportSet
+ * Method iterateReportSet.
*
* @param counter {@link Counter}
- * @param childTag The childTag
- * @param parentTag The parentTag
- * @param list The list of elements.
- * @param parent The parent.
+ * @param childTag the childTag
+ * @param parentTag the parentTag
+ * @param list the list of elements
+ * @param parent the parent
*/
protected void iterateReportSet(
Counter counter, Element parent, Collection<ReportSet> list, String parentTag, String childTag) {
@@ -831,13 +830,13 @@
}
/**
- * Method iterateRepository
+ * Method iterateRepository.
*
* @param counter {@link Counter}
- * @param childTag The childTag
- * @param parentTag The parentTag
- * @param list The list of elements.
- * @param parent The parent.
+ * @param childTag the childTag
+ * @param parentTag the parentTag
+ * @param list the list of elements
+ * @param parent the parent
*/
protected void iterateRepository(
Counter counter, Element parent, Collection<Repository> list, String parentTag, String childTag) {
@@ -874,13 +873,13 @@
}
/**
- * Method iterateResource
+ * Method iterateResource.
*
* @param counter {@link Counter}
- * @param childTag The childTag
- * @param parentTag The parentTag
- * @param list The list of elements.
- * @param parent The parent.
+ * @param childTag the childTag
+ * @param parentTag the parentTag
+ * @param list the list of elements
+ * @param parent the parent
*/
protected void iterateResource(
Counter counter, Element parent, Collection<Resource> list, String parentTag, String childTag) {
@@ -917,9 +916,9 @@
}
/**
- * Method replaceXpp3DOM
+ * Method replaceXpp3DOM.
*
- * @param parent The parent.
+ * @param parent the parent
* @param counter {@link Counter}
* @param parentDom {@link Element}
*/
@@ -957,12 +956,12 @@
}
/**
- * Method updateActivationFile
+ * Method updateActivationFile.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateActivationFile(ActivationFile value, String xmlTag, Counter counter, Element element) {
boolean shouldExist = value != null;
@@ -975,12 +974,12 @@
}
/**
- * Method updateActivationOS
+ * Method updateActivationOS.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateActivationOS(ActivationOS value, String xmlTag, Counter counter, Element element) {
boolean shouldExist = value != null;
@@ -995,12 +994,12 @@
}
/**
- * Method updateActivationProperty
+ * Method updateActivationProperty.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateActivationProperty(ActivationProperty value, String xmlTag, Counter counter, Element element) {
boolean shouldExist = value != null;
@@ -1013,12 +1012,12 @@
}
/**
- * Method updateBuild
+ * Method updateBuild.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
// CHECKSTYLE_OFF: LineLength
protected void updateBuild(Build value, String xmlTag, Counter counter, Element element) {
@@ -1046,12 +1045,12 @@
// CHECKSTYLE_ON: LineLength
/**
- * Method updateBuildBase
+ * Method updateBuildBase.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateBuildBase(BuildBase value, String xmlTag, Counter counter, Element element) {
boolean shouldExist = value != null;
@@ -1070,12 +1069,12 @@
}
/**
- * Method updateCiManagement
+ * Method updateCiManagement.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateCiManagement(CiManagement value, String xmlTag, Counter counter, Element element) {
boolean shouldExist = value != null;
@@ -1089,12 +1088,12 @@
}
/**
- * Method updateConfigurationContainer
+ * Method updateConfigurationContainer.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateConfigurationContainer(
ConfigurationContainer value, String xmlTag, Counter counter, Element element) {
@@ -1108,12 +1107,12 @@
}
/**
- * Method updateContributor
+ * Method updateContributor.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateContributor(Contributor value, String xmlTag, Counter counter, Element element) {
Element root = element;
@@ -1129,12 +1128,12 @@
}
/**
- * Method updateDependency
+ * Method updateDependency.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateDependency(Dependency value, String xmlTag, Counter counter, Element element) {
Element root = element;
@@ -1152,12 +1151,12 @@
}
/**
- * Method updateDependencyManagement
+ * Method updateDependencyManagement.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateDependencyManagement(
DependencyManagement value, String xmlTag, Counter counter, Element element) {
@@ -1170,12 +1169,12 @@
}
/**
- * Method updateDeploymentRepository
+ * Method updateDeploymentRepository.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateDeploymentRepository(
DeploymentRepository value, String xmlTag, Counter counter, Element element) {
@@ -1197,12 +1196,12 @@
}
/**
- * Method updateDeveloper
+ * Method updateDeveloper.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateDeveloper(Developer value, String xmlTag, Counter counter, Element element) {
Element root = element;
@@ -1219,12 +1218,12 @@
}
/**
- * Method updateDistributionManagement
+ * Method updateDistributionManagement.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateDistributionManagement(
DistributionManagement value, String xmlTag, Counter counter, Element element) {
@@ -1242,12 +1241,12 @@
}
/**
- * Method updateElement
+ * Method updateElement.
*
* @param counter {@link Counter}
- * @param shouldExist should exist.
- * @param name The name.
- * @param parent The parent.
+ * @param shouldExist should exist
+ * @param name the name
+ * @param parent the parent
* @return {@link Element}
*/
protected Element updateElement(Counter counter, Element parent, String name, boolean shouldExist) {
@@ -1277,12 +1276,12 @@
}
/**
- * Method updateExclusion
+ * Method updateExclusion.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateExclusion(Exclusion value, String xmlTag, Counter counter, Element element) {
Element root = element;
@@ -1292,12 +1291,12 @@
}
/**
- * Method updateExtension
+ * Method updateExtension.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateExtension(Extension value, String xmlTag, Counter counter, Element element) {
Element root = element;
@@ -1308,12 +1307,12 @@
}
/**
- * Method updateFileSet
+ * Method updateFileSet.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateFileSet(FileSet value, String xmlTag, Counter counter, Element element) {
boolean shouldExist = value != null;
@@ -1327,12 +1326,12 @@
}
/**
- * Method updateIssueManagement
+ * Method updateIssueManagement.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateIssueManagement(IssueManagement value, String xmlTag, Counter counter, Element element) {
boolean shouldExist = value != null;
@@ -1345,12 +1344,12 @@
}
/**
- * Method updateLicense
+ * Method updateLicense.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateLicense(License value, String xmlTag, Counter counter, Element element) {
Element root = element;
@@ -1362,12 +1361,12 @@
}
/**
- * Method updateMailingList
+ * Method updateMailingList.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateMailingList(MailingList value, String xmlTag, Counter counter, Element element) {
Element root = element;
@@ -1381,12 +1380,12 @@
}
/**
- * Method updateModel
+ * Method updateModel.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateModel(Model value, String xmlTag, Counter counter, Element element) {
Element root = element;
@@ -1423,12 +1422,12 @@
}
/**
- * Method updateModelBase
+ * Method updateModelBase.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
// CHECKSTYLE_OFF: LineLength
protected void updateModelBase(ModelBase value, String xmlTag, Counter counter, Element element) {
@@ -1450,12 +1449,12 @@
// CHECKSTYLE_ON: LineLength
/**
- * Method updateNotifier
+ * Method updateNotifier.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
// CHECKSTYLE_OFF: LineLength
protected void updateNotifier(Notifier value, String xmlTag, Counter counter, Element element) {
@@ -1492,12 +1491,12 @@
// CHECKSTYLE_ON: LineLength
/**
- * Method updateOrganization
+ * Method updateOrganization.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateOrganization(Organization value, String xmlTag, Counter counter, Element element) {
boolean shouldExist = value != null;
@@ -1510,12 +1509,12 @@
}
/**
- * Method updateParent
+ * Method updateParent.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateParent(Parent value, String xmlTag, Counter counter, Element element) {
boolean shouldExist = value != null;
@@ -1530,12 +1529,12 @@
}
/**
- * Method updatePatternSet
+ * Method updatePatternSet.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updatePatternSet(PatternSet value, String xmlTag, Counter counter, Element element) {
boolean shouldExist = value != null;
@@ -1548,12 +1547,12 @@
}
/**
- * Method updatePlugin
+ * Method updatePlugin.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updatePlugin(Plugin value, String xmlTag, Counter counter, Element element) {
Element root = element;
@@ -1574,12 +1573,12 @@
}
/**
- * Method updatePluginConfiguration
+ * Method updatePluginConfiguration.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
// CHECKSTYLE_OFF: LineLength
protected void updatePluginConfiguration(
@@ -1595,12 +1594,12 @@
// CHECKSTYLE_ON: LineLength
/**
- * Method updatePluginContainer
+ * Method updatePluginContainer.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updatePluginContainer(PluginContainer value, String xmlTag, Counter counter, Element element) {
boolean shouldExist = value != null;
@@ -1612,12 +1611,12 @@
}
/**
- * Method updatePluginExecution
+ * Method updatePluginExecution.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updatePluginExecution(PluginExecution value, String xmlTag, Counter counter, Element element) {
Element root = element;
@@ -1630,12 +1629,12 @@
}
/**
- * Method updatePluginManagement
+ * Method updatePluginManagement.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updatePluginManagement(PluginManagement value, String xmlTag, Counter counter, Element element) {
boolean shouldExist = value != null;
@@ -1647,12 +1646,12 @@
}
/**
- * Method updatePrerequisites
+ * Method updatePrerequisites.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updatePrerequisites(Prerequisites value, String xmlTag, Counter counter, Element element) {
boolean shouldExist = value != null;
@@ -1664,12 +1663,12 @@
}
/**
- * Method updateProfile
+ * Method updateProfile.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateProfile(Profile value, String xmlTag, Counter counter, Element element) {
Element root = element;
@@ -1688,12 +1687,12 @@
}
/**
- * Method updateRelocation
+ * Method updateRelocation.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateRelocation(Relocation value, String xmlTag, Counter counter, Element element) {
boolean shouldExist = value != null;
@@ -1708,12 +1707,12 @@
}
/**
- * Method updateReportPlugin
+ * Method updateReportPlugin.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateReportPlugin(ReportPlugin value, String xmlTag, Counter counter, Element element) {
Element root = element;
@@ -1727,12 +1726,12 @@
}
/**
- * Method updateReportSet
+ * Method updateReportSet.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateReportSet(ReportSet value, String xmlTag, Counter counter, Element element) {
Element root = element;
@@ -1744,12 +1743,12 @@
}
/**
- * Method updateReporting
+ * Method updateReporting.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateReporting(Reporting value, String xmlTag, Counter counter, Element element) {
boolean shouldExist = value != null;
@@ -1768,12 +1767,12 @@
}
/**
- * Method updateRepository
+ * Method updateRepository.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateRepository(Repository value, String xmlTag, Counter counter, Element element) {
Element root = element;
@@ -1787,12 +1786,12 @@
}
/**
- * Method updateRepositoryBase
+ * Method updateRepositoryBase.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateRepositoryBase(RepositoryBase value, String xmlTag, Counter counter, Element element) {
boolean shouldExist = value != null;
@@ -1807,12 +1806,12 @@
}
/**
- * Method updateRepositoryPolicy
+ * Method updateRepositoryPolicy.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateRepositoryPolicy(RepositoryPolicy value, String xmlTag, Counter counter, Element element) {
boolean shouldExist = value != null;
@@ -1827,12 +1826,12 @@
}
/**
- * Method updateResource
+ * Method updateResource.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateResource(Resource value, String xmlTag, Counter counter, Element element) {
Element root = element;
@@ -1850,12 +1849,12 @@
}
/**
- * Method updateScm
+ * Method updateScm.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateScm(Scm value, String xmlTag, Counter counter, Element element) {
boolean shouldExist = value != null;
@@ -1874,12 +1873,12 @@
}
/**
- * Method updateSite
+ * Method updateSite.
*
- * @param value The value.
+ * @param value the value
* @param element {@link Element}
* @param counter {@link Counter}
- * @param xmlTag The XMLTag.
+ * @param xmlTag the XMLTag
*/
protected void updateSite(Site value, String xmlTag, Counter counter, Element element) {
boolean shouldExist = value != null;
@@ -1893,13 +1892,13 @@
}
/**
- * Method write
+ * Method write.
*
* @param project {@link Model}
* @param stream {@link OutputStream}
* @param document {@link Document}
+ * @throws IOException in case of an error
* @deprecated
- * @throws IOException in case of an error.
*/
public void write(Model project, Document document, OutputStream stream) throws IOException {
updateModel(project, "project", new Counter(0), document.getRootElement());
@@ -1911,12 +1910,12 @@
}
/**
- * Method write
+ * Method write.
*
* @param project {@link Model}
* @param writer {@link OutputStreamWriter}
* @param document {@link Document}
- * @throws IOException in case of an error.
+ * @throws IOException in case of an error
*/
public void write(Model project, Document document, OutputStreamWriter writer) throws IOException {
Format format = Format.getRawFormat();
@@ -1925,13 +1924,13 @@
}
/**
- * Method write
+ * Method write.
*
* @param project {@link Model}
* @param jdomFormat {@link Format}
* @param writer {@link Writer}
* @param document {@link Document}
- * @throws IOException in case of an error.
+ * @throws IOException in case of an error
*/
public void write(Model project, Document document, Writer writer, Format jdomFormat) throws IOException {
updateModel(project, "project", new Counter(0), document.getRootElement());
diff --git a/src/main/java/org/apache/maven/plugins/shade/relocation/Relocator.java b/src/main/java/org/apache/maven/plugins/shade/relocation/Relocator.java
index d3027c4..aed8c24 100644
--- a/src/main/java/org/apache/maven/plugins/shade/relocation/Relocator.java
+++ b/src/main/java/org/apache/maven/plugins/shade/relocation/Relocator.java
@@ -18,7 +18,9 @@
*/
package org.apache.maven.plugins.shade.relocation;
-/** @author Jason van Zyl */
+/**
+ * @author Jason van Zyl
+ */
public interface Relocator {
String ROLE = Relocator.class.getName();
diff --git a/src/main/java/org/apache/maven/plugins/shade/relocation/SimpleRelocator.java b/src/main/java/org/apache/maven/plugins/shade/relocation/SimpleRelocator.java
index 9d49f77..bb055cf 100644
--- a/src/main/java/org/apache/maven/plugins/shade/relocation/SimpleRelocator.java
+++ b/src/main/java/org/apache/maven/plugins/shade/relocation/SimpleRelocator.java
@@ -32,7 +32,7 @@
*/
public class SimpleRelocator implements Relocator {
/**
- * Match dot, slash or space at end of string
+ * Match dot, slash or space at end of string.
*/
private static final Pattern RX_ENDS_WITH_DOT_SLASH_SPACE = Pattern.compile("[./ ]$");
@@ -43,7 +43,7 @@
* <li>(opening curly brace / opening parenthesis / comma / equals / semicolon) + space</li>
* <li>(closing curly brace / closing multi-line comment) + space</li>
* </ul>
- * at end of string
+ * at end of string.
*/
private static final Pattern RX_ENDS_WITH_JAVA_KEYWORD = Pattern.compile(
"\\b(import|package|public|protected|private|static|final|synchronized|abstract|volatile|extends|implements|throws) $"
diff --git a/src/main/java/org/apache/maven/plugins/shade/resource/ApacheLicenseResourceTransformer.java b/src/main/java/org/apache/maven/plugins/shade/resource/ApacheLicenseResourceTransformer.java
index f319717..1be6f91 100644
--- a/src/main/java/org/apache/maven/plugins/shade/resource/ApacheLicenseResourceTransformer.java
+++ b/src/main/java/org/apache/maven/plugins/shade/resource/ApacheLicenseResourceTransformer.java
@@ -26,7 +26,7 @@
import org.apache.maven.plugins.shade.relocation.Relocator;
/**
- * Prevents duplicate copies of the license
+ * Prevents duplicate copies of the license.
*/
public class ApacheLicenseResourceTransformer extends AbstractCompatibilityTransformer {
private static final String LICENSE_PATH = "META-INF/LICENSE";
diff --git a/src/main/java/org/apache/maven/plugins/shade/resource/GroovyResourceTransformer.java b/src/main/java/org/apache/maven/plugins/shade/resource/GroovyResourceTransformer.java
index b015574..d053b72 100644
--- a/src/main/java/org/apache/maven/plugins/shade/resource/GroovyResourceTransformer.java
+++ b/src/main/java/org/apache/maven/plugins/shade/resource/GroovyResourceTransformer.java
@@ -32,7 +32,7 @@
import org.apache.maven.plugins.shade.relocation.Relocator;
/**
- * Aggregate Apache Groovy extension modules descriptors
+ * Aggregate Apache Groovy extension modules descriptors.
*/
public class GroovyResourceTransformer extends AbstractCompatibilityTransformer {
diff --git a/src/main/java/org/apache/maven/plugins/shade/resource/ManifestResourceTransformer.java b/src/main/java/org/apache/maven/plugins/shade/resource/ManifestResourceTransformer.java
index 9ef598b..a2fa278 100644
--- a/src/main/java/org/apache/maven/plugins/shade/resource/ManifestResourceTransformer.java
+++ b/src/main/java/org/apache/maven/plugins/shade/resource/ManifestResourceTransformer.java
@@ -164,7 +164,7 @@
/**
* The shades to apply this transformer to or no shades if no filter is applied.
*
- * @param shade {@code null}, {@code jar}, {@code test-jar}, {@code sources-jar} or {@code test-sources-jar}.
+ * @param shade {@code null}, {@code jar}, {@code test-jar}, {@code sources-jar} or {@code test-sources-jar}
*/
public void setForShade(String shade) {
this.shade = shade;
diff --git a/src/main/java/org/apache/maven/plugins/shade/resource/ReproducibleResourceTransformer.java b/src/main/java/org/apache/maven/plugins/shade/resource/ReproducibleResourceTransformer.java
index 96e3fe5..efe1a41 100644
--- a/src/main/java/org/apache/maven/plugins/shade/resource/ReproducibleResourceTransformer.java
+++ b/src/main/java/org/apache/maven/plugins/shade/resource/ReproducibleResourceTransformer.java
@@ -34,12 +34,13 @@
*/
public interface ReproducibleResourceTransformer extends ResourceTransformer {
/**
- * Transform an individual resource
- * @param resource The resource name
- * @param is An input stream for the resource, the implementation should *not* close this stream
- * @param relocators A list of relocators
+ * Transform an individual resource.
+ *
+ * @param resource the resource name
+ * @param is an input stream for the resource, the implementation should *not* close this stream
+ * @param relocators a list of relocators
* @param time the time of the resource to process
- * @throws IOException When the IO blows up
+ * @throws IOException when the IO blows up
*/
void processResource(String resource, InputStream is, List<Relocator> relocators, long time) throws IOException;
}
diff --git a/src/main/java/org/apache/maven/plugins/shade/resource/ResourceBundleAppendingTransformer.java b/src/main/java/org/apache/maven/plugins/shade/resource/ResourceBundleAppendingTransformer.java
index 4d198b5..9cc7720 100644
--- a/src/main/java/org/apache/maven/plugins/shade/resource/ResourceBundleAppendingTransformer.java
+++ b/src/main/java/org/apache/maven/plugins/shade/resource/ResourceBundleAppendingTransformer.java
@@ -32,7 +32,7 @@
import org.codehaus.plexus.util.IOUtil;
/**
- * An appending transformer for resource bundles
+ * An appending transformer for resource bundles.
*
* @author Robert Scholte
* @since 3.0.0
@@ -45,8 +45,9 @@
private long time = Long.MIN_VALUE;
/**
- * the base name of the resource bundle, a fully qualified class name
- * @param basename The basename.
+ * The base name of the resource bundle, a fully qualified class name.
+ *
+ * @param basename the basename
*/
public void setBasename(String basename) {
resourceBundlePattern = Pattern.compile(basename + "(_[a-zA-Z]+){0,3}\\.properties");
diff --git a/src/main/java/org/apache/maven/plugins/shade/resource/ResourceTransformer.java b/src/main/java/org/apache/maven/plugins/shade/resource/ResourceTransformer.java
index 6452091..3347680 100644
--- a/src/main/java/org/apache/maven/plugins/shade/resource/ResourceTransformer.java
+++ b/src/main/java/org/apache/maven/plugins/shade/resource/ResourceTransformer.java
@@ -25,16 +25,19 @@
import org.apache.maven.plugins.shade.relocation.Relocator;
-/** @author Jason van Zyl */
+/**
+ * @author Jason van Zyl
+ */
public interface ResourceTransformer {
boolean canTransformResource(String resource);
/**
- * Transform an individual resource
- * @param resource The resource name
- * @param is An input stream for the resource, the implementation should *not* close this stream
- * @param relocators A list of relocators
- * @throws IOException When the IO blows up
+ * Transform an individual resource.
+ *
+ * @param resource the resource name
+ * @param is an input stream for the resource, the implementation should *not* close this stream
+ * @param relocators a list of relocators
+ * @throws IOException when the IO blows up
* @deprecated prefer ReproducibleResourceTransformer
*/
void processResource(String resource, InputStream is, List<Relocator> relocators) throws IOException;
