From 0bb1e10a3f33c14d1c7ab43bef98d349e8854ab5 Mon Sep 17 00:00:00 2001 From: Ray Milkey Date: Thu, 10 Nov 2016 14:51:27 -0800 Subject: [PATCH] Javadoc fixes - fix missing Javadoc @param and @throw annotations - enable checkstyle checks for method javadocs on non-private methods Change-Id: I9a370419a699bab3225d85f2f641927600b9f11c --- .../org/onosproject/patchpanel/impl/PatchPanelService.java | 1 + .../org/onosproject/driver/pipeline/Ofdpa2Pipeline.java | 1 + .../drivers/fujitsu/behaviour/VoltFwdlConfig.java | 1 + .../isis/controller/impl/DefaultIsisInterface.java | 3 ++- .../onosproject/isis/controller/impl/LspEventConsumer.java | 3 +-- .../isis/controller/impl/lsdb/DefaultIsisLsdb.java | 5 ++++- .../isis/controller/impl/topology/DefaultIsisRouter.java | 4 +++- .../onosproject/lisp/msg/protocols/LispLocatorRecord.java | 1 + .../org/onosproject/lisp/msg/protocols/LispMapRecord.java | 1 + .../org/onosproject/ospf/controller/area/OspfAreaImpl.java | 4 +++- .../org/onosproject/ospf/controller/impl/OspfNbrImpl.java | 3 ++- .../onosproject/ospf/controller/impl/OspfRouterImpl.java | 6 +++++- .../ospf/protocol/lsa/tlvtypes/OpaqueTopLevelTlvTypes.java | 2 +- .../restconf/RestConfNotificationEventListener.java | 3 +-- .../protocol/restconf/ctl/RestConfSBControllerImpl.java | 6 +++--- tools/build/conf/src/main/resources/onos/checkstyle.xml | 4 +++- tools/build/conf/src/main/resources/onos/suppressions.xml | 7 +++---- utils/misc/src/main/java/org/onlab/packet/IGMPQuery.java | 1 + .../misc/src/main/java/org/onlab/packet/pim/PIMHello.java | 5 +++++ 19 files changed, 42 insertions(+), 19 deletions(-) diff --git a/apps/patchpanel/src/main/java/org/onosproject/patchpanel/impl/PatchPanelService.java b/apps/patchpanel/src/main/java/org/onosproject/patchpanel/impl/PatchPanelService.java index 8c9921f248..affb6a563f 100644 --- a/apps/patchpanel/src/main/java/org/onosproject/patchpanel/impl/PatchPanelService.java +++ b/apps/patchpanel/src/main/java/org/onosproject/patchpanel/impl/PatchPanelService.java @@ -27,6 +27,7 @@ public interface PatchPanelService { * * @param cp the first connect point * @param cp2 the second connect point + * @return true if the patch was created, false otherwise */ boolean addPatch(ConnectPoint cp, ConnectPoint cp2); } diff --git a/drivers/default/src/main/java/org/onosproject/driver/pipeline/Ofdpa2Pipeline.java b/drivers/default/src/main/java/org/onosproject/driver/pipeline/Ofdpa2Pipeline.java index 4600eb8b98..f2fcdab3ac 100644 --- a/drivers/default/src/main/java/org/onosproject/driver/pipeline/Ofdpa2Pipeline.java +++ b/drivers/default/src/main/java/org/onosproject/driver/pipeline/Ofdpa2Pipeline.java @@ -834,6 +834,7 @@ public class Ofdpa2Pipeline extends AbstractHandlerBehaviour implements Pipeline * * @param fwd the forwarding objective * @param allowDefaultRoute allow wildcarded IPv4_DST or not + * @param mplsNextTable next MPLS table * @return A collection of flow rules, or an empty set */ protected Collection processEthTypeSpecificInternal(ForwardingObjective fwd, diff --git a/drivers/fujitsu/src/main/java/org/onosproject/drivers/fujitsu/behaviour/VoltFwdlConfig.java b/drivers/fujitsu/src/main/java/org/onosproject/drivers/fujitsu/behaviour/VoltFwdlConfig.java index 221c5b1f20..baef4d83b7 100644 --- a/drivers/fujitsu/src/main/java/org/onosproject/drivers/fujitsu/behaviour/VoltFwdlConfig.java +++ b/drivers/fujitsu/src/main/java/org/onosproject/drivers/fujitsu/behaviour/VoltFwdlConfig.java @@ -28,6 +28,7 @@ public interface VoltFwdlConfig extends HandlerBehaviour { * Upgrade firmware manually in an ONU in the device. * * @param target input data in string + * @return string representing the reply */ String upgradeFirmwareOndemand(String target); diff --git a/protocols/isis/ctl/src/main/java/org/onosproject/isis/controller/impl/DefaultIsisInterface.java b/protocols/isis/ctl/src/main/java/org/onosproject/isis/controller/impl/DefaultIsisInterface.java index 864b6e5aa3..49bfd74ae9 100644 --- a/protocols/isis/ctl/src/main/java/org/onosproject/isis/controller/impl/DefaultIsisInterface.java +++ b/protocols/isis/ctl/src/main/java/org/onosproject/isis/controller/impl/DefaultIsisInterface.java @@ -512,6 +512,7 @@ public class DefaultIsisInterface implements IsisInterface { * * @param isisMessage received ISIS message * @param isisLsdb ISIS LSDB instance + * @param channel channel */ public void processIsisMessage(IsisMessage isisMessage, IsisLsdb isisLsdb, Channel channel) { log.debug("IsisInterfaceImpl::processIsisMessage...!!!"); @@ -1122,4 +1123,4 @@ public class DefaultIsisInterface implements IsisInterface { exServiceHello.shutdown(); helloSenderStarted = false; } -} \ No newline at end of file +} diff --git a/protocols/isis/ctl/src/main/java/org/onosproject/isis/controller/impl/LspEventConsumer.java b/protocols/isis/ctl/src/main/java/org/onosproject/isis/controller/impl/LspEventConsumer.java index 8730814c4e..590be7b036 100755 --- a/protocols/isis/ctl/src/main/java/org/onosproject/isis/controller/impl/LspEventConsumer.java +++ b/protocols/isis/ctl/src/main/java/org/onosproject/isis/controller/impl/LspEventConsumer.java @@ -230,7 +230,6 @@ public class LspEventConsumer implements Runnable { * * @param localSystemId local system ID * @param remoteSystemId remote system ID - * @return link information * @param interfaceIp interface address * @param neighborIp neighbor address * @param lsPdu link state PDU instance @@ -351,4 +350,4 @@ public class LspEventConsumer implements Runnable { } return isisLinkTed; } -} \ No newline at end of file +} diff --git a/protocols/isis/ctl/src/main/java/org/onosproject/isis/controller/impl/lsdb/DefaultIsisLsdb.java b/protocols/isis/ctl/src/main/java/org/onosproject/isis/controller/impl/lsdb/DefaultIsisLsdb.java index 2062ccc8e3..3be5e896f2 100755 --- a/protocols/isis/ctl/src/main/java/org/onosproject/isis/controller/impl/lsdb/DefaultIsisLsdb.java +++ b/protocols/isis/ctl/src/main/java/org/onosproject/isis/controller/impl/lsdb/DefaultIsisLsdb.java @@ -236,6 +236,9 @@ public class DefaultIsisLsdb implements IsisLsdb { /** * Installs a new self-originated LSP. * + * @param isisMessage ISIS message + * @param isSelfOriginated is the message self originated? + * @param isisInterface ISIS interface * @return true if successfully added */ public boolean addLsp(IsisMessage isisMessage, boolean isSelfOriginated, IsisInterface isisInterface) { @@ -431,4 +434,4 @@ public class DefaultIsisLsdb implements IsisLsdb { log.debug("Added LSp In Blocking queue: {}", lspWrapper); } } -} \ No newline at end of file +} diff --git a/protocols/isis/ctl/src/main/java/org/onosproject/isis/controller/impl/topology/DefaultIsisRouter.java b/protocols/isis/ctl/src/main/java/org/onosproject/isis/controller/impl/topology/DefaultIsisRouter.java index 90bc131d7b..9c459b8003 100644 --- a/protocols/isis/ctl/src/main/java/org/onosproject/isis/controller/impl/topology/DefaultIsisRouter.java +++ b/protocols/isis/ctl/src/main/java/org/onosproject/isis/controller/impl/topology/DefaultIsisRouter.java @@ -42,6 +42,8 @@ public class DefaultIsisRouter implements IsisRouter { /** * Sets IP address of the Router. + * + * @param systemId system identifier of the router */ public void setSystemId(String systemId) { this.systemId = systemId; @@ -129,4 +131,4 @@ public class DefaultIsisRouter implements IsisRouter { public int hashCode() { return Objects.hashCode(systemId, neighborRouterId, interfaceId); } -} \ No newline at end of file +} diff --git a/protocols/lisp/msg/src/main/java/org/onosproject/lisp/msg/protocols/LispLocatorRecord.java b/protocols/lisp/msg/src/main/java/org/onosproject/lisp/msg/protocols/LispLocatorRecord.java index 35aa1dad4f..e96a2afa8b 100644 --- a/protocols/lisp/msg/src/main/java/org/onosproject/lisp/msg/protocols/LispLocatorRecord.java +++ b/protocols/lisp/msg/src/main/java/org/onosproject/lisp/msg/protocols/LispLocatorRecord.java @@ -84,6 +84,7 @@ public interface LispLocatorRecord { * Writes LISP message object into communication channel. * * @param byteBuf byte buffer + * @throws LispWriterException on error */ void writeTo(ByteBuf byteBuf) throws LispWriterException; diff --git a/protocols/lisp/msg/src/main/java/org/onosproject/lisp/msg/protocols/LispMapRecord.java b/protocols/lisp/msg/src/main/java/org/onosproject/lisp/msg/protocols/LispMapRecord.java index d710ebc4f6..ae7cb599ee 100644 --- a/protocols/lisp/msg/src/main/java/org/onosproject/lisp/msg/protocols/LispMapRecord.java +++ b/protocols/lisp/msg/src/main/java/org/onosproject/lisp/msg/protocols/LispMapRecord.java @@ -86,6 +86,7 @@ public interface LispMapRecord { * Writes LISP message object into communication channel. * * @param byteBuf byte buffer + * @throws LispWriterException on error */ void writeTo(ByteBuf byteBuf) throws LispWriterException; diff --git a/protocols/ospf/ctl/src/main/java/org/onosproject/ospf/controller/area/OspfAreaImpl.java b/protocols/ospf/ctl/src/main/java/org/onosproject/ospf/controller/area/OspfAreaImpl.java index 9a7bd47c15..0738787962 100644 --- a/protocols/ospf/ctl/src/main/java/org/onosproject/ospf/controller/area/OspfAreaImpl.java +++ b/protocols/ospf/ctl/src/main/java/org/onosproject/ospf/controller/area/OspfAreaImpl.java @@ -524,6 +524,7 @@ public class OspfAreaImpl implements OspfArea { * * @param ospfLsa OSPF LSA instance * @param ospfInterface OSPF interface instance + * @throws Exception on error */ public void addLsa(OspfLsa ospfLsa, OspfInterface ospfInterface) throws Exception { //second param is false as lsa from network @@ -536,6 +537,7 @@ public class OspfAreaImpl implements OspfArea { * @param ospfLsa OSPF LSA instance * @param isSelfOriginated true if the LSA is self originated. Else false * @param ospfInterface OSPF interface instance + * @throws Exception on error */ public void addLsa(OspfLsa ospfLsa, boolean isSelfOriginated, OspfInterface ospfInterface) throws Exception { @@ -720,4 +722,4 @@ public class OspfAreaImpl implements OspfArea { public OspfLsdb database() { return database; } -} \ No newline at end of file +} diff --git a/protocols/ospf/ctl/src/main/java/org/onosproject/ospf/controller/impl/OspfNbrImpl.java b/protocols/ospf/ctl/src/main/java/org/onosproject/ospf/controller/impl/OspfNbrImpl.java index 800d571b46..f563a39232 100644 --- a/protocols/ospf/ctl/src/main/java/org/onosproject/ospf/controller/impl/OspfNbrImpl.java +++ b/protocols/ospf/ctl/src/main/java/org/onosproject/ospf/controller/impl/OspfNbrImpl.java @@ -556,6 +556,7 @@ public class OspfNbrImpl implements OspfNbr { * In addition, stop the possibly activated re transmission timer. * * @param ch netty channel instance + * @throws Exception on error */ public void badLSReq(Channel ch) throws Exception { log.debug("OSPFNbr::badLSReq...!!!"); @@ -1932,4 +1933,4 @@ public class OspfNbrImpl implements OspfNbr { return lsUpdateList; } } -} \ No newline at end of file +} diff --git a/protocols/ospf/ctl/src/main/java/org/onosproject/ospf/controller/impl/OspfRouterImpl.java b/protocols/ospf/ctl/src/main/java/org/onosproject/ospf/controller/impl/OspfRouterImpl.java index fe0fe32d0e..2d152a106b 100644 --- a/protocols/ospf/ctl/src/main/java/org/onosproject/ospf/controller/impl/OspfRouterImpl.java +++ b/protocols/ospf/ctl/src/main/java/org/onosproject/ospf/controller/impl/OspfRouterImpl.java @@ -44,6 +44,8 @@ public class OspfRouterImpl implements OspfRouter { /** * Sets IP address of the Router. + * + * @param routerIp IP address of the router */ public void setRouterIp(Ip4Address routerIp) { this.routerIp = routerIp; @@ -60,6 +62,8 @@ public class OspfRouterImpl implements OspfRouter { /** * Sets the area id for this device. + * + * @param areaIdOfInterface area identifier for the device */ public void setAreaIdOfInterface(Ip4Address areaIdOfInterface) { this.areaIdOfInterface = areaIdOfInterface; @@ -154,4 +158,4 @@ public class OspfRouterImpl implements OspfRouter { public void setDr(boolean dr) { isDr = dr; } -} \ No newline at end of file +} diff --git a/protocols/ospf/protocol/src/main/java/org/onosproject/ospf/protocol/lsa/tlvtypes/OpaqueTopLevelTlvTypes.java b/protocols/ospf/protocol/src/main/java/org/onosproject/ospf/protocol/lsa/tlvtypes/OpaqueTopLevelTlvTypes.java index ab96e943f9..5ec036dcc0 100644 --- a/protocols/ospf/protocol/src/main/java/org/onosproject/ospf/protocol/lsa/tlvtypes/OpaqueTopLevelTlvTypes.java +++ b/protocols/ospf/protocol/src/main/java/org/onosproject/ospf/protocol/lsa/tlvtypes/OpaqueTopLevelTlvTypes.java @@ -28,7 +28,7 @@ public enum OpaqueTopLevelTlvTypes { /** * Creates an instance of Opaque top level tlv types. * - * @param value + * @param value opaque TLV value */ OpaqueTopLevelTlvTypes(int value) { this.value = value; diff --git a/protocols/restconf/client/api/src/main/java/org/onosproject/protocol/restconf/RestConfNotificationEventListener.java b/protocols/restconf/client/api/src/main/java/org/onosproject/protocol/restconf/RestConfNotificationEventListener.java index dc49a729a8..569a302491 100644 --- a/protocols/restconf/client/api/src/main/java/org/onosproject/protocol/restconf/RestConfNotificationEventListener.java +++ b/protocols/restconf/client/api/src/main/java/org/onosproject/protocol/restconf/RestConfNotificationEventListener.java @@ -25,8 +25,7 @@ public interface RestConfNotificationEventListener { /** * Handles the notification event. * - * @param - * + * @param entity type * @param deviceId of the restconf device * @param eventJsonString the json string representation of the event */ diff --git a/protocols/restconf/client/ctl/src/main/java/org/onosproject/protocol/restconf/ctl/RestConfSBControllerImpl.java b/protocols/restconf/client/ctl/src/main/java/org/onosproject/protocol/restconf/ctl/RestConfSBControllerImpl.java index e5fb37719d..ab6c919f09 100644 --- a/protocols/restconf/client/ctl/src/main/java/org/onosproject/protocol/restconf/ctl/RestConfSBControllerImpl.java +++ b/protocols/restconf/client/ctl/src/main/java/org/onosproject/protocol/restconf/ctl/RestConfSBControllerImpl.java @@ -191,9 +191,9 @@ public class RestConfSBControllerImpl extends HttpSBControllerImpl } /** - * @param request - * @param mediaType - * @param device + * @param request request + * @param mediaType media type + * @param device device identifier */ public GetChunksRunnable(String request, String mediaType, DeviceId device) { diff --git a/tools/build/conf/src/main/resources/onos/checkstyle.xml b/tools/build/conf/src/main/resources/onos/checkstyle.xml index 78110c83db..5d81aa5997 100644 --- a/tools/build/conf/src/main/resources/onos/checkstyle.xml +++ b/tools/build/conf/src/main/resources/onos/checkstyle.xml @@ -132,8 +132,10 @@ - + + + diff --git a/tools/build/conf/src/main/resources/onos/suppressions.xml b/tools/build/conf/src/main/resources/onos/suppressions.xml index 4af0d627b7..3c51c95c81 100644 --- a/tools/build/conf/src/main/resources/onos/suppressions.xml +++ b/tools/build/conf/src/main/resources/onos/suppressions.xml @@ -17,7 +17,6 @@ - @@ -34,13 +33,13 @@ - - - + diff --git a/utils/misc/src/main/java/org/onlab/packet/IGMPQuery.java b/utils/misc/src/main/java/org/onlab/packet/IGMPQuery.java index d79eaec751..273ed25453 100644 --- a/utils/misc/src/main/java/org/onlab/packet/IGMPQuery.java +++ b/utils/misc/src/main/java/org/onlab/packet/IGMPQuery.java @@ -121,6 +121,7 @@ public class IGMPQuery extends IGMPGroup { * * @param bb ByteBuffer pointing at the IGMP Query group address * @return the IGMP Group object + * @throws DeserializationException on serializer error */ public IGMPGroup deserialize(ByteBuffer bb) throws DeserializationException { diff --git a/utils/misc/src/main/java/org/onlab/packet/pim/PIMHello.java b/utils/misc/src/main/java/org/onlab/packet/pim/PIMHello.java index 2f0c3692d9..567a3bd823 100644 --- a/utils/misc/src/main/java/org/onlab/packet/pim/PIMHello.java +++ b/utils/misc/src/main/java/org/onlab/packet/pim/PIMHello.java @@ -91,6 +91,11 @@ public class PIMHello extends BasePacket { /** * XXX: This is deprecated, DO NOT USE, use the deserializer() function instead. + * + * @param data bytes to deserialize + * @param offset offset to start deserializing from + * @param length length of the data to deserialize + * @return nothing */ public IPacket deserialize(final byte[] data, final int offset, final int length) {