mirror of
https://github.com/opennetworkinglab/onos.git
synced 2025-10-15 17:31:31 +02:00
Javadoc fixes
- fix missing Javadoc @param and @throw annotations - enable checkstyle checks for method javadocs on non-private methods Change-Id: I9a370419a699bab3225d85f2f641927600b9f11c
This commit is contained in:
Ray Milkey
Gerrit Code Review
parent
15079bbc73
commit
0bb1e10a3f
@ -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);
|
||||
}
|
||||
|
||||
@ -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<FlowRule> processEthTypeSpecificInternal(ForwardingObjective fwd,
|
||||
|
||||
@ -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);
|
||||
|
||||
|
||||
@ -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...!!!");
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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) {
|
||||
|
||||
@ -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;
|
||||
|
||||
@ -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;
|
||||
|
||||
|
||||
@ -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;
|
||||
|
||||
|
||||
@ -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 {
|
||||
|
||||
@ -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...!!!");
|
||||
|
||||
@ -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;
|
||||
|
||||
@ -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;
|
||||
|
||||
@ -25,8 +25,7 @@ public interface RestConfNotificationEventListener {
|
||||
/**
|
||||
* Handles the notification event.
|
||||
*
|
||||
* @param <T>
|
||||
*
|
||||
* @param <T> entity type
|
||||
* @param deviceId of the restconf device
|
||||
* @param eventJsonString the json string representation of the event
|
||||
*/
|
||||
|
||||
@ -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) {
|
||||
|
||||
@ -132,8 +132,10 @@
|
||||
<!-- Checks for Javadoc comments. -->
|
||||
<!-- See http://checkstyle.sf.net/config_javadoc.html -->
|
||||
<module name="JavadocMethod">
|
||||
<property name="severity" value="warning"/>
|
||||
<property name="scope" value="package"/>
|
||||
<property name="allowMissingJavadoc" value="true"/>
|
||||
<property name="allowUndeclaredRTE" value="true"/>
|
||||
<property name="suppressLoadErrors" value="true"/>
|
||||
</module>
|
||||
<module name="JavadocType">
|
||||
<property name="severity" value="warning"/>
|
||||
|
||||
@ -17,7 +17,6 @@
|
||||
<!DOCTYPE suppressions PUBLIC "-//Puppy Crawl//DTD Suppressions 1.1//EN" "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
|
||||
|
||||
<suppressions>
|
||||
|
||||
<suppress files="org.apache.karaf.branding.*" checks="[a-zA-Z0-9]*"/>
|
||||
|
||||
<suppress files=".*" checks="FinalParametersCheck"/>
|
||||
@ -34,13 +33,13 @@
|
||||
<suppress files="org.onosproject.segmentrouting.*" checks="AbbreviationAsWordInName" />
|
||||
|
||||
<!-- Suppressions for unit testing code -->
|
||||
<suppress checks="JavadocPackage"
|
||||
<suppress checks="Javadoc.*"
|
||||
files=".*/src/test/.*.java"
|
||||
/>
|
||||
|
||||
<suppress checks="JavadocPackage"
|
||||
<suppress checks="Javadoc.*"
|
||||
files=".*/thirdparty/.*.java"/>
|
||||
|
||||
<!-- Suppressions for yangutils generated code -->
|
||||
<suppress files="org.onosproject.yang.gen.v1.*" checks="JavadocStyle" />
|
||||
<suppress files="org.onosproject.yang.gen.v1.*" checks="Javadoc.*" />
|
||||
</suppressions>
|
||||
|
||||
@ -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 {
|
||||
|
||||
|
||||
@ -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) {
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user