Skip to content
This repository has been archived by the owner on Mar 17, 2023. It is now read-only.

Commit

Permalink
docs: generate docs with latest Quarkus master - quarkusio/quarkus@6a…
Browse files Browse the repository at this point in the history
  • Loading branch information
machi1990 committed Nov 13, 2019
1 parent a6d6386 commit aa357db
Show file tree
Hide file tree
Showing 50 changed files with 1,018 additions and 585 deletions.
622 changes: 417 additions & 205 deletions src/main/asciidoc/generated/all-config.adoc

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Whether we want to use regular JDBC transactions, XA, or disable all transaction
|`enabled`


h|[[quarkus-agroal-config-group-data-source-build-time-config_additional-named-datasources]]link:#quarkus-agroal-config-group-data-source-build-time-config_additional-named-datasources[Additional named datasources]
h|[[quarkus-agroal-config-group-data-source-build-time-config_quarkus.datasource.named-data-sources]]link:#quarkus-agroal-config-group-data-source-build-time-config_quarkus.datasource.named-data-sources[Additional named datasources]
h|Type
h|Default

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,16 @@ Query executed when first using a connection.
|


h|[[quarkus-agroal-config-group-data-source-runtime-config_additional-named-datasources]]link:#quarkus-agroal-config-group-data-source-runtime-config_additional-named-datasources[Additional named datasources]
a|icon:cogs[title=Overridable at runtime] [[quarkus-agroal-config-group-data-source-runtime-config_quarkus.datasource.validation-query-sql]]`link:#quarkus-agroal-config-group-data-source-runtime-config_quarkus.datasource.validation-query-sql[quarkus.datasource.validation-query-sql]`

[.description]
--
Query executed to validate a connection.
--|string
|


h|[[quarkus-agroal-config-group-data-source-runtime-config_quarkus.datasource.named-data-sources]]link:#quarkus-agroal-config-group-data-source-runtime-config_quarkus.datasource.named-data-sources[Additional named datasources]
h|Type
h|Default

Expand Down Expand Up @@ -333,6 +342,15 @@ Query executed when first using a connection.
--|string
|


a|icon:cogs[title=Overridable at runtime] [[quarkus-agroal-config-group-data-source-runtime-config_quarkus.datasource.-datasource-name-.validation-query-sql]]`link:#quarkus-agroal-config-group-data-source-runtime-config_quarkus.datasource.-datasource-name-.validation-query-sql[quarkus.datasource."datasource-name".validation-query-sql]`

[.description]
--
Query executed to validate a connection.
--|string
|

|===
[NOTE]
[[duration-note-anchor]]
Expand All @@ -343,5 +361,5 @@ You can learn more about it in the link:https://docs.oracle.com/javase/8/docs/ap

You can also provide duration values starting with a number.
In this case, if the value consists only of a number, the converter treats the value as seconds.
Otherwise, `PT` is implicitly appended to the value to obtain a standard `java.time.Duration` format.
Otherwise, `PT` is implicitly prepended to the value to obtain a standard `java.time.Duration` format.
====
22 changes: 20 additions & 2 deletions src/main/asciidoc/generated/quarkus-agroal.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,16 @@ Query executed when first using a connection.
|


h|[[quarkus-agroal_additional-named-datasources]]link:#quarkus-agroal_additional-named-datasources[Additional named datasources]
a|icon:cogs[title=Overridable at runtime] [[quarkus-agroal_quarkus.datasource.validation-query-sql]]`link:#quarkus-agroal_quarkus.datasource.validation-query-sql[quarkus.datasource.validation-query-sql]`

[.description]
--
Query executed to validate a connection.
--|string
|


h|[[quarkus-agroal_quarkus.datasource.named-data-sources]]link:#quarkus-agroal_quarkus.datasource.named-data-sources[Additional named datasources]
h|Type
h|Default

Expand Down Expand Up @@ -380,6 +389,15 @@ Query executed when first using a connection.
--|string
|


