You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2023/10/31 10:57:54 UTC
(commons-weaver) branch master updated: Normalize getter Javadoc
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-weaver.git
The following commit(s) were added to refs/heads/master by this push:
new 56cd556 Normalize getter Javadoc
56cd556 is described below
commit 56cd556f6b73a01ac0ad9d0bcfe50ca8c02e0e7a
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Tue Oct 31 06:57:50 2023 -0400
Normalize getter Javadoc
---
.../org/apache/commons/weaver/ant/AbstractWeaverTask.java | 2 +-
.../java/org/apache/commons/weaver/ant/WeaverSettings.java | 6 +++---
.../org/apache/commons/weaver/maven/AbstractCWMojo.java | 2 +-
.../org/apache/commons/weaver/privilizer/AccessLevel.java | 4 ++--
.../java/org/apache/commons/weaver/privilizer/Policy.java | 2 +-
.../src/main/java/org/apache/commons/weaver/Finder.java | 2 +-
.../org/apache/commons/weaver/model/NestedWeavable.java | 2 +-
.../java/org/apache/commons/weaver/model/ScanRequest.java | 4 ++--
.../java/org/apache/commons/weaver/model/Weavable.java | 6 +++---
.../org/apache/commons/weaver/model/WeavableClass.java | 12 ++++++------
.../apache/commons/weaver/model/WeavableExecutable.java | 6 +++---
.../org/apache/commons/weaver/model/WeavablePackage.java | 4 ++--
.../org/apache/commons/weaver/model/WeaveEnvironment.java | 14 +++++++-------
.../org/apache/commons/weaver/model/WeaveInterest.java | 2 +-
14 files changed, 34 insertions(+), 34 deletions(-)
diff --git a/ant/src/main/java/org/apache/commons/weaver/ant/AbstractWeaverTask.java b/ant/src/main/java/org/apache/commons/weaver/ant/AbstractWeaverTask.java
index 101a2d2..5a0dc9f 100644
--- a/ant/src/main/java/org/apache/commons/weaver/ant/AbstractWeaverTask.java
+++ b/ant/src/main/java/org/apache/commons/weaver/ant/AbstractWeaverTask.java
@@ -49,7 +49,7 @@ public abstract class AbstractWeaverTask extends Task {
}
/**
- * Get the {@link WeaverSettings} in use.
+ * Gets the {@link WeaverSettings} in use.
* @return {@link WeaverSettings}
*/
public WeaverSettings getSettings() {
diff --git a/ant/src/main/java/org/apache/commons/weaver/ant/WeaverSettings.java b/ant/src/main/java/org/apache/commons/weaver/ant/WeaverSettings.java
index 39d9ed1..61e630a 100644
--- a/ant/src/main/java/org/apache/commons/weaver/ant/WeaverSettings.java
+++ b/ant/src/main/java/org/apache/commons/weaver/ant/WeaverSettings.java
@@ -63,7 +63,7 @@ public class WeaverSettings extends DataType {
}
/**
- * Get the {@code target} directory.
+ * Gets the {@code target} directory.
* @return {@link File}
*/
public File getTarget() {
@@ -85,7 +85,7 @@ public class WeaverSettings extends DataType {
}
/**
- * Get the {@code classpathref}.
+ * Gets the {@code classpathref}.
* @return {@link String}
*/
public String getClasspathref() {
@@ -124,7 +124,7 @@ public class WeaverSettings extends DataType {
}
/**
- * Get the {@code classpath}.
+ * Gets the {@code classpath}.
* @return {@link Path}
*/
public Path getClasspath() {
diff --git a/maven-plugin/src/main/java/org/apache/commons/weaver/maven/AbstractCWMojo.java b/maven-plugin/src/main/java/org/apache/commons/weaver/maven/AbstractCWMojo.java
index a7131a7..a349a57 100755
--- a/maven-plugin/src/main/java/org/apache/commons/weaver/maven/AbstractCWMojo.java
+++ b/maven-plugin/src/main/java/org/apache/commons/weaver/maven/AbstractCWMojo.java
@@ -81,7 +81,7 @@ abstract class AbstractCWMojo extends AbstractMojo {
protected RepositorySystemSession repositorySystemSession;
/**
- * Get the target directory for this prepare mojo.
+ * Gets the target directory for this prepare mojo.
*
* @return {@link File}
*/
diff --git a/modules/privilizer/weaver/src/main/java/org/apache/commons/weaver/privilizer/AccessLevel.java b/modules/privilizer/weaver/src/main/java/org/apache/commons/weaver/privilizer/AccessLevel.java
index 25596ef..0de3b9f 100644
--- a/modules/privilizer/weaver/src/main/java/org/apache/commons/weaver/privilizer/AccessLevel.java
+++ b/modules/privilizer/weaver/src/main/java/org/apache/commons/weaver/privilizer/AccessLevel.java
@@ -57,7 +57,7 @@ public enum AccessLevel {
}
/**
- * Get the {@link AccessLevel} specified by a Java modifier.
+ * Gets the {@link AccessLevel} specified by a Java modifier.
* @param mod from which to extract
* @return {@link AccessLevel}
* @throws IllegalArgumentException if multiple access modifiers specified
@@ -103,7 +103,7 @@ public enum AccessLevel {
}
/**
- * Get the {@link AccessLevel} value that should be used as a default.
+ * Gets the {@link AccessLevel} value that should be used as a default.
* This is <em>not</em> "default"/{@code package} access, but rather the default
* value that should be used for privilizer weaving.
* @return {@link AccessLevel#PRIVATE}
diff --git a/modules/privilizer/weaver/src/main/java/org/apache/commons/weaver/privilizer/Policy.java b/modules/privilizer/weaver/src/main/java/org/apache/commons/weaver/privilizer/Policy.java
index 762e1d9..1d733fa 100644
--- a/modules/privilizer/weaver/src/main/java/org/apache/commons/weaver/privilizer/Policy.java
+++ b/modules/privilizer/weaver/src/main/java/org/apache/commons/weaver/privilizer/Policy.java
@@ -49,7 +49,7 @@ public enum Policy {
ALWAYS;
/**
- * Get the {@link Policy} value that should be used as a default.
+ * Gets the {@link Policy} value that should be used as a default.
* @return {@link Policy#DYNAMIC}
*/
public static Policy defaultValue() {
diff --git a/processor/src/main/java/org/apache/commons/weaver/Finder.java b/processor/src/main/java/org/apache/commons/weaver/Finder.java
index 77415d0..17a2a8a 100644
--- a/processor/src/main/java/org/apache/commons/weaver/Finder.java
+++ b/processor/src/main/java/org/apache/commons/weaver/Finder.java
@@ -376,7 +376,7 @@ class Finder extends AnnotationFinder implements Scanner {
}
/**
- * Get the list of objects representing all scanned classes.
+ * Gets the list of objects representing all scanned classes.
* @since 1.3
* @return {@link List} of {@link Annotated}{@code <Class<?>>}
*/
diff --git a/processor/src/main/java/org/apache/commons/weaver/model/NestedWeavable.java b/processor/src/main/java/org/apache/commons/weaver/model/NestedWeavable.java
index 7a0ef76..f67e754 100644
--- a/processor/src/main/java/org/apache/commons/weaver/model/NestedWeavable.java
+++ b/processor/src/main/java/org/apache/commons/weaver/model/NestedWeavable.java
@@ -45,7 +45,7 @@ public abstract class NestedWeavable
}
/**
- * Get the parent.
+ * Gets the parent.
* @return {@code PARENT}
*/
public PARENT getParent() {
diff --git a/processor/src/main/java/org/apache/commons/weaver/model/ScanRequest.java b/processor/src/main/java/org/apache/commons/weaver/model/ScanRequest.java
index 4894174..a655ff6 100644
--- a/processor/src/main/java/org/apache/commons/weaver/model/ScanRequest.java
+++ b/processor/src/main/java/org/apache/commons/weaver/model/ScanRequest.java
@@ -61,7 +61,7 @@ public class ScanRequest {
}
/**
- * Get registered {@link WeaveInterest}s.
+ * Gets registered {@link WeaveInterest}s.
* @return {@link Iterable}
*/
public Iterable<WeaveInterest> getInterests() {
@@ -69,7 +69,7 @@ public class ScanRequest {
}
/**
- * Get registered {@link Class}es whose subtypes will be returned.
+ * Gets registered {@link Class}es whose subtypes will be returned.
* @return {@link Set}
*/
public Set<Class<?>> getSupertypes() {
diff --git a/processor/src/main/java/org/apache/commons/weaver/model/Weavable.java b/processor/src/main/java/org/apache/commons/weaver/model/Weavable.java
index 8e06ebc..4544878 100644
--- a/processor/src/main/java/org/apache/commons/weaver/model/Weavable.java
+++ b/processor/src/main/java/org/apache/commons/weaver/model/Weavable.java
@@ -88,7 +88,7 @@ public abstract class Weavable<SELF extends Weavable<SELF, TARGET>, TARGET> impl
}
/**
- * Get the target of this {@link Weavable}.
+ * Gets the target of this {@link Weavable}.
* @return {@code TARGET}
*/
public TARGET getTarget() {
@@ -96,7 +96,7 @@ public abstract class Weavable<SELF extends Weavable<SELF, TARGET>, TARGET> impl
}
/**
- * Get all {@link Annotation}s associated with this element.
+ * Gets all {@link Annotation}s associated with this element.
* @return {@link Annotation}[]
*/
@Override
@@ -108,7 +108,7 @@ public abstract class Weavable<SELF extends Weavable<SELF, TARGET>, TARGET> impl
}
/**
- * Get any instance of {@code annotationClass} attached to {@link #getTarget()}.
+ * Gets any instance of {@code annotationClass} attached to {@link #getTarget()}.
* @param annotationClass {@link Class} annotation type
* @param <T> annotation type
* @return {@code T} instance if available, else {@code null}
diff --git a/processor/src/main/java/org/apache/commons/weaver/model/WeavableClass.java b/processor/src/main/java/org/apache/commons/weaver/model/WeavableClass.java
index 308b23d..79ab288 100644
--- a/processor/src/main/java/org/apache/commons/weaver/model/WeavableClass.java
+++ b/processor/src/main/java/org/apache/commons/weaver/model/WeavableClass.java
@@ -57,7 +57,7 @@ public class WeavableClass<T> extends NestedWeavable<WeavableClass<T>, Class<T>,
}
/**
- * Get a {@link WeavableField} representing {@code fld}.
+ * Gets a {@link WeavableField} representing {@code fld}.
* @param fld to wrap
* @return {@link WeavableField}
*/
@@ -66,7 +66,7 @@ public class WeavableClass<T> extends NestedWeavable<WeavableClass<T>, Class<T>,
}
/**
- * Get a {@link WeavableMethod} representing {@code mt}.
+ * Gets a {@link WeavableMethod} representing {@code mt}.
* @param methd to wrap
* @return {@link WeavableMethod}
*/
@@ -75,7 +75,7 @@ public class WeavableClass<T> extends NestedWeavable<WeavableClass<T>, Class<T>,
}
/**
- * Get a {@link WeavableConstructor} representing {@code ctor}.
+ * Gets a {@link WeavableConstructor} representing {@code ctor}.
* @param ctor to wrap
* @return {@link WeavableConstructor}
*/
@@ -84,7 +84,7 @@ public class WeavableClass<T> extends NestedWeavable<WeavableClass<T>, Class<T>,
}
/**
- * Get {@link WeavableField}s of this {@link WeavableClass}.
+ * Gets {@link WeavableField}s of this {@link WeavableClass}.
* @return {@link Iterable}
*/
public Iterable<WeavableField<T>> getFields() {
@@ -92,7 +92,7 @@ public class WeavableClass<T> extends NestedWeavable<WeavableClass<T>, Class<T>,
}
/**
- * Get {@link WeavableConstructor}s of this {@link WeavableClass}.
+ * Gets {@link WeavableConstructor}s of this {@link WeavableClass}.
* @return {@link Iterable}
*/
public Iterable<WeavableConstructor<T>> getConstructors() {
@@ -100,7 +100,7 @@ public class WeavableClass<T> extends NestedWeavable<WeavableClass<T>, Class<T>,
}
/**
- * Get {@link WeavableMethod}s of this {@link WeavableClass}.
+ * Gets {@link WeavableMethod}s of this {@link WeavableClass}.
* @return {@link Iterable}
*/
public Iterable<WeavableMethod<T>> getMethods() {
diff --git a/processor/src/main/java/org/apache/commons/weaver/model/WeavableExecutable.java b/processor/src/main/java/org/apache/commons/weaver/model/WeavableExecutable.java
index d7df972..30127e9 100644
--- a/processor/src/main/java/org/apache/commons/weaver/model/WeavableExecutable.java
+++ b/processor/src/main/java/org/apache/commons/weaver/model/WeavableExecutable.java
@@ -65,7 +65,7 @@ public abstract class WeavableExecutable
protected abstract P createParameter(int index);
/**
- * Get the parameter types of {@link #getTarget()}.
+ * Gets the parameter types of {@link #getTarget()}.
* @return {@link Class}[]
*/
protected abstract Class<?>[] getParameterTypes();
@@ -79,7 +79,7 @@ public abstract class WeavableExecutable
}
/**
- * Get the parameter at the specified index.
+ * Gets the parameter at the specified index.
* @param index {@code int}
* @return {@code P}
*/
@@ -88,7 +88,7 @@ public abstract class WeavableExecutable
}
/**
- * Get the parameters declared by this {@link WeavableExecutable}.
+ * Gets the parameters declared by this {@link WeavableExecutable}.
* @return {@link Iterable} of {@code P}
*/
public Iterable<P> getParameters() {
diff --git a/processor/src/main/java/org/apache/commons/weaver/model/WeavablePackage.java b/processor/src/main/java/org/apache/commons/weaver/model/WeavablePackage.java
index fe324f4..916c4d7 100644
--- a/processor/src/main/java/org/apache/commons/weaver/model/WeavablePackage.java
+++ b/processor/src/main/java/org/apache/commons/weaver/model/WeavablePackage.java
@@ -41,7 +41,7 @@ public class WeavablePackage extends Weavable<WeavablePackage, Package> {
}
/**
- * Get a {@link WeavableClass} representing {@code cls}.
+ * Gets a {@link WeavableClass} representing {@code cls}.
* @param cls to wrap
* @param <T> generic type of {@code cls}
* @return {@link WeavableClass}
@@ -52,7 +52,7 @@ public class WeavablePackage extends Weavable<WeavablePackage, Package> {
}
/**
- * Get enclosed {@link WeavableClass}es.
+ * Gets enclosed {@link WeavableClass}es.
* @return {@link Iterable}
*/
public Iterable<WeavableClass<?>> getClasses() {
diff --git a/processor/src/main/java/org/apache/commons/weaver/model/WeaveEnvironment.java b/processor/src/main/java/org/apache/commons/weaver/model/WeaveEnvironment.java
index 59e8194..fa8f566 100644
--- a/processor/src/main/java/org/apache/commons/weaver/model/WeaveEnvironment.java
+++ b/processor/src/main/java/org/apache/commons/weaver/model/WeaveEnvironment.java
@@ -44,7 +44,7 @@ public abstract class WeaveEnvironment {
}
/**
- * Get the content type, always "application/octet-stream".
+ * Gets the content type, always "application/octet-stream".
* @return {@link String}
*/
public String getContentType() {
@@ -52,7 +52,7 @@ public abstract class WeaveEnvironment {
}
/**
- * Get an {@link InputStream} for reading this {@link Resource}.
+ * Gets an {@link InputStream} for reading this {@link Resource}.
* @return {@link InputStream}
* @throws IOException if unable to read
*/
@@ -61,7 +61,7 @@ public abstract class WeaveEnvironment {
}
/**
- * Get the name of this {@link Resource}.
+ * Gets the name of this {@link Resource}.
* @return {@link String}
*/
public String getName() {
@@ -69,7 +69,7 @@ public abstract class WeaveEnvironment {
}
/**
- * Get an {@link OutputStream} for writing to this {@link Resource}.
+ * Gets an {@link OutputStream} for writing to this {@link Resource}.
* @return {@link OutputStream}
* @throws IOException if unable to write
*/
@@ -172,7 +172,7 @@ public abstract class WeaveEnvironment {
}
/**
- * Get a {@link Resource} representing {@code cls}.
+ * Gets a {@link Resource} representing {@code cls}.
* @param cls type
* @return {@link Resource}
*/
@@ -181,7 +181,7 @@ public abstract class WeaveEnvironment {
}
/**
- * Get a {@link Resource} for the specified class.
+ * Gets a {@link Resource} for the specified class.
* @param className of type
* @return {@link Resource}
*/
@@ -190,7 +190,7 @@ public abstract class WeaveEnvironment {
}
/**
- * Get a {@link Resource} for the specified resource.
+ * Gets a {@link Resource} for the specified resource.
* @param name of resource
* @return {@link Resource}
*/
diff --git a/processor/src/main/java/org/apache/commons/weaver/model/WeaveInterest.java b/processor/src/main/java/org/apache/commons/weaver/model/WeaveInterest.java
index e6a2327..412d603 100644
--- a/processor/src/main/java/org/apache/commons/weaver/model/WeaveInterest.java
+++ b/processor/src/main/java/org/apache/commons/weaver/model/WeaveInterest.java
@@ -28,7 +28,7 @@ import java.lang.annotation.ElementType;
public final class WeaveInterest {
/**
- * Get a {@link WeaveInterest}.
+ * Gets a {@link WeaveInterest}.
* @param annotationType observed annotation type
* @param target attached element type
* @return {@link WeaveInterest}