spring-boot/spring-boot-project/spring-boot-docs/src/docs/asciidoc/configuration-metadata.adoc

[appendix]
[[configuration-metadata]]
= Configuration Metadata
include::attributes.adoc[]


Spring Boot jars include metadata files that provide details of all supported configuration properties.
The files are designed to let IDE developers offer contextual help and "`code completion`" as users are working with `application.properties` or `application.yml` files.

The majority of the metadata file is generated automatically at compile time by processing all items annotated with `@ConfigurationProperties`.
However, it is possible to <<configuration-metadata#configuration-metadata.annotation-processor.adding-additional-metadata,write part of the metadata manually>> for corner cases or more advanced use cases.


include::configuration-metadata/format.adoc[]

include::configuration-metadata/manual-hints.adoc[]

include::configuration-metadata/annotation-processor.adoc[]
Document configuration meta-data Add an appendix to the reference documentation describing the format of configuration meta-data and how the annotation processor can be used. Closes gh-1001 2014-11-03 10:03:14 +08:00			`[appendix]`
Split up adoc files Closes gh-23254 2021-04-30 00:11:56 +08:00			`[[configuration-metadata]]`
Split appendices into multiple pages and include a ToC in each Closes gh-16289 2019-09-17 16:44:40 +08:00			`= Configuration Metadata`
Port the build to Gradle Closes gh-19609 Closes gh-19608 2020-01-10 21:48:43 +08:00			`include::attributes.adoc[]`
Import attributes from appendix files See gh-12005 2019-07-02 02:47:12 +08:00
Split up adoc files Closes gh-23254 2021-04-30 00:11:56 +08:00

Reformat documentation to one sentence per line Update reference documentation to use one sentence per line formatting as recommended by the Asciidoctor team. Closes gh-12445 2019-08-28 12:09:28 +08:00			`Spring Boot jars include metadata files that provide details of all supported configuration properties.`
			The files are designed to let IDE developers offer contextual help and "`code completion`" as users are working with `application.properties` or `application.yml` files.
Document configuration meta-data Add an appendix to the reference documentation describing the format of configuration meta-data and how the annotation processor can be used. Closes gh-1001 2014-11-03 10:03:14 +08:00
Reformat documentation to one sentence per line Update reference documentation to use one sentence per line formatting as recommended by the Asciidoctor team. Closes gh-12445 2019-08-28 12:09:28 +08:00			The majority of the metadata file is generated automatically at compile time by processing all items annotated with `@ConfigurationProperties`.
Split up adoc files Closes gh-23254 2021-04-30 00:11:56 +08:00			`However, it is possible to <<configuration-metadata#configuration-metadata.annotation-processor.adding-additional-metadata,write part of the metadata manually>> for corner cases or more advanced use cases.`
Document configuration meta-data Add an appendix to the reference documentation describing the format of configuration meta-data and how the annotation processor can be used. Closes gh-1001 2014-11-03 10:03:14 +08:00


Split up adoc files Closes gh-23254 2021-04-30 00:11:56 +08:00			`include::configuration-metadata/format.adoc[]`
Reformat documentation to one sentence per line Update reference documentation to use one sentence per line formatting as recommended by the Asciidoctor team. Closes gh-12445 2019-08-28 12:09:28 +08:00
Split up adoc files Closes gh-23254 2021-04-30 00:11:56 +08:00			`include::configuration-metadata/manual-hints.adoc[]`
Reformat documentation to one sentence per line Update reference documentation to use one sentence per line formatting as recommended by the Asciidoctor team. Closes gh-12445 2019-08-28 12:09:28 +08:00
Split up adoc files Closes gh-23254 2021-04-30 00:11:56 +08:00			`include::configuration-metadata/annotation-processor.adoc[]`