a|icon:cogs[title=Overridable at runtime] [[quarkus-agroal_quarkus.datasource.-datasource-name-.validation-query-sql]]`link:#quarkus-agroal_quarkus.datasource.-datasource-name-.validation-query-sql[quarkus.datasource."datasource-name".validation-query-sql]`

[.description]
--
Query executed to validate a connection.
--|string
|

|===
[NOTE]
[[duration-note-anchor]]
Expand All @@ -390,5 +408,5 @@ You can learn more about it in the link:https://docs.oracle.com/javase/8/docs/ap

You can also provide duration values starting with a number.
In this case, if the value consists only of a number, the converter treats the value as seconds.
Otherwise, `PT` is implicitly appended to the value to obtain a standard `java.time.Duration` format.
Otherwise, `PT` is implicitly prepended to the value to obtain a standard `java.time.Duration` format.
====
9 changes: 9 additions & 0 deletions src/main/asciidoc/generated/quarkus-arc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,13 @@ If set to true `@Inject` is automatically added to all non-static fields that ar
--|boolean
|`true`


a|icon:archive[title=Fixed at build time] [[quarkus-arc_quarkus.arc.remove-final-for-proxyable-methods]]`link:#quarkus-arc_quarkus.arc.remove-final-for-proxyable-methods[quarkus.arc.remove-final-for-proxyable-methods]`

[.description]
--
If set to true, Arc will transform the bytecode of beans containing methods that need to be proxyable but have been declared as final. The transformation is simply a matter of removing final. This ensures that a proxy can be created properly. If the value is set to false, then an exception is thrown at build time indicating that a proxy could not be created because a method was final.
--|boolean
|`true`

|===
10 changes: 5 additions & 5 deletions src/main/asciidoc/generated/quarkus-core-log-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The default minimum log level
|`INFO`


h|[[quarkus-core-log-config_logging-categories]]link:#quarkus-core-log-config_logging-categories[Logging categories]
h|[[quarkus-core-log-config_quarkus.log.categories]]link:#quarkus-core-log-config_quarkus.log.categories[Logging categories]
h|Type
h|Default

Expand All @@ -50,7 +50,7 @@ The log level level for this category
|`inherit`


h|[[quarkus-core-log-config_console-logging]]link:#quarkus-core-log-config_console-logging[Console logging]
h|[[quarkus-core-log-config_quarkus.log.console]]link:#quarkus-core-log-config_quarkus.log.console[Console logging]
h|Type
h|Default

Expand Down Expand Up @@ -127,7 +127,7 @@ Determine whether to block the publisher (rather than drop the message) when the
|`block`


h|[[quarkus-core-log-config_file-logging]]link:#quarkus-core-log-config_file-logging[File logging]
h|[[quarkus-core-log-config_quarkus.log.file]]link:#quarkus-core-log-config_quarkus.log.file[File logging]
h|Type
h|Default

Expand Down Expand Up @@ -232,7 +232,7 @@ Indicates whether to rotate log files on server initialization.
|`true`


h|[[quarkus-core-log-config_syslog-logging]]link:#quarkus-core-log-config_syslog-logging[Syslog logging]
h|[[quarkus-core-log-config_quarkus.log.syslog]]link:#quarkus-core-log-config_quarkus.log.syslog[Syslog logging]
h|Type
h|Default

Expand Down Expand Up @@ -373,7 +373,7 @@ Determine whether to block the publisher (rather than drop the message) when the
|`block`


h|[[quarkus-core-log-config_log-cleanup-filters-internal-use]]link:#quarkus-core-log-config_log-cleanup-filters-internal-use[Log cleanup filters - internal use]
h|[[quarkus-core-log-config_quarkus.log.filters]]link:#quarkus-core-log-config_quarkus.log.filters[Log cleanup filters - internal use]
h|Type
h|Default

Expand Down
18 changes: 0 additions & 18 deletions src/main/asciidoc/generated/quarkus-core-native-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -126,24 +126,6 @@ If the native image server should be restarted
|`false`


