Browse Source

Escape reserved asciidoc character in generated documentation

See gh-17663
pull/17742/head
vivganes 7 years ago committed by Stephane Nicoll
parent
commit
b0fa58e861
  1. 2
      spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/SingleConfigurationTableEntry.java
  2. 14
      spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/test/java/org/springframework/boot/configurationdocs/SingleConfigurationTableEntryTests.java

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

@ -76,7 +76,7 @@ class SingleConfigurationTableEntry extends ConfigurationTableEntry { @@ -76,7 +76,7 @@ class SingleConfigurationTableEntry extends ConfigurationTableEntry {
builder.append("|");
}
else {
builder.append("|+++", this.description, "+++");
builder.append("|+++", this.description.replace("|", "\\|"), "+++");
}
}

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

@ -86,6 +86,20 @@ class SingleConfigurationTableEntryTests { @@ -86,6 +86,20 @@ class SingleConfigurationTableEntryTests {
+ "|+++This is a description.+++" + NEWLINE);
}
@Test
void descriptionWithPipe() {
ConfigurationMetadataProperty property = new ConfigurationMetadataProperty();
property.setId("spring.test.prop");
property.setDefaultValue("first\\second");
property.setDescription("This is a description with a | pipe.");
property.setType("java.lang.String");
SingleConfigurationTableEntry entry = new SingleConfigurationTableEntry(property);
AsciidocBuilder builder = new AsciidocBuilder();
entry.write(builder);
assertThat(builder.toString()).isEqualTo("|`+spring.test.prop+`" + NEWLINE + "|`+first\\\\second+`" + NEWLINE
+ "|+++This is a description with a \\| pipe.+++" + NEWLINE);
}
@Test
void mapProperty() {
ConfigurationMetadataProperty property = new ConfigurationMetadataProperty();

Loading…
Cancel
Save