From 05cf7fbb0455ee78fa15f7b232050cf7b5cc1caa Mon Sep 17 00:00:00 2001 From: Phillip Webb Date: Tue, 9 Mar 2021 11:52:40 -0800 Subject: [PATCH] Use new backend features for extracted samples Update extracted samples to make use of code folding and chomping. See gh-6313 --- .../src/docs/asciidoc/attributes.adoc | 2 +- .../docs/asciidoc/spring-boot-features.adoc | 110 +++++++++--------- .../ThirdPartyConfiguration.java | 3 +- .../constructorbinding/AcmeProperties.java | 12 +- .../constructorbinding/AppIoProperties.java | 6 +- .../javabeanbinding/AppIoProperties.java | 4 +- .../AppSystemProperties.java | 6 +- .../javabeanbinding/AppSystemProperties.java | 4 +- .../enable/MyApplication.java | 2 - .../enable/MyConfiguration.java | 3 +- .../javabeanbinding/AcmeProperties.java | 6 +- .../merge/list/AcmeProperties.java | 3 +- .../merge/map/AcmeProperties.java | 3 +- .../relaxed/OwnerProperties.java | 2 - .../use/MyService.java | 3 +- .../validate/AcmeProperties.java | 4 +- .../validate/nested/AcmeProperties.java | 6 +- .../valueinjection/MyBean.java | 2 - .../messaging/KafkaStreamsConfiguration.java | 2 - .../CouchbaseCacheManagerConfiguration.java | 2 - ...activeTransactionManagerConfiguration.java | 2 - .../nosql/RedisCacheManagerConfiguration.java | 2 - .../profiles/ProductionConfiguration.java | 2 - .../RestTemplateBuilderConfiguration.java | 2 - .../RestTemplateProxyCustomizer.java | 2 - .../CustomWebFluxSecurityConfiguration.java | 2 - .../ApplicationArgumentsExample.java | 2 - .../CommandLineRunnerExample.java | 2 - .../availability/LocalCacheVerifier.java | 3 +- .../availability/ReadinessStateExporter.java | 2 - .../exitcode/MyApplication.java | 2 - .../main/custom/MyApplication.java | 2 - .../main/run/MyApplication.java | 2 - .../testing/ApplicationArgumentTests.java | 2 - .../testing/MockMvcTests.java | 2 - .../testing/MockWebTestClientTests.java | 2 - .../testing/OutputCaptureTests.java | 2 - .../RandomPortTestRestTemplateTests.java | 2 - .../testing/RandomPortWebTestClientTests.java | 2 - .../testing/jmx/SampleJmxTests.java | 2 - .../AdvancedRestDocsConfiguration.java | 2 - .../restassured/UserDocumentationTests.java | 13 ++- .../AdvancedRestDocsConfiguration.java | 2 - .../webclient/UsersDocumentationTests.java | 13 ++- .../webclient/SampleWebClientTests.java | 2 - .../HttpMessageConvertersConfiguration.java | 3 +- .../TomcatServerCustomizer.java | 2 - .../webapplications/json/MyJsonComponent.java | 3 +- .../json/object/MyJsonComponent.java | 3 +- .../servlet/CorsConfiguration.java | 2 - .../servlet/ErrorPageConfiguration.java | 2 - .../servlet/MyControllerAdvice.java | 3 +- .../servlet/MyErrorViewResolver.java | 2 - .../servlet/MyRestController.java | 3 +- .../servlet/ServletFilterConfiguration.java | 3 +- .../webflux/CodecConfiguration.java | 2 - .../CustomErrorWebExceptionHandler.java | 2 - .../webflux/MyRestController.java | 3 +- .../webflux/fn/RoutingConfiguration.java | 2 - .../webflux/fn/UserHandler.java | 11 +- 60 files changed, 122 insertions(+), 182 deletions(-) diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/attributes.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/attributes.adoc index ea14af6df87..156bdac222b 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/attributes.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/attributes.adoc @@ -7,9 +7,9 @@ :numbered: :sectanchors: :sectnums: -:icons: font :hide-uri-scheme: :docinfo: shared,private +:chomp: tags formatters headers packages :spring-boot-artifactory-repo: snapshot :github-tag: master diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/spring-boot-features.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/spring-boot-features.adoc index de63d6673ea..d0a40c0a9ff 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/spring-boot-features.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/spring-boot-features.adoc @@ -15,7 +15,7 @@ In many situations, you can delegate to the static `SpringApplication.run` metho [source,java,indent=0] ---- -include::{include-springbootfeatures}/springapplication/main/run/MyApplication.java[tag=*] +include::{include-springbootfeatures}/springapplication/main/run/MyApplication.java[] ---- When your application starts, you should see something similar to the following output: @@ -176,7 +176,7 @@ For example, to turn off the banner, you could write: [source,java,indent=0] ---- -include::{include-springbootfeatures}/springapplication/main/custom/MyApplication.java[tag=*] +include::{include-springbootfeatures}/springapplication/main/custom/MyApplication.java[] ---- NOTE: The constructor arguments passed to `SpringApplication` are configuration sources for Spring beans. @@ -251,7 +251,7 @@ For example, we can export the "Readiness" state of the application to a file so [source,java,indent=0] ---- -include::{include-springbootfeatures}/springapplication/availability/ReadinessStateExporter.java[tag=*] +include::{include-springbootfeatures}/springapplication/availability/ReadinessStateExporter.java[] ---- We can also update the state of the application, when the application breaks and cannot recover: @@ -343,7 +343,7 @@ The `ApplicationArguments` interface provides access to both the raw `String[]` [source,java,indent=0] ---- -include::{include-springbootfeatures}/springapplication/ApplicationArgumentsExample.java[tag=*] +include::{include-springbootfeatures}/springapplication/ApplicationArgumentsExample.java[] ---- TIP: Spring Boot also registers a `CommandLinePropertySource` with the Spring `Environment`. @@ -364,7 +364,7 @@ The following example shows a `CommandLineRunner` with a `run` method: [source,java,indent=0] ---- -include::{include-springbootfeatures}/springapplication/CommandLineRunnerExample.java[tag=*] +include::{include-springbootfeatures}/springapplication/CommandLineRunnerExample.java[] ---- If several `CommandLineRunner` or `ApplicationRunner` beans are defined that must be called in a specific order, you can additionally implement the `org.springframework.core.Ordered` interface or use the `org.springframework.core.annotation.Order` annotation. @@ -381,7 +381,7 @@ This exit code can then be passed to `System.exit()` to return it as a status co [source,java,indent=0] ---- -include::{include-springbootfeatures}/springapplication/exitcode/MyApplication.java[tag=*] +include::{include-springbootfeatures}/springapplication/exitcode/MyApplication.java[] ---- Also, the `ExitCodeGenerator` interface may be implemented by exceptions. @@ -470,7 +470,7 @@ To provide a concrete example, suppose you develop a `@Component` that uses a `n [source,java,indent=0] ---- -include::{include-springbootfeatures}/externalizedconfiguration/valueinjection/MyBean.java[tag=*] +include::{include-springbootfeatures}/externalizedconfiguration/valueinjection/MyBean.java[] ---- On your application classpath (for example, inside your jar) you can have an `application.properties` file that provides a sensible default property value for `name`. @@ -1037,7 +1037,7 @@ It is possible to bind a bean declaring standard JavaBean properties as shown in [source,java,indent=0] ---- -include::{include-springbootfeatures}/externalizedconfiguration/javabeanbinding/AcmeProperties.java[tag=*] +include::{include-springbootfeatures}/externalizedconfiguration/javabeanbinding/AcmeProperties.java[] ---- The preceding POJO defines the following properties: @@ -1078,7 +1078,7 @@ The example in the previous section can be rewritten in an immutable fashion as [source,java,indent=0] ---- -include::{include-springbootfeatures}/externalizedconfiguration/constructorbinding/AcmeProperties.java[tag=*] +include::{include-springbootfeatures}/externalizedconfiguration/constructorbinding/AcmeProperties.java[] ---- In this setup, the `@ConstructorBinding` annotation is used to indicate that constructor binding should be used. @@ -1118,7 +1118,7 @@ This can be done on any `@Configuration` class, as shown in the following exampl [source,java,indent=0] ---- -include::{include-springbootfeatures}/externalizedconfiguration/enable/MyConfiguration.java[tag=*] +include::{include-springbootfeatures}/externalizedconfiguration/enable/MyConfiguration.java[] ---- To use configuration property scanning, add the `@ConfigurationPropertiesScan` annotation to your application. @@ -1128,7 +1128,7 @@ If you want to define specific packages to scan, you can do so as shown in the f [source,java,indent=0] ---- -include::{include-springbootfeatures}/externalizedconfiguration/enable/MyApplication.java[tag=*] +include::{include-springbootfeatures}/externalizedconfiguration/enable/MyApplication.java[] ---- [NOTE] @@ -1164,7 +1164,7 @@ To work with `@ConfigurationProperties` beans, you can inject them in the same w [source,java,indent=0] ---- -include::{include-springbootfeatures}/externalizedconfiguration/use/MyService.java[tag=*] +include::{include-springbootfeatures}/externalizedconfiguration/use/MyService.java[] ---- TIP: Using `@ConfigurationProperties` also lets you generate metadata files that can be used by IDEs to offer auto-completion for your own keys. @@ -1181,7 +1181,7 @@ To configure a bean from the `Environment` properties, add `@ConfigurationProper [source,java,indent=0] ---- -include::{include-springbootfeatures}/externalizedconfiguration/ThirdPartyConfiguration.java[tag=*] +include::{include-springbootfeatures}/externalizedconfiguration/ThirdPartyConfiguration.java[] ---- Any JavaBean property defined with the `another` prefix is mapped onto that `AnotherComponent` bean in manner similar to the preceding `AcmeProperties` example. @@ -1197,7 +1197,7 @@ As an example, consider the following `@ConfigurationProperties` class: [source,java,indent=0] ---- -include::{include-springbootfeatures}/externalizedconfiguration/relaxed/OwnerProperties.java[tag=*] +include::{include-springbootfeatures}/externalizedconfiguration/relaxed/OwnerProperties.java[] ---- With the preceding code, the following properties names can all be used: @@ -1428,7 +1428,7 @@ Consider the following example: [source,java,indent=0] ---- -include::{include-springbootfeatures}/externalizedconfiguration/duration/javabeanbinding/AppSystemProperties.java[tag=*] +include::{include-springbootfeatures}/externalizedconfiguration/duration/javabeanbinding/AppSystemProperties.java[] ---- To specify a session timeout of 30 seconds, `30`, `PT30S` and `30s` are all equivalent. @@ -1451,7 +1451,7 @@ If you prefer to use constructor binding, the same properties can be exposed, as [source,java,indent=0] ---- -include::{include-springbootfeatures}/externalizedconfiguration/duration/constructorbinding/AppSystemProperties.java[tag=*] +include::{include-springbootfeatures}/externalizedconfiguration/duration/constructorbinding/AppSystemProperties.java[] ---- @@ -1492,7 +1492,7 @@ Consider the following example: [source,java,indent=0] ---- -include::{include-springbootfeatures}/externalizedconfiguration/datasize/javabeanbinding/AppIoProperties.java[tag=*] +include::{include-springbootfeatures}/externalizedconfiguration/datasize/javabeanbinding/AppIoProperties.java[] ---- To specify a buffer size of 10 megabytes, `10` and `10MB` are equivalent. @@ -1513,7 +1513,7 @@ If you prefer to use constructor binding, the same properties can be exposed, as [source,java,indent=0] ---- -include::{include-springbootfeatures}/externalizedconfiguration/datasize/constructorbinding/AppIoProperties.java[tag=*] +include::{include-springbootfeatures}/externalizedconfiguration/datasize/constructorbinding/AppIoProperties.java[] ---- TIP: If you are upgrading a `Long` property, make sure to define the unit (using `@DataSizeUnit`) if it isn't bytes. @@ -1529,7 +1529,7 @@ To do so, ensure that a compliant JSR-303 implementation is on your classpath an [source,java,indent=0] ---- -include::{include-springbootfeatures}/externalizedconfiguration/validate/AcmeProperties.java[tag=*] +include::{include-springbootfeatures}/externalizedconfiguration/validate/AcmeProperties.java[] ---- TIP: You can also trigger validation by annotating the `@Bean` method that creates the configuration properties with `@Validated`. @@ -1539,7 +1539,7 @@ The following example builds on the preceding `AcmeProperties` example: [source,java,indent=0] ---- -include::{include-springbootfeatures}/externalizedconfiguration/validate/nested/AcmeProperties.java[tag=*] +include::{include-springbootfeatures}/externalizedconfiguration/validate/nested/AcmeProperties.java[] ---- You can also add a custom Spring `Validator` by creating a bean definition called `configurationPropertiesValidator`. @@ -1596,7 +1596,7 @@ Any `@Component`, `@Configuration` or `@ConfigurationProperties` can be marked w [source,java,indent=0] ---- -include::{include-springbootfeatures}/profiles/ProductionConfiguration.java[tag=*] +include::{include-springbootfeatures}/profiles/ProductionConfiguration.java[] ---- NOTE: If `@ConfigurationProperties` beans are registered via `@EnableConfigurationProperties` instead of automatic scanning, the `@Profile` annotation needs to be specified on the `@Configuration` class that has the `@EnableConfigurationProperties` annotation. @@ -2230,7 +2230,7 @@ The following code shows a typical `@RestController` that serves JSON data: [source,java,indent=0] ---- -include::{include-springbootfeatures}/webapplications/servlet/MyRestController.java[tag=*] +include::{include-springbootfeatures}/webapplications/servlet/MyRestController.java[] ---- Spring MVC is part of the core Spring Framework, and detailed information is available in the {spring-framework-docs}/web.html#mvc[reference documentation]. @@ -2280,7 +2280,7 @@ If you need to add or customize converters, you can use Spring Boot's `HttpMessa [source,java,indent=0] ---- -include::{include-springbootfeatures}/webapplications/HttpMessageConvertersConfiguration.java[tag=*] +include::{include-springbootfeatures}/webapplications/HttpMessageConvertersConfiguration.java[] ---- Any `HttpMessageConverter` bean that is present in the context is added to the list of converters. @@ -2298,7 +2298,7 @@ You can also use it on classes that contain serializers/deserializers as inner c [source,java,indent=0] ---- -include::{include-springbootfeatures}/webapplications/json/MyJsonComponent.java[tag=*] +include::{include-springbootfeatures}/webapplications/json/MyJsonComponent.java[] ---- All `@JsonComponent` beans in the `ApplicationContext` are automatically registered with Jackson. @@ -2311,7 +2311,7 @@ The example above can be rewritten to use `JsonObjectSerializer`/`JsonObjectDese [source,java,indent=0] ---- -include::{include-springbootfeatures}/webapplications/json/object/MyJsonComponent.java[tag=*] +include::{include-springbootfeatures}/webapplications/json/object/MyJsonComponent.java[] ---- @@ -2558,7 +2558,7 @@ You can also define a class annotated with `@ControllerAdvice` to customize the [source,java,indent=0,subs="verbatim,quotes,attributes"] ---- -include::{include-springbootfeatures}/webapplications/servlet/MyControllerAdvice.java[tag=*] +include::{include-springbootfeatures}/webapplications/servlet/MyControllerAdvice.java[] ---- In the preceding example, if `YourException` is thrown by a controller defined in the same package as `AcmeController`, a JSON representation of the `CustomErrorType` POJO is used instead of the `ErrorAttributes` representation. @@ -2605,7 +2605,7 @@ For more complex mappings, you can also add beans that implement the `ErrorViewR [source,java,indent=0,subs="verbatim,quotes,attributes"] ---- -include::{include-springbootfeatures}/webapplications/servlet/MyErrorViewResolver.java[tag=*] +include::{include-springbootfeatures}/webapplications/servlet/MyErrorViewResolver.java[] ---- You can also use regular Spring MVC features such as {spring-framework-docs}/web.html#mvc-exceptionhandlers[`@ExceptionHandler` methods] and {spring-framework-docs}/web.html#mvc-ann-controller-advice[`@ControllerAdvice`]. @@ -2620,14 +2620,14 @@ This abstraction works directly with the underlying embedded servlet container a [source,java,indent=0,subs="verbatim,quotes,attributes"] ---- -include::{include-springbootfeatures}/webapplications/servlet/ErrorPageConfiguration.java[tag=*] +include::{include-springbootfeatures}/webapplications/servlet/ErrorPageConfiguration.java[] ---- NOTE: If you register an `ErrorPage` with a path that ends up being handled by a `Filter` (as is common with some non-Spring web frameworks, like Jersey and Wicket), then the `Filter` has to be explicitly registered as an `ERROR` dispatcher, as shown in the following example: [source,java,indent=0,subs="verbatim,quotes,attributes"] ---- -include::{include-springbootfeatures}/webapplications/servlet/ServletFilterConfiguration.java[tag=*] +include::{include-springbootfeatures}/webapplications/servlet/ServletFilterConfiguration.java[] ---- Note that the default `FilterRegistrationBean` does not include the `ERROR` dispatcher type. @@ -2671,7 +2671,7 @@ Using {spring-framework-docs}/web.html#mvc-cors-controller[controller method COR [source,java,indent=0] ---- -include::{include-springbootfeatures}/webapplications/servlet/CorsConfiguration.java[tag=*] +include::{include-springbootfeatures}/webapplications/servlet/CorsConfiguration.java[] ---- @@ -2686,19 +2686,19 @@ The annotation-based one is quite close to the Spring MVC model, as shown in the [source,java,indent=0] ---- -include::{include-springbootfeatures}/webapplications/webflux/MyRestController.java[tag=*] +include::{include-springbootfeatures}/webapplications/webflux/MyRestController.java[] ---- "`WebFlux.fn`", the functional variant, separates the routing configuration from the actual handling of the requests, as shown in the following example: [source,java,indent=0] ---- -include::{include-springbootfeatures}/webapplications/webflux/fn/RoutingConfiguration.java[tag=*] +include::{include-springbootfeatures}/webapplications/webflux/fn/RoutingConfiguration.java[] ---- [source,java,indent=0] ---- -include::{include-springbootfeatures}/webapplications/webflux/fn/UserHandler.java[tag=*] +include::{include-springbootfeatures}/webapplications/webflux/fn/UserHandler.java[] ---- WebFlux is part of the Spring Framework and detailed information is available in its {spring-framework-docs}/web-reactive.html#webflux-fn[reference documentation]. @@ -2742,7 +2742,7 @@ If you need to add or customize codecs, you can create a custom `CodecCustomizer [source,java,indent=0] ---- -include::{include-springbootfeatures}/webapplications/webflux/CodecConfiguration.java[tag=*] +include::{include-springbootfeatures}/webapplications/webflux/CodecConfiguration.java[] ---- You can also leverage <>. @@ -2815,7 +2815,7 @@ Because a `WebExceptionHandler` is quite low-level, Spring Boot also provides a [source,java,indent=0,subs="verbatim,quotes,attributes"] ---- -include::{include-springbootfeatures}/webapplications/webflux/CustomErrorWebExceptionHandler.java[tag=*] +include::{include-springbootfeatures}/webapplications/webflux/CustomErrorWebExceptionHandler.java[] ---- For a more complete picture, you can also subclass `DefaultErrorWebExceptionHandler` directly and override specific methods. @@ -3058,7 +3058,7 @@ The following example shows how to customize `TomcatServletWebServerFactory` tha [source,java,indent=0,subs="verbatim,quotes,attributes"] ---- -include::{include-springbootfeatures}/webapplications/TomcatServerCustomizer.java[tag=*] +include::{include-springbootfeatures}/webapplications/TomcatServerCustomizer.java[] ---- @@ -3312,7 +3312,7 @@ For example, you can customize your security configuration by adding something l [source,java,pending-extract=true,indent=0] ---- -include::{include-springbootfeatures}/security/CustomWebFluxSecurityConfiguration.java[tag=*] +include::{include-springbootfeatures}/security/CustomWebFluxSecurityConfiguration.java[] ---- @@ -4467,7 +4467,7 @@ To enable transaction management, the following bean must be defined in your con [source,java,indent=0] ---- -include::{include-springbootfeatures}/nosql/Neo4jReactiveTransactionManagerConfiguration.java[tag=*] +include::{include-springbootfeatures}/nosql/Neo4jReactiveTransactionManagerConfiguration.java[] ---- ==== @@ -5154,7 +5154,7 @@ The following example shows a customizer that configures a specific entry expira [source,java,indent=0] ---- -include::{include-springbootfeatures}/nosql/CouchbaseCacheManagerConfiguration.java[tag=*] +include::{include-springbootfeatures}/nosql/CouchbaseCacheManagerConfiguration.java[] ---- @@ -5185,7 +5185,7 @@ The following example shows a customizer that configures a specific time to live [source,java,indent=0] ---- -include::{include-springbootfeatures}/nosql/RedisCacheManagerConfiguration.java[tag=*] +include::{include-springbootfeatures}/nosql/RedisCacheManagerConfiguration.java[] ---- @@ -5752,7 +5752,7 @@ To use the factory bean, wire `StreamsBuilder` into your `@Bean` as shown in the [source,java,indent=0] ---- -include::{include-springbootfeatures}/messaging/KafkaStreamsConfiguration.java[tag=*] +include::{include-springbootfeatures}/messaging/KafkaStreamsConfiguration.java[] ---- By default, the streams managed by the `StreamBuilder` object it creates are started automatically. @@ -5907,7 +5907,7 @@ The following example shows a customizer that configures the use of a proxy for [source,java,indent=0] ---- -include::{include-springbootfeatures}/resttemplate/RestTemplateProxyCustomizer.java[tag=*] +include::{include-springbootfeatures}/resttemplate/RestTemplateProxyCustomizer.java[] ---- Finally, you can also create your own `RestTemplateBuilder` bean. @@ -5916,7 +5916,7 @@ The following example exposes a `RestTemplateBuilder` with what Spring Boot woul [source,java,indent=0] ---- -include::{include-springbootfeatures}/resttemplate/RestTemplateBuilderConfiguration.java[tag=*] +include::{include-springbootfeatures}/resttemplate/RestTemplateBuilderConfiguration.java[] ---- The most extreme (and rarely used) option is to create your own `RestTemplateBuilder` bean without using a configurer. @@ -6581,7 +6581,7 @@ have `@SpringBootTest` inject them using the `args` attribute. [source,java,indent=0] ---- -include::{include-springbootfeatures}/testing/ApplicationArgumentTests.java[tag=*] +include::{include-springbootfeatures}/testing/ApplicationArgumentTests.java[] ---- @@ -6593,7 +6593,7 @@ If you have web endpoints that you want to test against this mock environment, y [source,java,indent=0] ---- -include::{include-springbootfeatures}/testing/MockMvcTests.java[tag=*] +include::{include-springbootfeatures}/testing/MockMvcTests.java[] ---- TIP: If you want to focus only on the web layer and not start a complete `ApplicationContext`, consider <>. @@ -6602,7 +6602,7 @@ Alternatively, you can configure a {spring-framework-docs}/testing.html#webtestc [source,java,indent=0] ---- -include::{include-springbootfeatures}/testing/MockWebTestClientTests.java[tag=*] +include::{include-springbootfeatures}/testing/MockWebTestClientTests.java[] ---- [TIP] @@ -6627,7 +6627,7 @@ For convenience, tests that need to make REST calls to the started server can ad [source,java,indent=0] ---- -include::{include-springbootfeatures}/testing/RandomPortWebTestClientTests.java[tag=*] +include::{include-springbootfeatures}/testing/RandomPortWebTestClientTests.java[] ---- This setup requires `spring-webflux` on the classpath. @@ -6635,7 +6635,7 @@ If you can't or won't add webflux, Spring Boot also provides a `TestRestTemplate [source,java,indent=0] ---- -include::{include-springbootfeatures}/testing/RandomPortTestRestTemplateTests.java[tag=*] +include::{include-springbootfeatures}/testing/RandomPortTestRestTemplateTests.java[] ---- @@ -6654,7 +6654,7 @@ If such test needs access to an `MBeanServer`, consider marking it dirty as well [source,java,indent=0] ---- -include::{include-springbootfeatures}/testing/jmx/SampleJmxTests.java[tag=*] +include::{include-springbootfeatures}/testing/jmx/SampleJmxTests.java[] ---- @@ -7477,14 +7477,14 @@ You can inject it by using `@Autowired` and use it in your tests as you normally [source,java,indent=0] ---- -include::{include-springbootfeatures}/testing/restdocs/webclient/UsersDocumentationTests.java[tag=*] +include::{include-springbootfeatures}/testing/restdocs/webclient/UsersDocumentationTests.java[] ---- If you require more control over Spring REST Docs configuration than offered by the attributes of `@AutoConfigureRestDocs`, you can use a `RestDocsWebTestClientConfigurationCustomizer` bean, as shown in the following example: [source,java,indent=0] ---- -include::{include-springbootfeatures}/testing/restdocs/webclient/AdvancedRestDocsConfiguration.java[tag=*] +include::{include-springbootfeatures}/testing/restdocs/webclient/AdvancedRestDocsConfiguration.java[] ---- @@ -7496,14 +7496,14 @@ You can inject it by using `@Autowired` and use it in your tests as you normally [source,java,indent=0] ---- -include::{include-springbootfeatures}/testing/restdocs/restassured/UserDocumentationTests.java[tag=*] +include::{include-springbootfeatures}/testing/restdocs/restassured/UserDocumentationTests.java[] ---- If you require more control over Spring REST Docs configuration than offered by the attributes of `@AutoConfigureRestDocs`, a `RestDocsRestAssuredConfigurationCustomizer` bean can be used, as shown in the following example: [source,java,indent=0] ---- -include::{include-springbootfeatures}/testing/restdocs/restassured/AdvancedRestDocsConfiguration.java[tag=*] +include::{include-springbootfeatures}/testing/restdocs/restassured/AdvancedRestDocsConfiguration.java[] ---- @@ -7697,7 +7697,7 @@ To use add `@ExtendWith(OutputCaptureExtension.class)` and inject `CapturedOutpu [source,java,indent=0] ---- -include::{include-springbootfeatures}/testing/OutputCaptureTests.java[tag=*] +include::{include-springbootfeatures}/testing/OutputCaptureTests.java[] ---- @@ -7742,7 +7742,7 @@ Any URLs that do not specify a host and port automatically connect to the embedd [source,java,indent=0] ---- -include::{include-springbootfeatures}/testing/webclient/SampleWebClientTests.java[tag=*] +include::{include-springbootfeatures}/testing/webclient/SampleWebClientTests.java[] ---- diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/ThirdPartyConfiguration.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/ThirdPartyConfiguration.java index ee9d4ee8a18..9c1c1f95ad5 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/ThirdPartyConfiguration.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/ThirdPartyConfiguration.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.externalizedconfiguration; -//tag::code[] import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @@ -31,7 +30,7 @@ public class ThirdPartyConfiguration { } } -// end::code[] +// @chomp:file class AnotherComponent { diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/constructorbinding/AcmeProperties.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/constructorbinding/AcmeProperties.java index f5794c3653c..a5aea2be78f 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/constructorbinding/AcmeProperties.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/constructorbinding/AcmeProperties.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.externalizedconfiguration.constructorbinding; -//tag::code[] import java.net.InetAddress; import java.util.List; @@ -28,18 +27,22 @@ import org.springframework.boot.context.properties.bind.DefaultValue; @ConfigurationProperties("acme") public class AcmeProperties { + // @fold:on // fields... private final boolean enabled; private final InetAddress remoteAddress; private final Security security; + // @fold:off + public AcmeProperties(boolean enabled, InetAddress remoteAddress, Security security) { this.enabled = enabled; this.remoteAddress = remoteAddress; this.security = security; } + // @fold:on // getters... public boolean isEnabled() { return this.enabled; } @@ -51,21 +54,26 @@ public class AcmeProperties { public Security getSecurity() { return this.security; } + // @fold:off public static class Security { + // @fold:on // fields... private final String username; private final String password; private final List roles; + // @fold:off + public Security(String username, String password, @DefaultValue("USER") List roles) { this.username = username; this.password = password; this.roles = roles; } + // @fold:on // getters... public String getUsername() { return this.username; } @@ -77,8 +85,8 @@ public class AcmeProperties { public List getRoles() { return this.roles; } + // @fold:off } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/datasize/constructorbinding/AppIoProperties.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/datasize/constructorbinding/AppIoProperties.java index ea1b16249e1..4485e0889b8 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/datasize/constructorbinding/AppIoProperties.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/datasize/constructorbinding/AppIoProperties.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.externalizedconfiguration.datasize.constructorbinding; -// tag::code[] import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.context.properties.ConstructorBinding; import org.springframework.boot.context.properties.bind.DefaultValue; @@ -28,16 +27,19 @@ import org.springframework.util.unit.DataUnit; @ConstructorBinding public class AppIoProperties { + // @fold:on // fields... private final DataSize bufferSize; private final DataSize sizeThreshold; + // @fold:off public AppIoProperties(@DataSizeUnit(DataUnit.MEGABYTES) @DefaultValue("2MB") DataSize bufferSize, @DefaultValue("512B") DataSize sizeThreshold) { this.bufferSize = bufferSize; this.sizeThreshold = sizeThreshold; } + // @fold:on // getters... public DataSize getBufferSize() { return this.bufferSize; } @@ -45,6 +47,6 @@ public class AppIoProperties { public DataSize getSizeThreshold() { return this.sizeThreshold; } + // @fold:off } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/datasize/javabeanbinding/AppIoProperties.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/datasize/javabeanbinding/AppIoProperties.java index c69b097d701..d970eb1a047 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/datasize/javabeanbinding/AppIoProperties.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/datasize/javabeanbinding/AppIoProperties.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.externalizedconfiguration.datasize.javabeanbinding; -// tag::code[] import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.convert.DataSizeUnit; import org.springframework.util.unit.DataSize; @@ -30,6 +29,7 @@ public class AppIoProperties { private DataSize sizeThreshold = DataSize.ofBytes(512); + // @fold:on // getters/setters... public DataSize getBufferSize() { return this.bufferSize; } @@ -45,6 +45,6 @@ public class AppIoProperties { public void setSizeThreshold(DataSize sizeThreshold) { this.sizeThreshold = sizeThreshold; } + // @fold:off } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/duration/constructorbinding/AppSystemProperties.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/duration/constructorbinding/AppSystemProperties.java index bdfb5a3bb64..e46f51d2bc9 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/duration/constructorbinding/AppSystemProperties.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/duration/constructorbinding/AppSystemProperties.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.externalizedconfiguration.duration.constructorbinding; -// tag::code[] import java.time.Duration; import java.time.temporal.ChronoUnit; @@ -29,16 +28,19 @@ import org.springframework.boot.convert.DurationUnit; @ConstructorBinding public class AppSystemProperties { + // @fold:on // fields... private final Duration sessionTimeout; private final Duration readTimeout; + // @fold:off public AppSystemProperties(@DurationUnit(ChronoUnit.SECONDS) @DefaultValue("30s") Duration sessionTimeout, @DefaultValue("1000ms") Duration readTimeout) { this.sessionTimeout = sessionTimeout; this.readTimeout = readTimeout; } + // @fold:on // getters... public Duration getSessionTimeout() { return this.sessionTimeout; } @@ -46,6 +48,6 @@ public class AppSystemProperties { public Duration getReadTimeout() { return this.readTimeout; } + // @fold:off } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/duration/javabeanbinding/AppSystemProperties.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/duration/javabeanbinding/AppSystemProperties.java index 9aabcd46ecd..556733f5d95 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/duration/javabeanbinding/AppSystemProperties.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/duration/javabeanbinding/AppSystemProperties.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.externalizedconfiguration.duration.javabeanbinding; -// tag::code[] import java.time.Duration; import java.time.temporal.ChronoUnit; @@ -31,6 +30,7 @@ public class AppSystemProperties { private Duration readTimeout = Duration.ofMillis(1000); + // @fold:on // getters / setters... public Duration getSessionTimeout() { return this.sessionTimeout; } @@ -46,6 +46,6 @@ public class AppSystemProperties { public void setReadTimeout(Duration readTimeout) { this.readTimeout = readTimeout; } + // @fold:off } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/enable/MyApplication.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/enable/MyApplication.java index 9e41e9e65b8..c3c729c8af7 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/enable/MyApplication.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/enable/MyApplication.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.externalizedconfiguration.enable; -//tag::code[] import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.context.properties.ConfigurationPropertiesScan; @@ -25,4 +24,3 @@ import org.springframework.boot.context.properties.ConfigurationPropertiesScan; public class MyApplication { } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/enable/MyConfiguration.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/enable/MyConfiguration.java index 41d624a8d90..333b3bc1818 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/enable/MyConfiguration.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/enable/MyConfiguration.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.externalizedconfiguration.enable; -//tag::code[] import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.context.annotation.Configuration; @@ -25,7 +24,7 @@ import org.springframework.context.annotation.Configuration; public class MyConfiguration { } -// end::code[] +// @chomp:file class AcmeProperties { diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/javabeanbinding/AcmeProperties.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/javabeanbinding/AcmeProperties.java index a994f5de38c..0f6f9325d94 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/javabeanbinding/AcmeProperties.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/javabeanbinding/AcmeProperties.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.externalizedconfiguration.javabeanbinding; -//tag::code[] import java.net.InetAddress; import java.util.ArrayList; import java.util.Collections; @@ -33,6 +32,7 @@ public class AcmeProperties { private final Security security = new Security(); + // @fold:on // getters / setters... public boolean isEnabled() { return this.enabled; } @@ -52,6 +52,7 @@ public class AcmeProperties { public Security getSecurity() { return this.security; } + // @fold:off public static class Security { @@ -61,6 +62,7 @@ public class AcmeProperties { private List roles = new ArrayList<>(Collections.singleton("USER")); + // @fold:on // getters / setters... public String getUsername() { return this.username; } @@ -84,8 +86,8 @@ public class AcmeProperties { public void setRoles(List roles) { this.roles = roles; } + // @fold:off } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/merge/list/AcmeProperties.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/merge/list/AcmeProperties.java index 7419f33d00b..df6459a3439 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/merge/list/AcmeProperties.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/merge/list/AcmeProperties.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.externalizedconfiguration.merge.list; -//tag::code[] import java.util.ArrayList; import java.util.List; @@ -32,7 +31,7 @@ public class AcmeProperties { } } -// end::code[] +// @chomp: file class MyPojo { diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/merge/map/AcmeProperties.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/merge/map/AcmeProperties.java index 250d1c44dca..76bfd9e2c2f 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/merge/map/AcmeProperties.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/merge/map/AcmeProperties.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.externalizedconfiguration.merge.map; -//tag::code[] import java.util.LinkedHashMap; import java.util.Map; @@ -32,7 +31,7 @@ public class AcmeProperties { } } -// end::code[] +// @chomp:file class MyPojo { diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/relaxed/OwnerProperties.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/relaxed/OwnerProperties.java index 0ebc6f17d81..6dc45b39686 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/relaxed/OwnerProperties.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/relaxed/OwnerProperties.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.externalizedconfiguration.relaxed; -//tag::code[] import org.springframework.boot.context.properties.ConfigurationProperties; @ConfigurationProperties(prefix = "acme.my-project.person") @@ -33,4 +32,3 @@ public class OwnerProperties { } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/use/MyService.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/use/MyService.java index d6d74c52acc..5d7860e0a39 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/use/MyService.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/use/MyService.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.externalizedconfiguration.use; -//tag::code[] import org.springframework.stereotype.Service; @Service @@ -37,7 +36,7 @@ public class MyService { // ... } -// end::code[] +// @chomp:file class AcmeProperties { diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/validate/AcmeProperties.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/validate/AcmeProperties.java index da5b5133a4c..872cf496ed6 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/validate/AcmeProperties.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/validate/AcmeProperties.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.externalizedconfiguration.validate; -//tag::code[] import java.net.InetAddress; import javax.validation.constraints.NotNull; @@ -31,6 +30,7 @@ public class AcmeProperties { @NotNull private InetAddress remoteAddress; + // @fold:on // getters/setters... public InetAddress getRemoteAddress() { return this.remoteAddress; } @@ -38,6 +38,6 @@ public class AcmeProperties { public void setRemoteAddress(InetAddress remoteAddress) { this.remoteAddress = remoteAddress; } + // @fold:off } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/validate/nested/AcmeProperties.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/validate/nested/AcmeProperties.java index 4e71fec39ad..ab62c474259 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/validate/nested/AcmeProperties.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/validate/nested/AcmeProperties.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.externalizedconfiguration.validate.nested; -//tag::code[] import java.net.InetAddress; import javax.validation.Valid; @@ -36,6 +35,7 @@ public class AcmeProperties { @Valid private final Security security = new Security(); + // @fold:on // getters/setters... public InetAddress getRemoteAddress() { return this.remoteAddress; } @@ -47,12 +47,14 @@ public class AcmeProperties { public Security getSecurity() { return this.security; } + // @fold:off public static class Security { @NotEmpty private String username; + // @fold:on // getters/setters... public String getUsername() { return this.username; } @@ -60,8 +62,8 @@ public class AcmeProperties { public void setUsername(String username) { this.username = username; } + // @fold:off } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/valueinjection/MyBean.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/valueinjection/MyBean.java index f2a388ca71e..8ee16cbd100 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/valueinjection/MyBean.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/externalizedconfiguration/valueinjection/MyBean.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.externalizedconfiguration.valueinjection; -// tag::code[] import org.springframework.beans.factory.annotation.Value; import org.springframework.stereotype.Component; @@ -29,4 +28,3 @@ public class MyBean { // ... } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/messaging/KafkaStreamsConfiguration.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/messaging/KafkaStreamsConfiguration.java index 2a4dbdd3055..c56c3c3d357 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/messaging/KafkaStreamsConfiguration.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/messaging/KafkaStreamsConfiguration.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.messaging; -// tag::code[] import org.apache.kafka.common.serialization.Serdes; import org.apache.kafka.streams.KeyValue; import org.apache.kafka.streams.StreamsBuilder; @@ -41,4 +40,3 @@ public class KafkaStreamsConfiguration { } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/nosql/CouchbaseCacheManagerConfiguration.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/nosql/CouchbaseCacheManagerConfiguration.java index e130e09ce4f..b652a8cf703 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/nosql/CouchbaseCacheManagerConfiguration.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/nosql/CouchbaseCacheManagerConfiguration.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.nosql; -// tag::code[] import java.time.Duration; import org.springframework.boot.autoconfigure.cache.CouchbaseCacheManagerBuilderCustomizer; @@ -38,4 +37,3 @@ public class CouchbaseCacheManagerConfiguration { } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/nosql/Neo4jReactiveTransactionManagerConfiguration.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/nosql/Neo4jReactiveTransactionManagerConfiguration.java index 34ef8f4f5ed..8717129a320 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/nosql/Neo4jReactiveTransactionManagerConfiguration.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/nosql/Neo4jReactiveTransactionManagerConfiguration.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.nosql; -// tag::code[] import org.neo4j.driver.Driver; import org.springframework.context.annotation.Bean; @@ -34,4 +33,3 @@ public class Neo4jReactiveTransactionManagerConfiguration { } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/nosql/RedisCacheManagerConfiguration.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/nosql/RedisCacheManagerConfiguration.java index d3b0b978042..8a02a4c6bbb 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/nosql/RedisCacheManagerConfiguration.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/nosql/RedisCacheManagerConfiguration.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.nosql; -// tag::code[] import java.time.Duration; import org.springframework.boot.autoconfigure.cache.RedisCacheManagerBuilderCustomizer; @@ -38,4 +37,3 @@ public class RedisCacheManagerConfiguration { } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/profiles/ProductionConfiguration.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/profiles/ProductionConfiguration.java index 4317d6faf4e..6aa6e6d9f74 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/profiles/ProductionConfiguration.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/profiles/ProductionConfiguration.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.profiles; -//tag::code[] import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Profile; @@ -27,4 +26,3 @@ public class ProductionConfiguration { // ... } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/resttemplate/RestTemplateBuilderConfiguration.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/resttemplate/RestTemplateBuilderConfiguration.java index 7ad9628e7f7..95a823eaea2 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/resttemplate/RestTemplateBuilderConfiguration.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/resttemplate/RestTemplateBuilderConfiguration.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.resttemplate; -// tag::code[] import java.time.Duration; import org.springframework.boot.autoconfigure.web.client.RestTemplateBuilderConfigurer; @@ -34,4 +33,3 @@ public class RestTemplateBuilderConfiguration { } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/resttemplate/RestTemplateProxyCustomizer.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/resttemplate/RestTemplateProxyCustomizer.java index 37a06cb232a..5b219fad689 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/resttemplate/RestTemplateProxyCustomizer.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/resttemplate/RestTemplateProxyCustomizer.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.resttemplate; -// tag::code[] import org.apache.http.HttpException; import org.apache.http.HttpHost; import org.apache.http.HttpRequest; @@ -56,4 +55,3 @@ public class RestTemplateProxyCustomizer implements RestTemplateCustomizer { } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/security/CustomWebFluxSecurityConfiguration.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/security/CustomWebFluxSecurityConfiguration.java index 219e8feb900..6cf1bbe3079 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/security/CustomWebFluxSecurityConfiguration.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/security/CustomWebFluxSecurityConfiguration.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.security; -// tag::code[] import org.springframework.boot.autoconfigure.security.reactive.PathRequest; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @@ -37,4 +36,3 @@ public class CustomWebFluxSecurityConfiguration { } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/ApplicationArgumentsExample.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/ApplicationArgumentsExample.java index 55d895f8262..6ede35e6a48 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/ApplicationArgumentsExample.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/ApplicationArgumentsExample.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.springapplication; -//tag::code[] import java.util.List; import org.springframework.boot.ApplicationArguments; @@ -35,4 +34,3 @@ public class ApplicationArgumentsExample { } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/CommandLineRunnerExample.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/CommandLineRunnerExample.java index e082045d67d..8b90aa635a6 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/CommandLineRunnerExample.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/CommandLineRunnerExample.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.springapplication; -//tag::code[] import org.springframework.boot.CommandLineRunner; import org.springframework.stereotype.Component; @@ -29,4 +28,3 @@ public class CommandLineRunnerExample implements CommandLineRunner { } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/availability/LocalCacheVerifier.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/availability/LocalCacheVerifier.java index 1fd7fbb4064..3d4705c1bd5 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/availability/LocalCacheVerifier.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/availability/LocalCacheVerifier.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.springapplication.availability; -//tag::code[] import org.springframework.boot.availability.AvailabilityChangeEvent; import org.springframework.boot.availability.LivenessState; import org.springframework.context.ApplicationEventPublisher; @@ -41,7 +40,7 @@ public class LocalCacheVerifier { } } -// end::code[] +// @chomp:file class CacheCompletelyBrokenException extends RuntimeException { diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/availability/ReadinessStateExporter.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/availability/ReadinessStateExporter.java index 4b82ecf8d31..cfe80565f50 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/availability/ReadinessStateExporter.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/availability/ReadinessStateExporter.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.springapplication.availability; -// tag::code[] import org.springframework.boot.availability.AvailabilityChangeEvent; import org.springframework.boot.availability.ReadinessState; import org.springframework.context.event.EventListener; @@ -38,4 +37,3 @@ public class ReadinessStateExporter { } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/exitcode/MyApplication.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/exitcode/MyApplication.java index aedb4ff14de..80552fbc289 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/exitcode/MyApplication.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/exitcode/MyApplication.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.springapplication.exitcode; -// tag::code[] import org.springframework.boot.ExitCodeGenerator; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @@ -35,4 +34,3 @@ public class MyApplication { } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/main/custom/MyApplication.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/main/custom/MyApplication.java index 40f8f32e3f9..73f44d07fc4 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/main/custom/MyApplication.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/main/custom/MyApplication.java @@ -23,12 +23,10 @@ import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class MyApplication { - // tag::code[] public static void main(String[] args) { SpringApplication application = new SpringApplication(MyApplication.class); application.setBannerMode(Banner.Mode.OFF); application.run(args); } - // end::code[] } diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/main/run/MyApplication.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/main/run/MyApplication.java index 07d9b0ceffe..c5b47b90787 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/main/run/MyApplication.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/springapplication/main/run/MyApplication.java @@ -22,10 +22,8 @@ import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class MyApplication { - // tag::code[] public static void main(String[] args) { SpringApplication.run(MyApplication.class, args); } - // end::code[] } diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/ApplicationArgumentTests.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/ApplicationArgumentTests.java index 620cbad89ec..7ef7fe6e978 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/ApplicationArgumentTests.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/ApplicationArgumentTests.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.testing; -// tag::code[] import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; @@ -35,4 +34,3 @@ class ApplicationArgumentTests { } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/MockMvcTests.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/MockMvcTests.java index 513a85336d7..2eadc7b1213 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/MockMvcTests.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/MockMvcTests.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.testing; -// tag::code[] import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; @@ -38,4 +37,3 @@ class MockMvcTests { } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/MockWebTestClientTests.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/MockWebTestClientTests.java index 4a1ae58c0fb..1b17c1bc342 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/MockWebTestClientTests.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/MockWebTestClientTests.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.testing; -// tag::code[] import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; @@ -34,4 +33,3 @@ class MockWebTestClientTests { } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/OutputCaptureTests.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/OutputCaptureTests.java index bd5989d9a4e..e5829287740 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/OutputCaptureTests.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/OutputCaptureTests.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.testing; -// tag::code[] import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.ExtendWith; @@ -35,4 +34,3 @@ class OutputCaptureTests { } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/RandomPortTestRestTemplateTests.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/RandomPortTestRestTemplateTests.java index 3ba15b7e1d3..164cd3224fb 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/RandomPortTestRestTemplateTests.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/RandomPortTestRestTemplateTests.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.testing; -// tag::code[] import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; @@ -36,4 +35,3 @@ class RandomPortTestRestTemplateTests { } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/RandomPortWebTestClientTests.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/RandomPortWebTestClientTests.java index 60ff61d2efd..c5c5257374a 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/RandomPortWebTestClientTests.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/RandomPortWebTestClientTests.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.testing; -// tag::code[] import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; @@ -33,4 +32,3 @@ class RandomPortWebTestClientTests { } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/jmx/SampleJmxTests.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/jmx/SampleJmxTests.java index 74e695e3973..e9e899b7249 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/jmx/SampleJmxTests.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/jmx/SampleJmxTests.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.testing.jmx; -// tag::code[] import javax.management.MBeanServer; import javax.management.MalformedObjectNameException; @@ -45,4 +44,3 @@ class SampleJmxTests { } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/restdocs/restassured/AdvancedRestDocsConfiguration.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/restdocs/restassured/AdvancedRestDocsConfiguration.java index 11bd1059067..9ccf6324c71 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/restdocs/restassured/AdvancedRestDocsConfiguration.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/restdocs/restassured/AdvancedRestDocsConfiguration.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.testing.restdocs.restassured; -// tag::code[] import org.springframework.boot.test.autoconfigure.restdocs.RestDocsRestAssuredConfigurationCustomizer; import org.springframework.boot.test.context.TestConfiguration; import org.springframework.restdocs.restassured3.RestAssuredRestDocumentationConfigurer; @@ -31,4 +30,3 @@ public class AdvancedRestDocsConfiguration implements RestDocsRestAssuredConfigu } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/restdocs/restassured/UserDocumentationTests.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/restdocs/restassured/UserDocumentationTests.java index b2e48aac4e5..e0057850093 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/restdocs/restassured/UserDocumentationTests.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/restdocs/restassured/UserDocumentationTests.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.testing.restdocs.restassured; -// tag::code[] import io.restassured.specification.RequestSpecification; import org.junit.jupiter.api.Test; @@ -36,9 +35,15 @@ class UserDocumentationTests { @Test void listUsers(@Autowired RequestSpecification documentationSpec, @LocalServerPort int port) { - given(documentationSpec).filter(document("list-users")).when().port(port).get("/").then().assertThat() - .statusCode(is(200)); + // @formatter:off + given(documentationSpec) + .filter(document("list-users")) + .when() + .port(port) + .get("/") + .then().assertThat() + .statusCode(is(200)); + // @formatter:on } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/restdocs/webclient/AdvancedRestDocsConfiguration.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/restdocs/webclient/AdvancedRestDocsConfiguration.java index 16ca58f2467..f01a5ad2c70 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/restdocs/webclient/AdvancedRestDocsConfiguration.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/restdocs/webclient/AdvancedRestDocsConfiguration.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.testing.restdocs.webclient; -// tag::code[] import org.springframework.boot.test.autoconfigure.restdocs.RestDocsWebTestClientConfigurationCustomizer; import org.springframework.boot.test.context.TestConfiguration; import org.springframework.restdocs.webtestclient.WebTestClientRestDocumentationConfigurer; @@ -30,4 +29,3 @@ public class AdvancedRestDocsConfiguration implements RestDocsWebTestClientConfi } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/restdocs/webclient/UsersDocumentationTests.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/restdocs/webclient/UsersDocumentationTests.java index f6ebbdb3c61..52c96d6c20f 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/restdocs/webclient/UsersDocumentationTests.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/restdocs/webclient/UsersDocumentationTests.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.testing.restdocs.webclient; -// tag::code[] import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; @@ -35,9 +34,15 @@ class UsersDocumentationTests { @Test void listUsers() { - this.webTestClient.get().uri("/").exchange().expectStatus().isOk().expectBody() - .consumeWith(document("list-users")); + // @formatter:off + this.webTestClient + .get().uri("/") + .exchange() + .expectStatus() + .isOk() + .expectBody() + .consumeWith(document("list-users")); + // @formatter:on } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/webclient/SampleWebClientTests.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/webclient/SampleWebClientTests.java index d5535f4cf03..791a9d4b968 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/webclient/SampleWebClientTests.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/testing/webclient/SampleWebClientTests.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.testing.webclient; -// tag::code[] import java.time.Duration; import org.junit.jupiter.api.Test; @@ -56,4 +55,3 @@ class SampleWebClientTests { } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/HttpMessageConvertersConfiguration.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/HttpMessageConvertersConfiguration.java index 84aae404e65..aabc90daa6d 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/HttpMessageConvertersConfiguration.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/HttpMessageConvertersConfiguration.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.webapplications; -//tag::code[] import java.io.IOException; import org.springframework.boot.autoconfigure.http.HttpMessageConverters; @@ -40,7 +39,7 @@ public class HttpMessageConvertersConfiguration { } } -// end::code[] +// @chomp:file class AdditionalHttpMessageConverter extends AbstractHttpMessageConverter { diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/TomcatServerCustomizer.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/TomcatServerCustomizer.java index 49cbd9a0fb1..f1aee4b21ae 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/TomcatServerCustomizer.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/TomcatServerCustomizer.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.webapplications; -// tag::code[] import java.time.Duration; import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory; @@ -32,4 +31,3 @@ public class TomcatServerCustomizer implements WebServerFactoryCustomizer { diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/servlet/ServletFilterConfiguration.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/servlet/ServletFilterConfiguration.java index 9038e56af58..925b053bd5e 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/servlet/ServletFilterConfiguration.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/servlet/ServletFilterConfiguration.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.webapplications.servlet; -//tag::code[] import java.io.IOException; import java.util.EnumSet; @@ -43,7 +42,7 @@ public class ServletFilterConfiguration { } } -// end::code[] +// @chomp:file class MyFilter extends GenericFilterBean { diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/webflux/CodecConfiguration.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/webflux/CodecConfiguration.java index 01e2af66172..2d82419c043 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/webflux/CodecConfiguration.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/webflux/CodecConfiguration.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.webapplications.webflux; -//tag::code[] import org.springframework.boot.web.codec.CodecCustomizer; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @@ -35,4 +34,3 @@ public class CodecConfiguration { } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/webflux/CustomErrorWebExceptionHandler.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/webflux/CustomErrorWebExceptionHandler.java index 525b79acb2c..2c74901152a 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/webflux/CustomErrorWebExceptionHandler.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/webflux/CustomErrorWebExceptionHandler.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.webapplications.webflux; -//tag::code[] import reactor.core.publisher.Mono; import org.springframework.boot.autoconfigure.web.WebProperties.Resources; @@ -56,4 +55,3 @@ public class CustomErrorWebExceptionHandler extends AbstractErrorWebExceptionHan } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/webflux/MyRestController.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/webflux/MyRestController.java index d4b6d528ebf..c20ec7a11a5 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/webflux/MyRestController.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/webflux/MyRestController.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.webapplications.webflux; -//tag::code[] import java.util.List; import reactor.core.publisher.Flux; @@ -58,7 +57,7 @@ public class MyRestController { } } -// end::code[] +// @chomp:file interface UserRepository extends ReactiveCrudRepository { diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/webflux/fn/RoutingConfiguration.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/webflux/fn/RoutingConfiguration.java index 089ee7ac375..7d946f6549e 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/webflux/fn/RoutingConfiguration.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/webflux/fn/RoutingConfiguration.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.webapplications.webflux.fn; -//tag::code[] import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.http.MediaType; @@ -45,4 +44,3 @@ public class RoutingConfiguration { } } -// end::code[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/webflux/fn/UserHandler.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/webflux/fn/UserHandler.java index 8ddd5ef6a7e..c0ddd77ecbd 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/webflux/fn/UserHandler.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/springbootfeatures/webapplications/webflux/fn/UserHandler.java @@ -16,7 +16,6 @@ package org.springframework.boot.docs.springbootfeatures.webapplications.webflux.fn; -//tag::code[] import reactor.core.publisher.Mono; import org.springframework.stereotype.Component; @@ -27,19 +26,15 @@ import org.springframework.web.reactive.function.server.ServerResponse; public class UserHandler { public Mono getUser(ServerRequest request) { - // ... - return ServerResponse.ok().build(); + /**/ return ServerResponse.ok().build(); } public Mono getUserCustomers(ServerRequest request) { - // ... - return ServerResponse.ok().build(); + /**/ return ServerResponse.ok().build(); } public Mono deleteUser(ServerRequest request) { - // ... - return ServerResponse.ok().build(); + /**/ return ServerResponse.ok().build(); } } -// end::code[]