Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve javadoc cleanup to remove duplicate spaces

Browse Source 
Improve `TypeUtils` so that repeated space chars are removed.

Fixes gh-40593
This commit is contained in:
Phillip Webb
2024-05-01 22:35:28 -07:00
parent 72925e7a17
commit ff5c2a2351
4 changed files with 94 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/ConfigurationMetadataAnnotationProcessorTests.java
View File

@@ -521,7 +521,7 @@ class ConfigurationMetadataAnnotationProcessorTests extends AbstractMetadataGene
void recordPropertiesWithDescriptions() {
ConfigurationMetadata metadata = compile(ExampleRecord.class);
assertThat(metadata).has(Metadata.withProperty("record.descriptions.some-string", String.class)
.withDescription("very long description that doesn't fit single line"));
.withDescription("very long description that doesn't fit single line and is indented"));
assertThat(metadata).has(Metadata.withProperty("record.descriptions.some-integer", Integer.class)
.withDescription("description with @param and @ pitfalls"));
assertThat(metadata).has(Metadata.withProperty("record.descriptions.some-boolean", Boolean.class)

7
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/record/ExampleRecord.java
View File

@@ -16,10 +16,13 @@
package org.springframework.boot.configurationsample.record;
// @formatter:off
/**
* Example Record Javadoc sample
*
* @param someString very long description that doesn't fit single line
* @param someString very long description that
* doesn't fit single line and is indented
* @param someInteger description with @param and @ pitfalls
* @param someBoolean description with extra spaces
* @param someLong description without space after asterisk
@@ -30,3 +33,5 @@ package org.springframework.boot.configurationsample.record;
@org.springframework.boot.configurationsample.ConfigurationProperties("record.descriptions")
public record ExampleRecord(String someString, Integer someInteger, Boolean someBoolean, Long someLong, Byte someByte) {
}
//@formatter:on