Fix README for doc generation

Resolves #199
This commit is contained in:
Gary Russell
2019-03-11 13:35:57 -04:00
committed by Oleg Zhurakousky
parent 744c809fee
commit c1d6507957
2 changed files with 23 additions and 3 deletions

View File

@@ -1,4 +1,8 @@
// Do not edit this file (e.g. go instead to src/main/asciidoc)
////
DO NOT EDIT THIS FILE. IT WAS GENERATED.
Manual changes to this file will be lost when it is generated again.
Edit the files in the src/main/asciidoc/ directory instead.
////
:jdkversion: 1.8
:github-tag: master
@@ -155,6 +159,11 @@ Used to create the consumer tag(s); will be appended by `#n` where `n` increment
Example: `${spring.application.name}-${spring.cloud.stream.bindings.input.group}-${spring.cloud.stream.instance-index}`.
+
Default: none - the broker will generate random consumer tags.
containerType::
Select the type of listener container to be used.
See https://docs.spring.io/spring-amqp/reference/html/_reference.html#choose-container[Choosing a Container] in the Spring AMQP documentation for more information.
+
Default: `simple`
deadLetterQueueName::
The name of the DLQ
+
@@ -280,6 +289,7 @@ Consider using a policy instead of this setting, because using a policy allows c
Default: `false`.
maxConcurrency::
The maximum number of consumers.
Not supported when the `containerType` is `direct`.
+
Default: `1`.
maxLength::
@@ -315,6 +325,7 @@ queueDeclarationRetries::
The number of times to retry consuming from a queue if it is missing.
Relevant only when `missingQueuesFatal` is `true`.
Otherwise, the container keeps retrying indefinitely.
Not supported when the `containerType` is `direct`.
+
Default: `3`
queueNameGroupOnly::
@@ -353,6 +364,7 @@ Default time to live to apply to the queue when declared (in milliseconds).
Default: `no limit`
txSize::
The number of deliveries between acks.
Not supported when the `containerType` is `direct`.
+
Default: `1`.
@@ -726,7 +738,11 @@ in Docker containers.
=== Documentation
There is a "full" profile that will generate documentation.
There is a "docs" profile that will generate documentation.
`./mvnw clean package -Pdocs -DskipTests`
The reference documentation can then be found in `docs/target/contents/reference`.
=== Working with the code
If you don't have an IDE preference we would recommend that you use

View File

@@ -40,7 +40,11 @@ in Docker containers.
=== Documentation
There is a "full" profile that will generate documentation.
There is a "docs" profile that will generate documentation.
`./mvnw clean package -Pdocs -DskipTests`
The reference documentation can then be found in `docs/target/contents/reference`.
=== Working with the code
If you don't have an IDE preference we would recommend that you use