Skip to content

Commit

Permalink
Fix typos in Javadoc, reference docs, and code
Browse files Browse the repository at this point in the history
Closes gh-28822
  • Loading branch information
marcwrobel authored and sbrannen committed Sep 14, 2022
1 parent 50dff77 commit 92a231c
Show file tree
Hide file tree
Showing 18 changed files with 23 additions and 23 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ public abstract class AbstractAutoProxyCreator extends ProxyProcessorSupport
/**
* Set whether the proxy should be frozen, preventing advice
* from being added to it once it is created.
* <p>Overridden from the super class to prevent the proxy configuration
* <p>Overridden from the superclass to prevent the proxy configuration
* from being frozen before the proxy is created.
*/
@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public abstract aspect AbstractDependencyInjectionAspect {
mostSpecificSubTypeConstruction() && !preConstructionConfiguration();

/**
* Select least specific super type that is marked for DI
* Select least specific supertype that is marked for DI
* (so that injection occurs only once with pre-construction injection).
*/
public abstract pointcut leastSpecificSuperTypeConstruction();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ private String getQualifiedName(Element element) {
}

/**
* Return the super class of the specified {@link Element} or null if this
* Return the superclass of the specified {@link Element} or null if this
* {@code element} represents {@link Object}.
*/
public Element getSuperClass(Element element) {
Expand All @@ -100,7 +100,7 @@ public Element getSuperClass(Element element) {
public List<Element> getDirectInterfaces(Element element) {
List<? extends TypeMirror> superTypes = this.types.directSupertypes(element.asType());
List<Element> directInterfaces = new ArrayList<>();
if (superTypes.size() > 1) { // index 0 is the super class
if (superTypes.size() > 1) { // index 0 is the superclass
for (int i = 1; i < superTypes.size(); i++) {
Element e = this.types.asElement(superTypes.get(i));
if (e != null) {
Expand Down
8 changes: 4 additions & 4 deletions spring-core/src/main/java/org/springframework/asm/Type.java
Original file line number Diff line number Diff line change
Expand Up @@ -708,8 +708,8 @@ public int getSize() {
*
* @return the size of the arguments of the method (plus one for the implicit this argument),
* argumentsSize, and the size of its return value, returnSize, packed into a single int i =
* {@code (argumentsSize &lt;&lt; 2) | returnSize} (argumentsSize is therefore equal to {@code
* i &gt;&gt; 2}, and returnSize to {@code i &amp; 0x03}).
* {@code (argumentsSize << 2) | returnSize} (argumentsSize is therefore equal to {@code
* i >> 2}, and returnSize to {@code i & 0x03}).
*/
public int getArgumentsAndReturnSizes() {
return getArgumentsAndReturnSizes(getDescriptor());
Expand All @@ -721,8 +721,8 @@ public int getArgumentsAndReturnSizes() {
* @param methodDescriptor a method descriptor.
* @return the size of the arguments of the method (plus one for the implicit this argument),
* argumentsSize, and the size of its return value, returnSize, packed into a single int i =
* {@code (argumentsSize &lt;&lt; 2) | returnSize} (argumentsSize is therefore equal to {@code
* i &gt;&gt; 2}, and returnSize to {@code i &amp; 0x03}).
* {@code (argumentsSize << 2) | returnSize} (argumentsSize is therefore equal to {@code
* i >> 2}, and returnSize to {@code i & 0x03}).
*/
public static int getArgumentsAndReturnSizes(final String methodDescriptor) {
int argumentsSize = 1;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ public boolean match(MetadataReader metadataReader, MetadataReaderFactory metada
}
catch (IOException ex) {
if (logger.isDebugEnabled()) {
logger.debug("Could not read super class [" + metadata.getSuperClassName() +
logger.debug("Could not read superclass [" + metadata.getSuperClassName() +
"] of type-filtered class [" + metadata.getClassName() + "]");
}
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2020 the original author or authors.
* Copyright 2002-2022 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
import org.springframework.lang.Nullable;

/**
* Super class for exceptions that can occur whilst processing expressions.
* Superclass for exceptions that can occur whilst processing expressions.
*
* @author Andy Clement
* @author Phillip Webb
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
import org.springframework.util.Assert;

/**
* Convenient super class for JDBC-based data access objects.
* Convenient superclass for JDBC-based data access objects.
*
* <p>Requires a {@link javax.sql.DataSource} to be set, providing a
* {@link org.springframework.jdbc.core.JdbcTemplate} based on it to
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
import org.springframework.lang.Nullable;

/**
* Convenient super class for application classes that need JMS access.
* Convenient superclass for application classes that need JMS access.
*
* <p>Requires a ConnectionFactory or a JmsTemplate instance to be set.
* It will create its own JmsTemplate if a ConnectionFactory is passed in.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ public final boolean isRunning() {
* may still independently alternate between being on and off depending on the
* concrete subclass implementation.
* <p>Application components may implement
* {@code org.springframework.context.ApplicationListener&lt;BrokerAvailabilityEvent&gt;}
* {@code org.springframework.context.ApplicationListener<BrokerAvailabilityEvent>}
* to receive notifications when broker becomes available and unavailable.
*/
public boolean isBrokerAvailable() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
import org.springframework.util.Assert;

/**
* Convenient super class for Hibernate-based data access objects.
* Convenient superclass for Hibernate-based data access objects.
*
* <p>Requires a {@link SessionFactory} to be set, providing a
* {@link org.springframework.orm.hibernate5.HibernateTemplate} based on it to
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
* {@link TransactionAttributeEditor} in this package.
*
* <p>Strings are in property syntax, with the form:<br>
* {@code FQCN.methodName=&lt;transaction attribute string&gt;}
* {@code FQCN.methodName=<transaction attribute string>}
*
* <p>For example:<br>
* {@code com.mycompany.mycode.MyClass.myMethod=PROPAGATION_MANDATORY,ISOLATION_DEFAULT}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
import org.springframework.web.client.RestTemplate;

/**
* Convenient super class for application classes that need REST access.
* Convenient superclass for application classes that need REST access.
*
* <p>Requires a {@link ClientHttpRequestFactory} or a {@link RestTemplate} instance to be set.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
* this class which {@link RequestAttributes} scope to read attributes from.
*
* <p>Subclasses may wish to override the {@link #get} and {@link #remove}
* methods to add synchronization around the call back into this super class.
* methods to add synchronization around the call back into this superclass.
*
* @author Rod Johnson
* @author Juergen Hoeller
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ public static HandlerTypePredicate forBasePackageClass(Class<?>... packageClasse

/**
* Match handlers that are assignable to a given type.
* @param types one or more handler super types
* @param types one or more handler supertypes
*/
public static HandlerTypePredicate forAssignableType(Class<?>... types) {
return new Builder().assignableType(types).build();
Expand Down Expand Up @@ -187,7 +187,7 @@ private void addBasePackage(String basePackage) {

/**
* Match handlers that are assignable to a given type.
* @param types one or more handler super types
* @param types one or more handler supertypes
*/
public Builder assignableType(Class<?>... types) {
this.assignableTypes.addAll(Arrays.asList(types));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@
*/
public class ResponseStatusExceptionHandlerTests extends AbstractResponseStatusExceptionHandlerTests {

// all tests in super class
// all tests in superclass

}
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
import org.springframework.util.StringUtils;

/**
* Convenient super class for many html tags that render content using the databinding
* Convenient superclass for many html tags that render content using the databinding
* features of the {@link AbstractHtmlElementTag AbstractHtmlElementTag}. The only thing
* sub-tags need to do is override {@link #renderDefaultContent(TagWriter)}.
*
Expand Down
2 changes: 1 addition & 1 deletion src/docs/asciidoc/testing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1871,7 +1871,7 @@ Spring test configuration annotations are processed within enclosing class hiera
for inner test classes.

If `@NestedTestConfiguration` is not present or meta-present on a test class, in its
super type hierarchy, or in its enclosing class hierarchy, the default _enclosing
supertype hierarchy, or in its enclosing class hierarchy, the default _enclosing
configuration inheritance mode_ will be used. See the tip below for details on how to
change the default mode.

Expand Down

0 comments on commit 92a231c

Please sign in to comment.