Browse Source

Polish Javadoc

This commit also reverts the change to ASM's SymbolTable class.

See gh-34679
pull/34732/head
Sam Brannen 9 months ago
parent
commit
9fd1d0c6a3
  1. 2
      spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/ReflectiveAspectJAdvisorFactory.java
  2. 2
      spring-core/src/main/java/org/springframework/asm/SymbolTable.java
  3. 10
      spring-core/src/main/java/org/springframework/util/ObjectUtils.java
  4. 2
      spring-jms/src/main/java/org/springframework/jms/connection/UserCredentialsConnectionFactoryAdapter.java
  5. 2
      spring-jms/src/main/java/org/springframework/jms/support/converter/MessagingMessageConverter.java
  6. 2
      spring-jms/src/main/java/org/springframework/jms/support/converter/SmartMessageConverter.java
  7. 2
      spring-messaging/src/main/java/org/springframework/messaging/converter/AbstractMessageConverter.java
  8. 2
      spring-messaging/src/main/java/org/springframework/messaging/converter/SmartMessageConverter.java
  9. 29
      spring-web/src/main/java/org/springframework/http/server/observation/ServerHttpObservationDocumentation.java
  10. 29
      spring-web/src/main/java/org/springframework/http/server/reactive/observation/ServerHttpObservationDocumentation.java

2
spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/ReflectiveAspectJAdvisorFactory.java

@ -1,5 +1,5 @@ @@ -1,5 +1,5 @@
/*
* Copyright 2002-2024 the original author or authors.
* Copyright 2002-2025 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.

2
spring-core/src/main/java/org/springframework/asm/SymbolTable.java

@ -1473,7 +1473,7 @@ final class SymbolTable { @@ -1473,7 +1473,7 @@ final class SymbolTable {
/**
* Another entry (and so on recursively) having the same hash code (modulo the size of {@link
* SymbolTable#labelEntries}) as this one.
* SymbolTable#labelEntries}}) as this one.
*/
LabelEntry next;

10
spring-core/src/main/java/org/springframework/util/ObjectUtils.java

@ -1,5 +1,5 @@ @@ -1,5 +1,5 @@
/*
* Copyright 2002-2024 the original author or authors.
* Copyright 2002-2025 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.
@ -410,10 +410,10 @@ public abstract class ObjectUtils { @@ -410,10 +410,10 @@ public abstract class ObjectUtils {
}
/**
* Return a hash code for the given object; typically the value of
* {@code Object#hashCode()}. If the object is an array,
* this method will delegate to any of the {@code Arrays.hashCode}
* methods. If the object is {@code null}, this method returns 0.
* Return a hash code for the given object, typically the value of
* {@link Object#hashCode()}. If the object is an array, this method
* will delegate to one of the {@code Arrays.hashCode} methods. If
* the object is {@code null}, this method returns {@code 0}.
* @see Object#hashCode()
* @see Arrays
*/

2
spring-jms/src/main/java/org/springframework/jms/connection/UserCredentialsConnectionFactoryAdapter.java