a|icon:archive[title=Fixed at build time] [[quarkus-core-native-config_quarkus.native.enable-retained-heap-reporting]]`link:#quarkus-core-native-config_quarkus.native.enable-retained-heap-reporting[quarkus.native.enable-retained-heap-reporting]`

[.description]
--
This will report on the size of the retained heap after image build
--|boolean
|`false`


a|icon:archive[title=Fixed at build time] [[quarkus-core-native-config_quarkus.native.enable-code-size-reporting]]`link:#quarkus-core-native-config_quarkus.native.enable-code-size-reporting[quarkus.native.enable-code-size-reporting]`

[.description]
--
This enables reporting of the code size of the native image
--|boolean
|`false`


a|icon:archive[title=Fixed at build time] [[quarkus-core-native-config_quarkus.native.enable-isolates]]`link:#quarkus-core-native-config_quarkus.native.enable-isolates[quarkus.native.enable-isolates]`

[.description]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,5 +93,5 @@ You can learn more about it in the link:https://docs.oracle.com/javase/8/docs/ap

You can also provide duration values starting with a number.
In this case, if the value consists only of a number, the converter treats the value as seconds.
Otherwise, `PT` is implicitly appended to the value to obtain a standard `java.time.Duration` format.
Otherwise, `PT` is implicitly prepended to the value to obtain a standard `java.time.Duration` format.
====
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ You can learn more about it in the link:https://docs.oracle.com/javase/8/docs/ap

You can also provide duration values starting with a number.
In this case, if the value consists only of a number, the converter treats the value as seconds.
Otherwise, `PT` is implicitly appended to the value to obtain a standard `java.time.Duration` format.
Otherwise, `PT` is implicitly prepended to the value to obtain a standard `java.time.Duration` format.
====

[NOTE]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ You can learn more about it in the link:https://docs.oracle.com/javase/8/docs/ap

You can also provide duration values starting with a number.
In this case, if the value consists only of a number, the converter treats the value as seconds.
Otherwise, `PT` is implicitly appended to the value to obtain a standard `java.time.Duration` format.
Otherwise, `PT` is implicitly prepended to the value to obtain a standard `java.time.Duration` format.
====

[NOTE]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ You can learn more about it in the link:https://docs.oracle.com/javase/8/docs/ap

You can also provide duration values starting with a number.
In this case, if the value consists only of a number, the converter treats the value as seconds.
Otherwise, `PT` is implicitly appended to the value to obtain a standard `java.time.Duration` format.
Otherwise, `PT` is implicitly prepended to the value to obtain a standard `java.time.Duration` format.
====

[NOTE]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -244,5 +244,5 @@ You can learn more about it in the link:https://docs.oracle.com/javase/8/docs/ap

You can also provide duration values starting with a number.
In this case, if the value consists only of a number, the converter treats the value as seconds.
Otherwise, `PT` is implicitly appended to the value to obtain a standard `java.time.Duration` format.
Otherwise, `PT` is implicitly prepended to the value to obtain a standard `java.time.Duration` format.
====
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
[.configuration-legend]
icon:archive[title=Fixed at build time] Configuration property fixed at build time - icon:cogs[title=Overridable at runtime]️ Configuration property overridable at runtime

[.configuration-reference, cols="80,.^10,.^10"]
|===

h|[[quarkus-dynamodb-config-group-sdk-build-time-config_configuration]]link:#quarkus-dynamodb-config-group-sdk-build-time-config_configuration[Configuration property]
h|Type
h|Default

a|icon:archive[title=Fixed at build time] [[quarkus-dynamodb-config-group-sdk-build-time-config_quarkus.dynamodb.interceptors]]`link:#quarkus-dynamodb-config-group-sdk-build-time-config_quarkus.dynamodb.interceptors[quarkus.dynamodb.interceptors]`

[.description]
--
List of execution interceptors that will have access to read and modify the request and response objects as they are processed by the AWS SDK.
The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface.
--|list of class name
|required icon:exclamation-circle[title=Configuration property is required]

|===
Original file line number Diff line number Diff line change
Expand Up @@ -41,16 +41,6 @@ The amount of time to wait for the HTTP request to complete before giving up and
link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format]
|


