Skip to content

Commit 924ea70

Browse files
committed
Polish documentation to use more javadoc links
Update a few areas of the documentation to use full javadoc links. See gh-41614
1 parent 47722af commit 924ea70

File tree

9 files changed

+14
-14
lines changed

9 files changed

+14
-14
lines changed

spring-boot-project/spring-boot-docs/src/docs/antora/modules/build-tool-plugin/pages/other-build-systems.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Various settings can also be configured on the repackager before it is run.
2525
When repackaging an archive, you can include references to dependency files by using the `org.springframework.boot.loader.tools.Libraries` interface.
2626
We do not provide any concrete implementations of `Libraries` here as they are usually build-system-specific.
2727

28-
If your archive already includes libraries, you can use `Libraries.NONE`.
28+
If your archive already includes libraries, you can use javadoc:org.springframework.boot.loader.tools.Libraries#NONE[].
2929

3030

3131

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/webserver.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -441,7 +441,7 @@ server:
441441
filename: "/var/log/jetty-access.log"
442442
----
443443

444-
By default, logs are redirected to `System.err`.
444+
By default, logs are redirected to javadoc:java.lang.System#err[].
445445
For more details, see the Jetty documentation.
446446

447447

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/features/external-config.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Spring Boot uses a very particular `PropertySource` order that is designed to al
1010
Later property sources can override the values defined in earlier ones.
1111
Sources are considered in the following order:
1212

