This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 2a016634678 Updated docs
2a016634678 is described below
commit 2a0166346788263256a949a3bfbda3888795f1fb
Author: Claus Ibsen <[email protected]>
AuthorDate: Mon Nov 6 10:14:51 2023 +0100
Updated docs
---
.../camel-smb/src/main/docs/smb-component.adoc | 24 +++++++++++++++++++---
1 file changed, 21 insertions(+), 3 deletions(-)
diff --git a/components/camel-smb/src/main/docs/smb-component.adoc
b/components/camel-smb/src/main/docs/smb-component.adoc
index bd0a08a801e..e1b96e01156 100644
--- a/components/camel-smb/src/main/docs/smb-component.adoc
+++ b/components/camel-smb/src/main/docs/smb-component.adoc
@@ -31,9 +31,27 @@ The Server Message Block (SMB) component provides a way to
connect natively to S
smb:address[:port]/shareName[?options]
----
-== Usage
+// component-configure options: START
-For instance, polling all the files from a SMB file share and reading their
contents would look like this:
+// component-configure options: END
+
+// component options: START
+include::partial$component-configure-options.adoc[]
+include::partial$component-endpoint-options.adoc[]
+// component options: END
+
+// endpoint options: START
+
+// endpoint options: END
+
+// component headers: START
+include::partial$component-endpoint-headers.adoc[]
+// component headers: END
+
+
+== Examples
+
+For instance, polling all the files from an SMB file share and reading their
contents would look like this:
[source,java]
----
@@ -53,5 +71,5 @@ public void configure() {
[NOTE]
====
-Beware that the File object provided is not a java.io.File instance, but,
instead a com.hierynomus.smbj.share.File instance.
+Beware that the File object provided is not a `java.io.File` instance, but,
instead a `com.hierynomus.smbj.share.File` instance.
====