a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb-config-group-sdk-config_quarkus.dynamodb.interceptors]]`link:#quarkus-dynamodb-config-group-sdk-config_quarkus.dynamodb.interceptors[quarkus.dynamodb.interceptors]`

[.description]
--
List of execution interceptors that will have access to read and modify the request and response objects as they are processed by the AWS SDK.
The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface.
--|list of class name
|required icon:exclamation-circle[title=Configuration property is required]

|===
[NOTE]
[[duration-note-anchor]]
Expand All @@ -61,5 +51,5 @@ You can learn more about it in the link:https://docs.oracle.com/javase/8/docs/ap

You can also provide duration values starting with a number.
In this case, if the value consists only of a number, the converter treats the value as seconds.
Otherwise, `PT` is implicitly appended to the value to obtain a standard `java.time.Duration` format.
Otherwise, `PT` is implicitly prepended to the value to obtain a standard `java.time.Duration` format.
====
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
[.configuration-legend]
icon:archive[title=Fixed at build time] Configuration property fixed at build time - icon:cogs[title=Overridable at runtime]️ Configuration property overridable at runtime

[.configuration-reference, cols="80,.^10,.^10"]
|===

h|[[quarkus-dynamodb-config-group-sync-http-client-build-time-config_configuration]]link:#quarkus-dynamodb-config-group-sync-http-client-build-time-config_configuration[Configuration property]
h|Type
h|Default

a|icon:archive[title=Fixed at build time] [[quarkus-dynamodb-config-group-sync-http-client-build-time-config_quarkus.dynamodb.sync-client.type]]`link:#quarkus-dynamodb-config-group-sync-http-client-build-time-config_quarkus.dynamodb.sync-client.type[quarkus.dynamodb.sync-client.type]`

[.description]
--
Type of the sync HTTP client implementation
--|`url`, `apache`
|`url`

|===
Original file line number Diff line number Diff line change
Expand Up @@ -195,5 +195,5 @@ You can learn more about it in the link:https://docs.oracle.com/javase/8/docs/ap

You can also provide duration values starting with a number.
In this case, if the value consists only of a number, the converter treats the value as seconds.
Otherwise, `PT` is implicitly appended to the value to obtain a standard `java.time.Duration` format.
Otherwise, `PT` is implicitly prepended to the value to obtain a standard `java.time.Duration` format.
====
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,6 @@ h|[[quarkus-dynamodb-config-group-sync-http-client-config_configuration]]link:#q
h|Type
h|Default

a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb-config-group-sync-http-client-config_quarkus.dynamodb.sync-client.type]]`link:#quarkus-dynamodb-config-group-sync-http-client-config_quarkus.dynamodb.sync-client.type[quarkus.dynamodb.sync-client.type]`

[.description]
--
Type of the sync HTTP client implementation
--|`url`, `apache`
|`url`


a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb-config-group-sync-http-client-config_quarkus.dynamodb.sync-client.connection-timeout]]`link:#quarkus-dynamodb-config-group-sync-http-client-config_quarkus.dynamodb.sync-client.connection-timeout[quarkus.dynamodb.sync-client.connection-timeout]`

[.description]
Expand Down Expand Up @@ -224,5 +215,5 @@ You can learn more about it in the link:https://docs.oracle.com/javase/8/docs/ap

You can also provide duration values starting with a number.
In this case, if the value consists only of a number, the converter treats the value as seconds.
Otherwise, `PT` is implicitly appended to the value to obtain a standard `java.time.Duration` format.
Otherwise, `PT` is implicitly prepended to the value to obtain a standard `java.time.Duration` format.
====
40 changes: 20 additions & 20 deletions src/main/asciidoc/generated/quarkus-dynamodb.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,25 @@ h|[[quarkus-dynamodb_configuration]]link:#quarkus-dynamodb_configuration[Configu
h|Type
h|Default

a|icon:archive[title=Fixed at build time] [[quarkus-dynamodb_quarkus.dynamodb.interceptors]]`link:#quarkus-dynamodb_quarkus.dynamodb.interceptors[quarkus.dynamodb.interceptors]`

