Skip to content

Commit 0a4daf0

Browse files
committed
Merge pull request #2553 from izeye/docs
* docs: Improve documentation
2 parents 2a87971 + 1493da1 commit 0a4daf0

File tree

5 files changed

+23
-22
lines changed

5 files changed

+23
-22
lines changed

spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ content into your application; rather pick only the properties that you need.
9696
spring.mvc.ignore-default-model-on-redirect=true # If the the content of the "default" model should be ignored redirects
9797
spring.view.prefix= # MVC view prefix
9898
spring.view.suffix= # ... and suffix
99+
spring.favicon.enabled=true
99100
100101
# SPRING RESOURCES HANDLING ({sc-spring-boot-autoconfigure}/web/ResourceProperties.{sc-ext}[ResourceProperties])
101102
spring.resources.cache-period= # cache timeouts in headers sent to browser

spring-boot-docs/src/main/asciidoc/howto.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,7 @@ and mark it as disabled. For example:
344344

345345
[source,java,indent=0,subs="verbatim,quotes,attributes"]
346346
----
347-
Bean
347+
@Bean
348348
public FilterRegistrationBean registration(MyFilter filter) {
349349
FilterRegistrationBean registration = new FilterRegistrationBean(filter);
350350
registration.setEnabled(false);

spring-boot-docs/src/main/asciidoc/production-ready-features.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Auditing, health and metrics gathering can be automatically applied to your appl
1212

1313

1414
[[production-ready-enabling]]
15-
== Enabling production-ready features.
15+
== Enabling production-ready features
1616
The {github-code}/spring-boot-actuator[`spring-boot-actuator`] module provides all of
1717
Spring Boot's production-ready features. The simplest way to enable the features is to add
1818
a dependency to the `spring-boot-starter-actuator` '`Starter POM`'.

spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -901,7 +901,7 @@ Depending on your logging system, the following files will be loaded:
901901
|Logging System |Customization
902902

903903
|Logback
904-
|`logback.xml`
904+
|`logback.xml` or `logback.groovy`
905905

906906
|Log4j
907907
|`log4j.properties` or `log4j.xml`
@@ -936,7 +936,7 @@ To help with the customization some other properties are transferred from the Sp
936936
All the logging systems supported can consult System properties when parsing their
937937
configuration files. See the default configurations in `spring-boot.jar` for examples.
938938

939-
WARNING: There are know classloading issues with Java Util Logging that cause problems
939+
WARNING: There are known classloading issues with Java Util Logging that cause problems
940940
when running from an '`executable jar`'. We recommend that you avoid it if at all
941941
possible.
942942

@@ -1004,7 +1004,7 @@ The auto-configuration adds the following features on top of Spring's defaults:
10041004
* Support for serving static resources, including support for WebJars (see below).
10051005
* Automatic registration of `Converter`, `GenericConverter`, `Formatter` beans.
10061006
* Support for `HttpMessageConverters` (see below).
1007-
* Automatic registration of `MessageCodeResolver` (see below)
1007+
* Automatic registration of `MessageCodesResolver` (see below).
10081008
* Static `index.html` support.
10091009
* Custom `Favicon` support.
10101010

@@ -1358,7 +1358,7 @@ If the above customization techniques are too limited, you can register the
13581358
TomcatEmbeddedServletContainerFactory factory = new TomcatEmbeddedServletContainerFactory();
13591359
factory.setPort(9000);
13601360
factory.setSessionTimeout(10, TimeUnit.MINUTES);
1361-
factory.addErrorPages(new ErrorPage(HttpStatus.NOT_FOUND, "/notfound.html");
1361+
factory.addErrorPages(new ErrorPage(HttpStatus.NOT_FOUND, "/notfound.html"));
13621362
return factory;
13631363
}
13641364
----
@@ -1516,9 +1516,9 @@ Production database connections can also be auto-configured using a pooling
15161516

15171517
* We prefer the Tomcat pooling `DataSource` for its performance and concurrency, so if
15181518
that is available we always choose it.
1519-
* If HikariCP is available we will use it
1519+
* If HikariCP is available we will use it.
15201520
* If Commons DBCP is available we will use it, but we don't recommend it in production.
1521-
* Lastly, if Commons DBCP2 is available we will use it
1521+
* Lastly, if Commons DBCP2 is available we will use it.
15221522

15231523
If you use the `spring-boot-starter-jdbc` or `spring-boot-starter-data-jpa`
15241524
'`starter POMs`' you will automatically get a dependency to `tomcat-jdbc`.
@@ -1607,7 +1607,7 @@ relational databases. The `spring-boot-starter-data-jpa` POM provides a quick wa
16071607
started. It provides the following key dependencies:
16081608

16091609
* Hibernate -- One of the most popular JPA implementations.
1610-
* Spring Data JPA -- Makes it easy to easily implement JPA-based repositories.
1610+
* Spring Data JPA -- Makes it easy to implement JPA-based repositories.
16111611
* Spring ORMs -- Core ORM support from the Spring Framework.
16121612

16131613
TIP: We won't go into too many details of JPA or Spring Data here. You can follow the
@@ -1812,7 +1812,7 @@ pooled connection factory by default.
18121812
=== MongoDB
18131813
http://www.mongodb.com/[MongoDB] is an open-source NoSQL document database that uses a
18141814
JSON-like schema instead of traditional table-based relational data. Spring Boot offers
1815-
several conveniences for working with MongoDB, including the The
1815+
several conveniences for working with MongoDB, including the
18161816
`spring-boot-starter-data-mongodb` '`Starter POM`'.
18171817

18181818

@@ -1826,7 +1826,7 @@ using the URL `mongodb://localhost/test`:
18261826
[source,java,indent=0]
18271827
----
18281828
import org.springframework.data.mongodb.MongoDbFactory;
1829-
import import com.mongodb.DB;
1829+
import com.mongodb.DB;
18301830
18311831
@Component
18321832
public class MyBean {
@@ -1864,7 +1864,7 @@ could simply delete this line from the sample above.
18641864
TIP: If you aren't using Spring Data Mongo you can inject `com.mongodb.Mongo` beans
18651865
instead of using `MongoDbFactory`.
18661866

1867-
You can also declare your own `MongoDbFactory` or `Mongo` `@Beans` if you want to take
1867+
You can also declare your own `MongoDbFactory` or `Mongo` bean if you want to take
18681868
complete control of establishing the MongoDB connection.
18691869

18701870

@@ -2084,7 +2084,7 @@ available on the classpath. If the broker is present, an embedded broker is star
20842084
configured automatically (unless the mode property has been explicitly set). The supported
20852085
modes are: `embedded` (to make explicit that an embedded broker is required and should
20862086
lead to an error if the broker is not available in the classpath), and `native` to
2087-
connect to a broker using the the `netty` transport protocol. When the latter is
2087+
connect to a broker using the `netty` transport protocol. When the latter is
20882088
configured, Spring Boot configures a `ConnectionFactory` connecting to a broker running
20892089
on the local machine with the default settings.
20902090

spring-boot-docs/src/main/asciidoc/using-spring-boot.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ defaults. The parent project provides the following features:
4444
http://maven.apache.org/plugins/maven-shade-plugin/[shade]).
4545
* Sensible resource filtering for `application.properties` and `application.yml`
4646

47-
On the last point: since the default config files files accept
47+
On the last point: since the default config files accept
4848
Spring style placeholders (`${...}`) the Maven filtering is changed to
4949
use `@..@` placeholders (you can override that with a Maven property
5050
`resource.delimiter`).
@@ -259,10 +259,10 @@ and Hibernate.
259259
|Support for the Apache Solr search platform, including `spring-data-solr`.
260260

261261
|`spring-boot-starter-freemarker`
262-
|Support for the FreeMarker templating engine
262+
|Support for the FreeMarker templating engine.
263263

264264
|`spring-boot-starter-groovy-templates`
265-
|Support for the Groovy templating engine
265+
|Support for the Groovy templating engine.
266266

267267
|`spring-boot-starter-hateoas`
268268
|Support for HATEOAS-based RESTful services via `spring-hateoas`.
@@ -289,7 +289,7 @@ and Hibernate.
289289
|Support for `javax.mail`.
290290

291291
|`spring-boot-starter-mobile`
292-
|Support for `spring-mobile`
292+
|Support for `spring-mobile`.
293293

294294
|`spring-boot-starter-mustache`
295295
|Support for the Mustache templating engine.
@@ -317,7 +317,7 @@ and Hibernate.
317317
|Support for the Thymeleaf templating engine, including integration with Spring.
318318

319319
|`spring-boot-starter-velocity`
320-
|Support for the Velocity templating engine
320+
|Support for the Velocity templating engine.
321321

322322
|`spring-boot-starter-web`
323323
|Support for full-stack web development, including Tomcat and `spring-webmvc`.
@@ -326,7 +326,7 @@ and Hibernate.
326326
|Support for WebSocket development.
327327

328328
|`spring-boot-starter-ws`
329-
|Support for Spring Web Services
329+
|Support for Spring Web Services.
330330
|===
331331

332332
In addition to the application starters, the following starters can be used to
@@ -351,10 +351,10 @@ swap specific technical facets.
351351
| Name | Description
352352

353353
|`spring-boot-starter-jetty`
354-
|Imports the Jetty HTTP engine (to be used as an alternative to Tomcat)
354+
|Imports the Jetty HTTP engine (to be used as an alternative to Tomcat).
355355

356356
|`spring-boot-starter-log4j`
357-
|Support the Log4J logging framework
357+
|Support the Log4J logging framework.
358358

359359
|`spring-boot-starter-logging`
360360
|Import Spring Boot's default logging framework (Logback).
@@ -363,7 +363,7 @@ swap specific technical facets.
363363
|Import Spring Boot's default HTTP engine (Tomcat).
364364

365365
|`spring-boot-starter-undertow`
366-
|Imports the Undertow HTTP engine (to be used as an alternative to Tomcat)
366+
|Imports the Undertow HTTP engine (to be used as an alternative to Tomcat).
367367
|===
368368

369369
TIP: For a list of additional community contributed starter POMs, see the

0 commit comments

Comments
 (0)