@ -1,5 +1,5 @@ @@ -1,5 +1,5 @@
/*
* Copyright 2002-2024 the original author or authors.
* Copyright 2002-2025 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.

2
spring-jms/src/main/java/org/springframework/jms/support/converter/MessagingMessageConverter.java

@ -1,5 +1,5 @@ @@ -1,5 +1,5 @@
/*
* Copyright 2002-2023 the original author or authors.
* Copyright 2002-2025 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.

2
spring-jms/src/main/java/org/springframework/jms/support/converter/SmartMessageConverter.java

@ -1,5 +1,5 @@ @@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2025 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.

2
spring-messaging/src/main/java/org/springframework/messaging/converter/AbstractMessageConverter.java

@ -1,5 +1,5 @@ @@ -1,5 +1,5 @@
/*
* Copyright 2002-2023 the original author or authors.
* Copyright 2002-2025 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.

2
spring-messaging/src/main/java/org/springframework/messaging/converter/SmartMessageConverter.java

@ -1,5 +1,5 @@ @@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2025 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.

29
spring-web/src/main/java/org/springframework/http/server/observation/ServerHttpObservationDocumentation.java

@ -1,5 +1,5 @@ @@ -1,5 +1,5 @@
/*
* Copyright 2002-2022 the original author or authors.
* Copyright 2002-2025 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.
@ -23,9 +23,11 @@ import io.micrometer.observation.ObservationConvention; @@ -23,9 +23,11 @@ import io.micrometer.observation.ObservationConvention;
import io.micrometer.observation.docs.ObservationDocumentation;
/**
* Documented {@link io.micrometer.common.KeyValue KeyValues} for the HTTP server observations
* for Servlet-based web applications.
* <p>This class is used by automated tools to document KeyValues attached to the HTTP server observations.
* Documented {@link io.micrometer.common.KeyValue KeyValues} for the HTTP server
* observations for Servlet-based web applications.
*
* <p>This class is used by automated tools to document KeyValues attached to the
* HTTP server observations.
*
* @author Brian Clozel
* @since 6.0
@ -56,7 +58,8 @@ public enum ServerHttpObservationDocumentation implements ObservationDocumentati @@ -56,7 +58,8 @@ public enum ServerHttpObservationDocumentation implements ObservationDocumentati
public enum LowCardinalityKeyNames implements KeyName {
/**
* Name of HTTP request method or {@value KeyValue#NONE_VALUE} if the request was not received properly.
* Name of the HTTP request method or {@value KeyValue#NONE_VALUE} if the
* request was not received properly.
*/
METHOD {
@Override
@ -67,7 +70,8 @@ public enum ServerHttpObservationDocumentation implements ObservationDocumentati @@ -67,7 +70,8 @@ public enum ServerHttpObservationDocumentation implements ObservationDocumentati
},
/**
* HTTP response raw status code, or {@code "UNKNOWN"} if no response was created.
* HTTP response raw status code, or {@code "UNKNOWN"} if no response was
* created.
*/
STATUS {
@Override
@ -77,9 +81,10 @@ public enum ServerHttpObservationDocumentation implements ObservationDocumentati @@ -77,9 +81,10 @@ public enum ServerHttpObservationDocumentation implements ObservationDocumentati
},
/**
* URI pattern for the matching handler if available, falling back to {@code REDIRECTION} for 3xx responses,
* {@code NOT_FOUND} for 404 responses, {@code root} for requests with no path info,
* and {@code UNKNOWN} for all other requests.
* URI pattern for the matching handler if available, falling back to
* {@code REDIRECTION} for 3xx responses, {@code NOT_FOUND} for 404
* responses, {@code root} for requests with no path info, and
* {@code UNKNOWN} for all other requests.
*/
URI {
@Override
@ -89,7 +94,8 @@ public enum ServerHttpObservationDocumentation implements ObservationDocumentati @@ -89,7 +94,8 @@ public enum ServerHttpObservationDocumentation implements ObservationDocumentati
},
/**
* Name of the exception thrown during the exchange, or {@value KeyValue#NONE_VALUE} if no exception happened.
* Name of the exception thrown during the exchange, or
* {@value KeyValue#NONE_VALUE} if no exception was thrown.
*/
EXCEPTION {
@Override
@ -113,7 +119,7 @@ public enum ServerHttpObservationDocumentation implements ObservationDocumentati @@ -113,7 +119,7 @@ public enum ServerHttpObservationDocumentation implements ObservationDocumentati
public enum HighCardinalityKeyNames implements KeyName {
/**
* HTTP request URI.
* HTTP request URL.
*/
HTTP_URL {
@Override
@ -123,4 +129,5 @@ public enum ServerHttpObservationDocumentation implements ObservationDocumentati @@ -123,4 +129,5 @@ public enum ServerHttpObservationDocumentation implements ObservationDocumentati
}
}
}