13-
. Default properties (specified by setting `SpringApplication.setDefaultProperties`).
13+
. Default properties (specified by setting javadoc:org.springframework.boot.SpringApplication#setDefaultProperties(java.util.Map)[]).
1414
. javadoc:{url-spring-framework-javadoc}/org.springframework.context.annotation.PropertySource[format=annotation] annotations on your `@Configuration` classes.
1515
Please note that such property sources are not added to the `Environment` until the application context is being refreshed.
1616
This is too late to configure certain properties such as `+logging.*+` and `+spring.main.*+` which are read before refresh begins.

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/features/spring-application.adoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
= SpringApplication
33

44
The `SpringApplication` class provides a convenient way to bootstrap a Spring application that is started from a `main()` method.
5-
In many situations, you can delegate to the static `SpringApplication.run` method, as shown in the following example:
5+
In many situations, you can delegate to the static javadoc:org.springframework.boot.SpringApplication#run(java.lang.Class,java.lang.String...)[] method, as shown in the following example:
66

77
include-code::MyApplication[]
88

@@ -127,7 +127,7 @@ Inside your `banner.txt` file, you can use any key available in the `Environment
127127
TIP: The `SpringApplication.setBanner(...)` method can be used if you want to generate a banner programmatically.
128128
Use the `org.springframework.boot.Banner` interface and implement your own `printBanner()` method.
129129

130-
You can also use the configprop:spring.main.banner-mode[] property to determine if the banner has to be printed on `System.out` (`console`), sent to the configured logger (`log`), or not produced at all (`off`).
130+
You can also use the configprop:spring.main.banner-mode[] property to determine if the banner has to be printed on javadoc:java.lang.System#out[] (`console`), sent to the configured logger (`log`), or not produced at all (`off`).
131131

132132
The printed banner is registered as a singleton bean under the following name: `springBootBanner`.
133133

@@ -260,9 +260,9 @@ Application events are sent in the following order, as your application runs:
260260
. An `ApplicationContextInitializedEvent` is sent when the `ApplicationContext` is prepared and ApplicationContextInitializers have been called but before any bean definitions are loaded.
261261
. An `ApplicationPreparedEvent` is sent just before the refresh is started but after bean definitions have been loaded.
262262
. An `ApplicationStartedEvent` is sent after the context has been refreshed but before any application and command-line runners have been called.
263-
. An `AvailabilityChangeEvent` is sent right after with `LivenessState.CORRECT` to indicate that the application is considered as live.
263+
. An `AvailabilityChangeEvent` is sent right after with javadoc:org.springframework.boot.availability.LivenessState#CORRECT[] to indicate that the application is considered as live.
264264
. An `ApplicationReadyEvent` is sent after any xref:features/spring-application.adoc#features.spring-application.command-line-runner[application and command-line runners] have been called.
265-
. An `AvailabilityChangeEvent` is sent right after with `ReadinessState.ACCEPTING_TRAFFIC` to indicate that the application is ready to service requests.
265+
. An `AvailabilityChangeEvent` is sent right after with javadoc:org.springframework.boot.availability.ReadinessState#ACCEPTING_TRAFFIC[] to indicate that the application is ready to service requests.
266266
. An `ApplicationFailedEvent` is sent if there is an exception on startup.
267267

268268
The above list only includes ``SpringApplicationEvent``s that are tied to a `SpringApplication`.

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/messaging/rsocket.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The required dependencies are provided by the `spring-boot-starter-rsocket`.
3636
Spring Boot allows exposing RSocket over WebSocket from a WebFlux server, or standing up an independent RSocket server.
3737
This depends on the type of application and its configuration.
3838

39-
For WebFlux application (that is of type `WebApplicationType.REACTIVE`), the RSocket server will be plugged into the Web Server only if the following properties match:
39+
For WebFlux application (that is of type javadoc:org.springframework.boot.WebApplicationType#REACTIVE[]), the RSocket server will be plugged into the Web Server only if the following properties match:
4040

4141
[configprops,yaml]
4242
----

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/testing/spring-boot-applications.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,8 @@ For example, the following is a very common code pattern for a typical Spring Bo
8585

8686
include-code::typical/MyApplication[]
8787

88-
In the example above, the `main` method doesn't do anything other than delegate to `SpringApplication.run`.
89-
It is, however, possible to have a more complex `main` method that applies customizations before calling `SpringApplication.run`.
88+
In the example above, the `main` method doesn't do anything other than delegate to javadoc:org.springframework.boot.SpringApplication#run(java.lang.Class,java.lang.String...)[].
89+
It is, however, possible to have a more complex `main` method that applies customizations before calling javadoc:org.springframework.boot.SpringApplication#run(java.lang.Class,java.lang.String...)[].
9090

9191
For example, here is an application that changes the banner mode and sets additional profiles:
9292

@@ -95,7 +95,7 @@ include-code::custom/MyApplication[]
9595
Since customizations in the `main` method can affect the resulting `ApplicationContext`, it's possible that you might also want to use the `main` method to create the `ApplicationContext` used in your tests.
9696
By default, `@SpringBootTest` will not call your `main` method, and instead the class itself is used directly to create the `ApplicationContext`
9797

98-
If you want to change this behavior, you can change the `useMainMethod` attribute of `@SpringBootTest` to `UseMainMethod.ALWAYS` or `UseMainMethod.WHEN_AVAILABLE`.
98+
If you want to change this behavior, you can change the `useMainMethod` attribute of `@SpringBootTest` to javadoc:org.springframework.boot.test.context.SpringBootTest$UseMainMethod#ALWAYS[] or javadoc:org.springframework.boot.test.context.SpringBootTest$UseMainMethod#WHEN_AVAILABLE[].
9999
When set to `ALWAYS`, the test will fail if no `main` method can be found.
100100
When set to `WHEN_AVAILABLE` the `main` method will be used if it is available, otherwise the standard loading mechanism will be used.
101101

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/testing/test-utilities.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ include-code::MyEnvironmentTests[]
3232
[[testing.utilities.output-capture]]
3333
== OutputCaptureExtension
3434

35-
`OutputCaptureExtension` is a JUnit `Extension` that you can use to capture `System.out` and `System.err` output.
35+
`OutputCaptureExtension` is a JUnit `Extension` that you can use to capture javadoc:java.lang.System#out[] and javadoc:java.lang.System#err[] output.
3636
To use it, add `@ExtendWith(OutputCaptureExtension.class)` and inject `CapturedOutput` as an argument to your test class constructor or test method as follows:
3737

3838
include-code::MyOutputCaptureTests[]

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/testing/testcontainers.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ The following service connection factories are provided in the `spring-boot-test
8181
| Containers of type `PulsarContainer`
8282

8383
| `R2dbcConnectionDetails`
84-
| Containers of type `MariaDBContainer`, `MSSQLServerContainer`, `MySQLContainer`, `OracleContainer`, or `PostgreSQLContainer`
84+
| Containers of type `MariaDBContainer`, `MSSQLServerContainer`, `MySQLContainer`, javadoc:{url-testcontainers-oracle-free-javadoc}/org.testcontainers.OracleContainer[OracleContainer (free)], javadoc:{url-testcontainers-oracle-xe-javadoc}/org.testcontainers.oracle.OracleContainer[OracleContainer (XE)] or `PostgreSQLContainer`
8585

8686
| `RabbitConnectionDetails`
8787
| Containers of type `RabbitMQContainer`

spring-boot-project/spring-boot-docs/src/docs/antora/modules/specification/pages/executable-jar/restrictions.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ You need to consider the following restrictions when working with a Spring Boot
77

88
[[appendix.executable-jar-zip-entry-compression]]
99
* Zip entry compression:
10-
The `ZipEntry` for a nested jar must be saved by using the `ZipEntry.STORED` method.
10+
The `ZipEntry` for a nested jar must be saved by using the javadoc:java.util.zip.ZipEntry#STORED[] method.
1111
This is required so that we can seek directly to individual content within the nested jar.
1212
The content of the nested jar file itself can still be compressed, as can any other entry in the outer jar.
1313

0 commit comments

Comments
 (0)