Add Some javadoc

eclipse-leshan · Jun 27, 2022 · 71b9997 · 71b9997
1 parent 44bf8b8
commit 71b9997
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/...an-client-cf/src/main/java/org/eclipse/leshan/client/californium/LeshanClientBuilder.java b/...an-client-cf/src/main/java/org/eclipse/leshan/client/californium/LeshanClientBuilder.java
@@ -142,6 +142,11 @@ public LeshanClientBuilder setObjects(List<? extends LwM2mObjectEnabler> objectE
         return this;
     }
 
+    /**
+     * Set the list of {@link DataSender} used by the client.
+     * <p>
+     * Note that each sender should have a different name.
+     */
     public LeshanClientBuilder setDataSenders(DataSender... dataSenders) {
         this.dataSenders = Arrays.asList(dataSenders);
         return this;

diff --git a/leshan-client-core/src/main/java/org/eclipse/leshan/client/datacollector/DataSender.java b/leshan-client-core/src/main/java/org/eclipse/leshan/client/datacollector/DataSender.java
@@ -2,10 +2,17 @@
 
 /**
  * A class responsible for collecting and sending collected data.
+ * <p>
+ * {@link DataSender} are stored in a in {@link DataSenderManager} and can be retrieve by name using
+ * {@link DataSenderManager#getDataSender(String)}.
  */
 public interface DataSender {
     String DEFAULT_NAME = "DEFAULT_DATA_SENDER";
 
+    /**
+     * Set the {@link DataSenderManager} which holds this {@link DataSender}.
+     * <p>
+     */
     void setDataSenderManager(DataSenderManager dataSenderManager);
 
     String getName();