You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by or...@apache.org on 2024/02/21 14:42:58 UTC
(camel) 10/10: CAMEL-20410: documentation fixes for camel-optaplanner
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 58ec42fcd52b66d42da8859fce8018ab85bc85e6
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Wed Feb 21 15:12:38 2024 +0100
CAMEL-20410: documentation fixes for camel-optaplanner
- Fixed samples
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
- Converted to use tabs
---
.../src/main/docs/optaplanner-component.adoc | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc b/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc
index 80ce9e30cd2..1205c3a47c9 100644
--- a/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc
+++ b/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc
@@ -16,7 +16,7 @@
The Optaplanner component solves the planning problem contained in a
message with http://www.optaplanner.org/[OptaPlanner]. +
- For example: feed it an unsolved Vehicle Routing problem and it solves
+ For example, feed it an unsolved Vehicle Routing problem and it solves
it.
The component supports consumer listening for SloverManager results and
@@ -62,20 +62,20 @@ include::partial$component-endpoint-headers.adoc[]
== Message Body
-Camel takes the planning problem for the IN body, solves it and returns
-it on the OUT body. The IN body object supports the following use cases:
+Camel takes the planning problem for the _IN_ body, solves it and returns
+it on the _OUT_ body. The _IN_ body object supports the following use cases:
-* If the body contains the PlanningSolution annotation, then it will be solved using the
+* If the body contains the `PlanningSolution` annotation, then it will be solved using the
solver identified by solverId and either synchronously or asynchronously.
-* If the body is instance of ProblemChange, then it will trigger
-addProblemFactChange.
+* If the body is an instance of `ProblemChange`, then it will trigger
+`addProblemFactChange`.
* If the body is none of the above types, then the producer will return
-the best result from the solver identified by solverId
+the best result from the solver identified by `solverId`.
=== Samples
-Solve a planning problem that's on the ActiveMQ queue with OptaPlanner, passing the SolverManager:
+Solve a planning problem on the ActiveMQ queue with OptaPlanner, passing the SolverManager:
[source,java]
--------------------------------------------------