From 1b66165534d5e3fddb8c085e0652d0b853571124 Mon Sep 17 00:00:00 2001 From: Robert Varga Date: Sat, 12 Nov 2022 00:46:39 +0100 Subject: [PATCH] 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 --- .../netconf/sal/connect/api/NetconfDeviceSchemas.java | 3 +-- .../sal/connect/api/NetconfDeviceSchemasResolver.java | 6 +++--- .../opendaylight/netconf/sal/connect/api/RemoteDevice.java | 5 ++++- .../netconf/sal/connect/api/RemoteDeviceCommunicator.java | 2 +- .../netconf/sal/connect/api/RemoteDeviceHandler.java | 3 +++ 5 files changed, 12 insertions(+), 7 deletions(-) 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 93559339f2..ee5c3dfba4 100644 --- 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 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 297e5183a0..42422f11b6 100644 --- 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 6cb4023703..57628db444 100644 --- 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 { - + // 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 116cb293b5..4eefe4cf77 100644 --- 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> 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 960b103014..b7c852a51b 100644 --- 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 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 -- 2.36.6