Drop documentation FIXMEs

For an API, sal.connect.api is sorely under-documented. Add FIXMEs to
rememediate this.

Change-Id: Icbd4ff44c276e471af2471f6c297e2a07e3befcd
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>

diff --git a/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/api/NetconfDeviceSchemas.java b/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/api/NetconfDeviceSchemas.java
index 93559339f296baf71228e715f867b02046c9cebb..ee5c3dfba4d1b0880d77a2b686146a7dd8e7b158 100644 (file)
--- a/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/api/NetconfDeviceSchemas.java
+++ b/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/api/NetconfDeviceSchemas.java
@@ -5,13 +5,12 @@
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
-
 package org.opendaylight.netconf.sal.connect.api;
 
 import java.util.Set;
 import org.opendaylight.yangtools.yang.common.QName;
 
 public interface NetconfDeviceSchemas {
-
+    // FIXME: document this method
     Set<QName> getAvailableYangSchemasQNames();
 }

diff --git a/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/api/NetconfDeviceSchemasResolver.java b/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/api/NetconfDeviceSchemasResolver.java
index 297e5183a001f819f952ffeaa749e25d5a550231..42422f11b6291677df8c51cd00446fcb71e9d7fd 100644 (file)
--- a/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/api/NetconfDeviceSchemasResolver.java
+++ b/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/api/NetconfDeviceSchemasResolver.java
@@ -17,7 +17,7 @@ import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  * Factory for netconf device schemas.
  */
 public interface NetconfDeviceSchemasResolver {
-    NetconfDeviceSchemas resolve(
-            NetconfDeviceRpc deviceRpc, NetconfSessionPreferences remoteSessionCapabilities, RemoteDeviceId id,
-            EffectiveModelContext schemaContext);
+    // FIXME: document this method
+    NetconfDeviceSchemas resolve(NetconfDeviceRpc deviceRpc, NetconfSessionPreferences remoteSessionCapabilities,
+        RemoteDeviceId id, EffectiveModelContext schemaContext);
 }

diff --git a/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/api/RemoteDevice.java b/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/api/RemoteDevice.java
index 6cb40237032bae9c9badfa842491f7baf1d5d05c..57628db444eb5997b400506c4e7300aada7a1f63 100644 (file)
--- a/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/api/RemoteDevice.java
+++ b/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/api/RemoteDevice.java
@@ -13,12 +13,15 @@ import org.opendaylight.netconf.api.NetconfMessage;
  * Remote device.
  */
 public interface RemoteDevice<PREF, LISTENER extends RemoteDeviceCommunicator> {
-
+    // FIXME: document this node
     void onRemoteSessionUp(PREF remoteSessionCapabilities, LISTENER listener);
 
+    // FIXME: document this node
     void onRemoteSessionDown();
 
+    // FIXME: document this node
     void onRemoteSessionFailed(Throwable throwable);
 
+    // FIXME: document this node
     void onNotification(NetconfMessage notification);
 }

diff --git a/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/api/RemoteDeviceCommunicator.java b/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/api/RemoteDeviceCommunicator.java
index 116cb293b5f245df03f62d4a4968d94d277c5116..4eefe4cf7746c4849ebe9832c7c996657764ac1e 100644 (file)
--- a/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/api/RemoteDeviceCommunicator.java
+++ b/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/api/RemoteDeviceCommunicator.java
@@ -13,7 +13,7 @@ import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.common.RpcResult;
 
 public interface RemoteDeviceCommunicator extends AutoCloseable {
-
+    // FIXME: document this node
     ListenableFuture<RpcResult<NetconfMessage>> sendRequest(NetconfMessage message, QName rpc);
 
     @Override

diff --git a/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/api/RemoteDeviceHandler.java b/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/api/RemoteDeviceHandler.java
index 960b10301444a18ed2795aacce6b978764e41433..b7c852a51bd9d5da65eda81c8afd2def17166d72 100644 (file)
--- a/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/api/RemoteDeviceHandler.java
+++ b/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/api/RemoteDeviceHandler.java
@@ -44,10 +44,13 @@ public interface RemoteDeviceHandler<PREF> extends AutoCloseable {
         // DO NOTHING
     }
 
+    // FIXME: document this node
     void onDeviceDisconnected();
 
+    // FIXME: document this node
     void onDeviceFailed(Throwable throwable);
 
+    // FIXME: document this node
     void onNotification(DOMNotification domNotification);
 
     @Override