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 e4ac04e0d7d21357b8050c590116c3596af467ac Author: Otavio Rodolfo Piske <angusyo...@gmail.com> AuthorDate: Tue Aug 6 14:59:14 2024 +0200 CAMEL-21040: fix typos and grammar issues --- .../camel-attachments/src/main/docs/attachments.adoc | 6 +++--- .../camel-base64/src/main/docs/base64-dataformat.adoc | 10 +++++----- core/camel-base/src/main/docs/properties-component.adoc | 16 ++++++++-------- 3 files changed, 16 insertions(+), 16 deletions(-) diff --git a/components/camel-attachments/src/main/docs/attachments.adoc b/components/camel-attachments/src/main/docs/attachments.adoc index 1563934b9ce..1c552cf1124 100644 --- a/components/camel-attachments/src/main/docs/attachments.adoc +++ b/components/camel-attachments/src/main/docs/attachments.adoc @@ -9,11 +9,11 @@ *Since Camel {since}* -The attachments component provides the `javax.attachments` API support for Apache Camel. +The Attachments component provides the `javax.attachments` API support for Apache Camel. A few Camel component uses attachments such as mail and web-service components. -The attachments component is included automatically when using these components. +The Attachments component is included automatically when using these components. -The attachments support is on Camel `Message` level, for example to get +The Attachments support is on Camel `Message` level, for example to get the `javax.activation.DataHandler` instance of the attachment, you can do as shown below: [source,java] diff --git a/components/camel-base64/src/main/docs/base64-dataformat.adoc b/components/camel-base64/src/main/docs/base64-dataformat.adoc index b6b3e8d00c3..1c91b3df2a5 100644 --- a/components/camel-base64/src/main/docs/base64-dataformat.adoc +++ b/components/camel-base64/src/main/docs/base64-dataformat.adoc @@ -50,7 +50,7 @@ inline as shown below. == Marshal -In this example we marshal the file content to base64 object. +In this example, we marshal the file content to a base64 object. [source,java] ---- @@ -72,8 +72,8 @@ In Spring DSL: == Unmarshal -In this example we unmarshal the payload from the JMS queue to a byte[] -object, before its processed by the newOrder processor. +In this example, we unmarshal the payload from the JMS queue to a byte[] +object, before its processed by the `newOrder` processor. [source,java] ---- @@ -95,10 +95,10 @@ In Spring DSL: == Dependencies -To use Base64 in your Camel routes you need to add a dependency on +To use Base64 in your Camel routes, you need to add a dependency on *camel-base64* which implements this data format. -If you use Maven you can just add the following to your pom.xml: +If you use Maven, you can add the following to your pom.xml: [source,xml] ---- diff --git a/core/camel-base/src/main/docs/properties-component.adoc b/core/camel-base/src/main/docs/properties-component.adoc index a91943e567a..b35fa26d1b5 100644 --- a/core/camel-base/src/main/docs/properties-component.adoc +++ b/core/camel-base/src/main/docs/properties-component.adoc @@ -8,21 +8,21 @@ *Since Camel {since}* -The properties component is used for property placeholders in your Camel application, such as endpoint URIs. +The Properties component is used for property placeholders in your Camel application, such as endpoint URIs. It is *not* a regular Camel component with producer and consumer for routing messages. However, for historical reasons it was named `PropertiesComponent` and this name is commonly known so we keep using it. IMPORTANT: See the xref:manual:ROOT:using-propertyplaceholder.adoc[Property Placeholder] documentation for general information on using property placeholders in Camel. -The properties component requires to load the properties (key=value pairs) from an external source such as `.properties` files. +The Properties component requires to load the properties (key=value pairs) from an external source such as `.properties` files. The component is pluggable, and you can configure to use other sources or write a custom implementation (for example to load from a database). == Defining location of properties files -The properties component needs to know a location(s) where to resolve the properties. -You can define one to many locations. -Multiple locations can be separated by comma such as: +The properties component needs to know the location(s) where to resolve the properties. +You can define one-to-many locations. +You can separate multiple locations by comma, such as: [source,java] ---- @@ -51,9 +51,9 @@ location=file:{{sys:karaf.home}}/etc/foo.properties In the location above we defined a location using the file scheme using the JVM system property with key `karaf.home`. -To use an OS environment variable instead you would have to prefix with +To use an OS environment variable, instead you would have to prefix with `env:`. -You can also prefix with `env.`, however this style is not recommended because all the other functions use colon. +You can also prefix with `env.`, however, this style is not recommended because all the other functions use colon. [source,properties] ---- @@ -97,7 +97,7 @@ Using the `<propertyPlaceholder>` allows to configure this within the `<camelCon </camelContext> ---- -For fine grained configuration of the location, then this can be done as follows: +For fine-grained configuration of the location, then this can be done as follows: [source,xml] ----