29
spring-web/src/main/java/org/springframework/http/server/reactive/observation/ServerHttpObservationDocumentation.java

@ -1,5 +1,5 @@ @@ -1,5 +1,5 @@
/*
* Copyright 2002-2022 the original author or authors.
* Copyright 2002-2025 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.
@ -23,9 +23,11 @@ import io.micrometer.observation.ObservationConvention; @@ -23,9 +23,11 @@ import io.micrometer.observation.ObservationConvention;
import io.micrometer.observation.docs.ObservationDocumentation;
/**
* Documented {@link io.micrometer.common.KeyValue KeyValues} for the HTTP server observations
* for reactive web applications.
* <p>This class is used by automated tools to document KeyValues attached to the HTTP server observations.
* Documented {@link io.micrometer.common.KeyValue KeyValues} for the HTTP server
* observations for reactive web applications.
*
* <p>This class is used by automated tools to document KeyValues attached to the
* HTTP server observations.
*
* @author Brian Clozel
* @since 6.0
@ -56,7 +58,8 @@ public enum ServerHttpObservationDocumentation implements ObservationDocumentati @@ -56,7 +58,8 @@ public enum ServerHttpObservationDocumentation implements ObservationDocumentati
public enum LowCardinalityKeyNames implements KeyName {
/**
* Name of HTTP request method or {@value KeyValue#NONE_VALUE} if the request was not received properly.
* Name of the HTTP request method or {@value KeyValue#NONE_VALUE} if the
* request was not received properly.
*/
METHOD {
@Override
@ -67,7 +70,8 @@ public enum ServerHttpObservationDocumentation implements ObservationDocumentati @@ -67,7 +70,8 @@ public enum ServerHttpObservationDocumentation implements ObservationDocumentati
},
/**
* HTTP response raw status code, or {@code "UNKNOWN"} if no response was created.
* HTTP response raw status code, or {@code "UNKNOWN"} if no response was
* created.
*/
STATUS {
@Override
@ -77,9 +81,10 @@ public enum ServerHttpObservationDocumentation implements ObservationDocumentati @@ -77,9 +81,10 @@ public enum ServerHttpObservationDocumentation implements ObservationDocumentati
},
/**
* URI pattern for the matching handler if available, falling back to {@code REDIRECTION} for 3xx responses,
* {@code NOT_FOUND} for 404 responses, {@code root} for requests with no path info,
* and {@code UNKNOWN} for all other requests.
* URI pattern for the matching handler if available, falling back to
* {@code REDIRECTION} for 3xx responses, {@code NOT_FOUND} for 404
* responses, {@code root} for requests with no path info, and
* {@code UNKNOWN} for all other requests.
*/
URI {
@Override
@ -89,7 +94,8 @@ public enum ServerHttpObservationDocumentation implements ObservationDocumentati @@ -89,7 +94,8 @@ public enum ServerHttpObservationDocumentation implements ObservationDocumentati
},
/**
* Name of the exception thrown during the exchange, or {@value KeyValue#NONE_VALUE} if no exception happened.
* Name of the exception thrown during the exchange, or
* {@value KeyValue#NONE_VALUE} if no exception was thrown.
*/
EXCEPTION {
@Override
@ -113,7 +119,7 @@ public enum ServerHttpObservationDocumentation implements ObservationDocumentati @@ -113,7 +119,7 @@ public enum ServerHttpObservationDocumentation implements ObservationDocumentati
public enum HighCardinalityKeyNames implements KeyName {
/**
* HTTP request URI.
* HTTP request URL.
*/
HTTP_URL {
@Override
@ -123,4 +129,5 @@ public enum ServerHttpObservationDocumentation implements ObservationDocumentati @@ -123,4 +129,5 @@ public enum ServerHttpObservationDocumentation implements ObservationDocumentati
}
}
}

Loading…
Cancel
Save