Skip to content

Commit f68c7a7

Browse files
committed
Polish "Escape reserved asciidoc character in generated documentation"
See spring-projectsgh-17663
1 parent b0fa58e commit f68c7a7

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

Diff for: spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/SingleConfigurationTableEntry.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,8 @@ private void writeDescription(AsciidocBuilder builder) {
7676
builder.append("|");
7777
}
7878
else {
79-
builder.append("|+++", this.description.replace("|", "\\|"), "+++");
79+
String cleanedDescription = this.description.replace("|", "\\|");
80+
builder.append("|+++", cleanedDescription, "+++");
8081
}
8182
}
8283

Diff for: spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/test/java/org/springframework/boot/configurationdocs/SingleConfigurationTableEntryTests.java

+1-2
Original file line numberDiff line numberDiff line change
@@ -90,13 +90,12 @@ void defaultValueWithBackslash() {
9090
void descriptionWithPipe() {
9191
ConfigurationMetadataProperty property = new ConfigurationMetadataProperty();
9292
property.setId("spring.test.prop");
93-
property.setDefaultValue("first\\second");
9493
property.setDescription("This is a description with a | pipe.");
9594
property.setType("java.lang.String");
9695
SingleConfigurationTableEntry entry = new SingleConfigurationTableEntry(property);
9796
AsciidocBuilder builder = new AsciidocBuilder();
9897
entry.write(builder);
99-
assertThat(builder.toString()).isEqualTo("|`+spring.test.prop+`" + NEWLINE + "|`+first\\\\second+`" + NEWLINE
98+
assertThat(builder.toString()).isEqualTo("|`+spring.test.prop+`" + NEWLINE + "|" + NEWLINE
10099
+ "|+++This is a description with a \\| pipe.+++" + NEWLINE);
101100
}
102101

0 commit comments

Comments
 (0)