Skip to content

Commit

Permalink
Merge pull request quarkusio#35979 from quarkusio/config-doc-default
Browse files Browse the repository at this point in the history
Add @ConfigDocEnumValue & @ConfigDocDefault to writing-extensions guide
  • Loading branch information
ia3andy authored Sep 19, 2023
2 parents 3bf8a5a + ea3af2f commit a651182
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/src/main/asciidoc/writing-extensions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1316,6 +1316,11 @@ public interface SomeConfig {
}
----
<1> This will generate a configuration map key named `quarkus.some."cache-name"` instead of `quarkus.some."namespace"`.
It is possible to write a textual explanation for the documentation default value, this is useful when it is generated: `@ConfigDocDefault("explain how this is generated")`.
`@ConfigDocEnumValue` gives a way to explicitly customize the string displayed in the documentation when listing accepted values for an enum.
====

===== Writing section documentation
Expand Down

0 comments on commit a651182

Please sign in to comment.