[.description]
--
List of execution interceptors that will have access to read and modify the request and response objects as they are processed by the AWS SDK.
The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface.
--|list of class name
|required icon:exclamation-circle[title=Configuration property is required]


a|icon:archive[title=Fixed at build time] [[quarkus-dynamodb_quarkus.dynamodb.sync-client.type]]`link:#quarkus-dynamodb_quarkus.dynamodb.sync-client.type[quarkus.dynamodb.sync-client.type]`

[.description]
--
Type of the sync HTTP client implementation
--|`url`, `apache`
|`url`


a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb_quarkus.dynamodb.enable-endpoint-discovery]]`link:#quarkus-dynamodb_quarkus.dynamodb.enable-endpoint-discovery[quarkus.dynamodb.enable-endpoint-discovery]`

[.description]
Expand Down Expand Up @@ -51,16 +70,6 @@ The amount of time to wait for the HTTP request to complete before giving up and
|


a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb_quarkus.dynamodb.interceptors]]`link:#quarkus-dynamodb_quarkus.dynamodb.interceptors[quarkus.dynamodb.interceptors]`

[.description]
--
List of execution interceptors that will have access to read and modify the request and response objects as they are processed by the AWS SDK.
The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface.
--|list of class name
|required icon:exclamation-circle[title=Configuration property is required]


a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb_quarkus.dynamodb.aws.region]]`link:#quarkus-dynamodb_quarkus.dynamodb.aws.region[quarkus.dynamodb.aws.region]`

[.description]
Expand Down Expand Up @@ -200,15 +209,6 @@ The command that should be executed to retrieve credentials.
|required icon:exclamation-circle[title=Configuration property is required]


a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb_quarkus.dynamodb.sync-client.type]]`link:#quarkus-dynamodb_quarkus.dynamodb.sync-client.type[quarkus.dynamodb.sync-client.type]`

[.description]
--
Type of the sync HTTP client implementation
--|`url`, `apache`
|`url`


a|icon:cogs[title=Overridable at runtime] [[quarkus-dynamodb_quarkus.dynamodb.sync-client.connection-timeout]]`link:#quarkus-dynamodb_quarkus.dynamodb.sync-client.connection-timeout[quarkus.dynamodb.sync-client.connection-timeout]`

[.description]
Expand Down Expand Up @@ -643,7 +643,7 @@ You can learn more about it in the link:https://docs.oracle.com/javase/8/docs/ap

You can also provide duration values starting with a number.
In this case, if the value consists only of a number, the converter treats the value as seconds.
Otherwise, `PT` is implicitly appended to the value to obtain a standard `java.time.Duration` format.
Otherwise, `PT` is implicitly prepended to the value to obtain a standard `java.time.Duration` format.
====

[NOTE]
Expand Down
4 changes: 2 additions & 2 deletions src/main/asciidoc/generated/quarkus-elytron-security.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ icon:archive[title=Fixed at build time] Configuration property fixed at build ti
[.configuration-reference.searchable, cols="80,.^10,.^10"]
|===

h|[[quarkus-elytron-security_property-files-realm-configuration]]link:#quarkus-elytron-security_property-files-realm-configuration[Property Files Realm Configuration]
h|[[quarkus-elytron-security_quarkus.security.users.file]]link:#quarkus-elytron-security_quarkus.security.users.file[Property Files Realm Configuration]
h|Type
h|Default

Expand Down Expand Up @@ -53,7 +53,7 @@ Classpath resource name of properties file containing user to role mappings. See
|`roles.properties`


h|[[quarkus-elytron-security_embedded-realm-configuration]]link:#quarkus-elytron-security_embedded-realm-configuration[Embedded Realm Configuration]
h|[[quarkus-elytron-security_quarkus.security.users.embedded]]link:#quarkus-elytron-security_quarkus.security.users.embedded[Embedded Realm Configuration]
h|Type
h|Default

Expand Down
Loading

0 comments on commit aa357db

Please sign in to comment.