Fix javadocs and enable doclint 83/48683/4
authorRobert Varga <rovarga@cisco.com>
Thu, 24 Nov 2016 22:56:18 +0000 (23:56 +0100)
committerRobert Varga <rovarga@cisco.com>
Fri, 25 Nov 2016 09:18:09 +0000 (10:18 +0100)
This eliminates the doclint suppression and fixes up javadoc, so they
work with Java 8 out of the box.

Change-Id: I7294f0dcd570e3e3c445e54cc8989078175d05d7
Signed-off-by: Robert Varga <rovarga@cisco.com>
122 files changed:
opendaylight/commons/liblldp/pom.xml
opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/BitBufferHelper.java
opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/DataLinkAddress.java
opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/Ethernet.java
opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/EthernetAddress.java
opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/LLDP.java
opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/LLDPTLV.java
opendaylight/commons/liblldp/src/main/java/org/opendaylight/controller/liblldp/Packet.java
opendaylight/commons/protocol-framework/pom.xml
opendaylight/commons/protocol-framework/src/main/java/org/opendaylight/protocol/framework/AbstractDispatcher.java
opendaylight/commons/protocol-framework/src/main/java/org/opendaylight/protocol/framework/AbstractSessionNegotiator.java
opendaylight/commons/protocol-framework/src/main/java/org/opendaylight/protocol/framework/SessionListener.java
opendaylight/commons/protocol-framework/src/main/java/org/opendaylight/protocol/framework/TimedReconnectStrategy.java
opendaylight/config/config-api/pom.xml
opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/ConfigRegistry.java
opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/RuntimeBeanRegistratorAwareModule.java
opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/ServiceReferenceWritableRegistry.java
opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/annotations/RequireInterface.java
opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/jmx/ConfigTransactionControllerMXBean.java
opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/jmx/notifications/ConfigJMXNotification.java
opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/spi/AbstractModule.java
opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/spi/ModuleFactory.java
opendaylight/config/config-manager-facade-xml/src/main/java/org/opendaylight/controller/config/facade/xml/ConfigSubsystemFacade.java
opendaylight/config/config-manager-facade-xml/src/main/java/org/opendaylight/controller/config/facade/xml/mapping/attributes/fromxml/ArrayAttributeReadingStrategy.java
opendaylight/config/config-manager-facade-xml/src/main/java/org/opendaylight/controller/config/facade/xml/mapping/config/Config.java
opendaylight/config/config-manager/src/main/java/org/opendaylight/controller/config/manager/impl/dynamicmbean/DynamicWritableWrapper.java
opendaylight/config/config-manager/src/main/java/org/opendaylight/controller/config/manager/impl/factoriesresolver/ModuleFactoriesResolver.java
opendaylight/config/config-manager/src/main/java/org/opendaylight/controller/config/manager/impl/jmx/ModuleJMXRegistrator.java
opendaylight/config/config-manager/src/main/java/org/opendaylight/controller/config/manager/impl/osgi/ExtensibleBundleTracker.java
opendaylight/config/pom.xml
opendaylight/config/yang-jmx-generator/src/main/java/org/opendaylight/controller/config/yangjmxgenerator/ModuleMXBeanEntry.java
opendaylight/config/yang-jmx-generator/src/main/java/org/opendaylight/controller/config/yangjmxgenerator/PackageTranslator.java
opendaylight/config/yang-jmx-generator/src/main/java/org/opendaylight/controller/config/yangjmxgenerator/ServiceInterfaceEntry.java
opendaylight/config/yang-jmx-generator/src/main/java/org/opendaylight/controller/config/yangjmxgenerator/attribute/AbstractAttribute.java
opendaylight/md-sal/messagebus-spi/pom.xml
opendaylight/md-sal/messagebus-spi/src/main/java/org/opendaylight/controller/messagebus/spi/EventSource.java
opendaylight/md-sal/messagebus-spi/src/main/java/org/opendaylight/controller/messagebus/spi/EventSourceRegistry.java
opendaylight/md-sal/messagebus-util/src/main/java/org/opendaylight/controller/messagebus/app/util/Util.java
opendaylight/md-sal/pom.xml
opendaylight/md-sal/sal-akka-raft-example/src/main/java/org/opendaylight/controller/cluster/example/ExampleRoleChangeListener.java
opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ConfigParams.java
opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/DefaultConfigParamsImpl.java
opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ElectionTerm.java
opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/RaftActor.java
opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/RaftActorLeadershipTransferCohort.java
opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ReplicatedLog.java
opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/AbstractLeader.java
opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/Candidate.java
opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/Follower.java
opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/IsolatedLeader.java
opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/Leader.java
opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/PreLeader.java
opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/client/messages/FindLeader.java
opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/client/messages/FindLeaderReply.java
opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/policy/RaftPolicy.java
opendaylight/md-sal/sal-binding-api/pom.xml
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/ClusteredDataChangeListener.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/DataObjectModification.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/DataTreeChangeService.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/DataTreeIdentifier.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/NotificationPublishService.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/NotificationService.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/AbstractBrokerAwareActivator.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareBroker.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareConsumer.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/BindingAwareProvider.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/NotificationService.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcConsumerRegistry.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/RpcProviderRegistry.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/data/DataBrokerService.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/data/DataModificationTransaction.java
opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/data/SynchronizedTransaction.java
opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/common/actor/MessageTracker.java
opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/common/actor/MeteringBehavior.java
opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/common/actor/UnifiedConfig.java
opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/notifications/RoleChangeNotifier.java
opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/raft/protobuff/client/messages/Payload.java
opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/reporting/MetricsReporter.java
opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/clustering/Entity.java
opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncConfigurationCommitHandler.java
opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncDataBroker.java
opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncDataChangeListener.java
opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncReadTransaction.java
opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncWriteTransaction.java
opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/DataModification.java
opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/TransactionChain.java
opendaylight/md-sal/sal-common-util/src/main/java/org/opendaylight/controller/md/sal/common/util/jmx/QueuedNotificationManagerMXBean.java
opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/DataChangeListener.java
opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/Shard.java
opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ShardDataTree.java
opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionContext.java
opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionReadyReplyMapper.java
opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/messages/DataTreeChanged.java
opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/messages/FindLocalShard.java
opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/messages/LocalShardFound.java
opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/messages/LocalShardNotFound.java
opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/modification/Modification.java
opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/persisted/PayloadVersion.java
opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/persisted/ShardDataTreeSnapshotMetadata.java
opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/shardstrategy/ShardStrategy.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeListener.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducer.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeProducerFactory.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataTreeService.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataWriteTransaction.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMExtensibleService.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMNotificationPublishService.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMNotificationRejectedException.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMNotificationService.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMRpcService.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/sal/core/api/Consumer.java
opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/sal/core/api/Provider.java
opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/AbstractDOMForwardedTransactionFactory.java
opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/AbstractDOMStoreTransaction.java
opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/DOMStoreThreePhaseCommitCohort.java
opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/DOMStoreWriteTransaction.java
opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/SnapshotBackedReadTransaction.java
opendaylight/md-sal/sal-dom-spi/src/main/java/org/opendaylight/controller/sal/core/spi/data/SnapshotBackedWriteTransaction.java
opendaylight/md-sal/sal-remoterpc-connector/pom.xml
opendaylight/md-sal/sal-remoterpc-connector/src/main/java/org/opendaylight/controller/remote/rpc/registry/RpcRegistry.java
opendaylight/md-sal/sal-remoterpc-connector/src/main/java/org/opendaylight/controller/remote/rpc/registry/gossip/Gossiper.java
pom.xml

index edfc553..62a21f2 100644 (file)
     </plugins>
   </build>
 
-  <profiles>
-    <!-- Turn off doclint on aggregated API javadoc build. -->
-    <profile>
-      <id>jdk8</id>
-      <activation>
-        <jdk>[1.8,)</jdk>
-      </activation>
-
-      <build>
-        <plugins>
-          <plugin>
-            <groupId>org.apache.maven.plugins</groupId>
-            <artifactId>maven-javadoc-plugin</artifactId>
-            <configuration>
-              <additionalparam>-Xdoclint:none</additionalparam>
-            </configuration>
-          </plugin>
-        </plugins>
-      </build>
-    </profile>
-  </profiles>
-
   <scm>
     <connection>scm:git:http://git.opendaylight.org/gerrit/controller.git</connection>
     <developerConnection>scm:git:ssh://git.opendaylight.org:29418/controller.git</developerConnection>
index c1d2bef..fd06599 100644 (file)
@@ -37,7 +37,6 @@ public abstract class BitBufferHelper {
 
     /**
      * Returns the first byte from the byte array
-     * @param byte[] data
      * @return byte value
      */
     public static byte getByte(byte[] data) {
@@ -55,7 +54,6 @@ public abstract class BitBufferHelper {
     /**
      * Returns the short value for the byte array passed.
      * Size of byte array is restricted to Short.SIZE
-     * @param byte[] data
      * @return short value
      */
     public static short getShort(byte[] data) {
@@ -73,7 +71,6 @@ public abstract class BitBufferHelper {
     /**
      * Returns the int value for the byte array passed.
      * Size of byte array is restricted to Integer.SIZE
-     * @param byte[] data
      * @return int - the integer value of byte array
      */
     public static int getInt(byte[] data) {
@@ -91,7 +88,6 @@ public abstract class BitBufferHelper {
     /**
      * Returns the long value for the byte array passed.
      * Size of byte array is restricted to Long.SIZE
-     * @param byte[] data
      * @return long - the integer value of byte array
      */
     public static long getLong(byte[] data) {
@@ -109,8 +105,6 @@ public abstract class BitBufferHelper {
     /**
      * Returns the short value for the last numBits of the byte array passed.
      * Size of numBits is restricted to Short.SIZE
-     * @param byte[] data
-     * @param int - numBits
      * @return short - the short value of byte array
      */
     public static short getShort(byte[] data, int numBits) {
@@ -135,8 +129,6 @@ public abstract class BitBufferHelper {
     /**
      * Returns the int value for the last numBits of the byte array passed.
      * Size of numBits is restricted to Integer.SIZE
-     * @param byte[] data
-     * @param int - numBits
      * @return int - the integer value of byte array
      */
     public static int getInt(byte[] data, int numBits) {
@@ -161,8 +153,6 @@ public abstract class BitBufferHelper {
     /**
      * Returns the long value for the last numBits of the byte array passed.
      * Size of numBits is restricted to Long.SIZE
-     * @param byte[] data
-     * @param int - numBits
      * @return long - the integer value of byte array
      */
     public static long getLong(byte[] data, int numBits) {
@@ -205,9 +195,8 @@ public abstract class BitBufferHelper {
      * 0101000010 | 0000101 | 1111001010010101011
      * will be returned as {0,0,0,0,0,1,0,1}
      *
-     * @param byte[] data
-     * @param int startOffset - offset to start fetching bits from data from
-     * @param int numBits - number of bits to be fetched from data
+     * @param startOffset - offset to start fetching bits from data from
+     * @param numBits - number of bits to be fetched from data
      * @return byte [] - LSB aligned bits
      *
      * @throws BufferException
@@ -286,10 +275,10 @@ public abstract class BitBufferHelper {
 
     /**
      * Bits are expected to be stored in the input byte array from LSB
-     * @param byte[] - data to set the input byte
-     * @param byte - input byte to be inserted
-     * @param startOffset offset of data[] to start inserting byte from
-     * @param numBits number of bits of input to be inserted into data[]
+     * @param data to set the input byte
+     * @param input byte to be inserted
+     * @param startOffset offset of data[] to start inserting byte from
+     * @param numBits number of bits of input to be inserted into data[]
      *
      * @throws BufferException
      *             when the input, startOffset and numBits are not congruent
@@ -304,11 +293,10 @@ public abstract class BitBufferHelper {
 
     /**
      * Bits are expected to be stored in the input byte array from LSB
-     * @param byte[] - data to set the input byte
-     * @param byte[] - input bytes to be inserted
-     * @param startOffset - offset of data[] to start inserting byte from
-     * @param numBits - number of bits of input to be inserted into data[]
-     * @return void
+     * @param data to set the input byte
+     * @param input bytes to be inserted
+     * @param startOffset offset of data[] to start inserting byte from
+     * @param numBits number of bits of input to be inserted into data[]
      * @throws BufferException
      *             when the startOffset and numBits parameters are not congruent
      *             with data and input buffers' size
@@ -321,9 +309,6 @@ public abstract class BitBufferHelper {
 
     /**
      * Returns numBits 1's in the MSB position
-     *
-     * @param numBits
-     * @return
      */
     public static int getMSBMask(int numBits) {
         int mask = 0;
@@ -335,9 +320,6 @@ public abstract class BitBufferHelper {
 
     /**
      * Returns numBits 1's in the LSB position
-     *
-     * @param numBits
-     * @return
      */
     public static int getLSBMask(int numBits) {
         int mask = 0;
@@ -350,7 +332,6 @@ public abstract class BitBufferHelper {
     /**
      * Returns the numerical value of the byte array passed
      *
-     * @param byte[] - array
      * @return long - numerical value of byte array passed
      */
     static public long toNumber(byte[] array) {
@@ -372,8 +353,6 @@ public abstract class BitBufferHelper {
      * Returns the numerical value of the last numBits (LSB bits) of the byte
      * array passed
      *
-     * @param byte[] - array
-     * @param int - numBits
      * @return long - numerical value of byte array passed
      */
     static public long toNumber(byte[] array, int numBits) {
@@ -405,12 +384,7 @@ public abstract class BitBufferHelper {
      * Accepts a number as input and returns its value in byte form in LSB
      * aligned form example: input = 5000 [1001110001000] bytes = 19, -120
      * [00010011] [10001000]
-     *
-     * @param Number
-     * @return byte[]
-     *
      */
-
     public static byte[] toByteArray(Number input) {
         Class<? extends Number> dataType = input.getClass();
         short size = 0;
@@ -445,9 +419,7 @@ public abstract class BitBufferHelper {
      * aligned form example: input = 5000 [1001110001000] bytes = -114, 64
      * [10011100] [01000000]
      *
-     * @param Number
-     *            input
-     * @param int numBits - the number of bits to be returned
+     * @param numBits - the number of bits to be returned
      * @return byte[]
      *
      */
@@ -500,21 +472,15 @@ public abstract class BitBufferHelper {
 
     /**
      * Takes an LSB aligned byte array and returned the LSB numBits in a MSB
-     * aligned byte array
-     *
-     * @param inputbytes
-     * @param numBits
-     * @return
-     */
-    /**
+     * aligned byte array.
+     * <p>
      * It aligns the last numBits bits to the head of the byte array following
      * them with numBits % 8 zero bits.
      *
      * Example: For inputbytes = [00000111][01110001] and numBits = 12 it
      * returns: shiftedBytes = [01110111][00010000]
      *
-     * @param byte[] inputBytes
-     * @param int numBits - number of bits to be left aligned
+     * @param numBits - number of bits to be left aligned
      * @return byte[]
      */
     public static byte[] shiftBitsToMSB(byte[] inputBytes, int numBits) {
@@ -571,8 +537,8 @@ public abstract class BitBufferHelper {
      * Example: For inputbytes = [01110111][00010000] and numBits = 12 it
      * returns: shiftedBytes = [00000111][01110001]
      *
-     * @param byte[] inputBytes
-     * @param int numBits - number of bits to be right aligned
+     * @param inputBytes
+     * @param numBits - number of bits to be right aligned
      * @return byte[]
      */
     public static byte[] shiftBitsToLSB(byte[] inputBytes, int numBits) {
@@ -604,11 +570,6 @@ public abstract class BitBufferHelper {
      * Insert in the data buffer at position dictated by the offset the number
      * of bits specified from the input data byte array. The input byte array
      * has the bits stored starting from the LSB
-     *
-     * @param byte[] data
-     * @param byte[] inputdata
-     * @param int startOffset
-     * @param int numBits
      */
     public static void insertBits(byte[] data, byte[] inputdataLSB,
             int startOffset, int numBits) {
@@ -690,10 +651,7 @@ public abstract class BitBufferHelper {
 
     /**
      * Checks for overflow and underflow exceptions
-     * @param data
-     * @param startOffset
-     * @param numBits
-     * @throws PacketException when the startOffset and numBits parameters
+     * @throws BufferException when the startOffset and numBits parameters
      *                    are not congruent with the data buffer's size
      */
     public static void checkExceptions(byte[] data, int startOffset, int numBits)
index de9f4ec..2649489 100644 (file)
@@ -37,8 +37,6 @@ abstract public class DataLinkAddress implements Serializable {
      *
      * @param name Create a new DataLink, not for general use but
      * available only for sub classes
-     *
-     * @return constructed object
      */
     protected DataLinkAddress(String name) {
         this.name = name;
index c2d9e70..424bdd0 100644 (file)
@@ -104,7 +104,7 @@ public class Ethernet extends Packet {
 
     /**
      * Sets the destination MAC address for the current Ethernet object instance
-     * @param byte[] - the destinationMACAddress to set
+     * @param destinationMACAddress the destinationMACAddress to set
      */
     public Ethernet setDestinationMACAddress(byte[] destinationMACAddress) {
         fieldValues.put(DMAC, destinationMACAddress);
@@ -113,7 +113,7 @@ public class Ethernet extends Packet {
 
     /**
      * Sets the source MAC address for the current Ethernet object instance
-     * @param byte[] - the sourceMACAddress to set
+     * @param sourceMACAddress the sourceMACAddress to set
      */
     public Ethernet setSourceMACAddress(byte[] sourceMACAddress) {
         fieldValues.put(SMAC, sourceMACAddress);
@@ -122,7 +122,7 @@ public class Ethernet extends Packet {
 
     /**
      * Sets the etherType for the current Ethernet object instance
-     * @param short - the etherType to set
+     * @param etherType the etherType to set
      */
     public Ethernet setEtherType(short etherType) {
         byte[] ethType = BitBufferHelper.toByteArray(etherType);
index a3f8d50..947603c 100644 (file)
@@ -52,8 +52,6 @@ public class EthernetAddress extends DataLinkAddress {
      *
      * @param macAddress A byte array in big endian format
      * representing the Ethernet MAC Address
-     *
-     * @return The constructed object if valid
      */
     public EthernetAddress(byte[] macAddress) throws ConstructionException {
         super(addressName);
index 15dced5..bbee859 100644 (file)
@@ -90,7 +90,7 @@ public class LLDP extends Packet {
     }
 
     /**
-     * @param String
+     * @param type
      *            - description of the type of TLV
      * @return LLDPTLV - full TLV
      */
@@ -103,11 +103,10 @@ public class LLDP extends Packet {
     }
 
     /**
-     * @param String
+     * @param type
      *            - description of the type of TLV
-     * @param LLDPTLV
+     * @param tlv
      *            - tlv to set
-     * @return void
      */
     public void setTLV(String type, LLDPTLV tlv) {
         putToTLVs(getType(type), tlv);
@@ -121,7 +120,7 @@ public class LLDP extends Packet {
     }
 
     /**
-     * @param LLDPTLV
+     * @param chassisId
      *            - the chassisId to set
      */
     public LLDP setChassisId(LLDPTLV chassisId) {
@@ -137,8 +136,8 @@ public class LLDP extends Packet {
     }
 
     /**
-     * @param LLDPTLV
-     *            - the chassisId to set
+     * @param systemNameId
+     *            - the systemNameId to set
      */
     public LLDP setSystemNameId(LLDPTLV systemNameId) {
         setTLV(SYSTEMNAMEID, systemNameId);
@@ -153,7 +152,7 @@ public class LLDP extends Packet {
     }
 
     /**
-     * @param LLDPTLV
+     * @param portId
      *            - the portId to set
      * @return LLDP
      */
@@ -170,7 +169,7 @@ public class LLDP extends Packet {
     }
 
     /**
-     * @param LLDPTLV
+     * @param ttl
      *            - the ttl to set
      * @return LLDP
      */
@@ -206,7 +205,7 @@ public class LLDP extends Packet {
     }
 
     /**
-     * @param customTLVList
+     * @param customTLV
      *            the list of custom TLVs to set
      * @return this LLDP
      */
index 3c56234..bc24192 100644 (file)
@@ -121,7 +121,7 @@ public class LLDPTLV extends Packet {
     }
 
     /**
-     * @param byte - the type to set
+     * @param type the type to set
      * @return LLDPTLV
      */
     public LLDPTLV setType(byte type) {
@@ -131,7 +131,7 @@ public class LLDPTLV extends Packet {
     }
 
     /**
-     * @param short - the length to set
+     * @param length the length to set
      * @return LLDPTLV
      */
     public LLDPTLV setLength(short length) {
@@ -140,7 +140,7 @@ public class LLDPTLV extends Packet {
     }
 
     /**
-     * @param byte[] - the value to set
+     * @param value the value to set
      * @return LLDPTLV
      */
     public LLDPTLV setValue(byte[] value) {
@@ -266,10 +266,10 @@ public class LLDPTLV extends Packet {
     /**
      * Creates the custom TLV value including OUI, subtype and custom string
      *
-     * @param portId
+     * @param customString
      *            port identifier string
      * @return the custom TLV value in byte array
-     * @see {@link #createCustomTLVValue(byte,String)}
+     * @see #createCustomTLVValue(byte[],byte[])
      */
     static public byte[] createCustomTLVValue(String customString) {
         byte[] customByteArray = customString.getBytes(Charset.defaultCharset());
@@ -279,7 +279,7 @@ public class LLDPTLV extends Packet {
     /**
      * Creates the custom TLV value including OUI, subtype and custom string
      * @param subtype openflow subtype
-     * @param portId
+     * @param customByteArray
      *            port identifier string
      * @return the custom TLV value in byte array
      */
index 59a7863..8a4fa36 100644 (file)
@@ -76,10 +76,10 @@ public abstract class Packet {
      * This method deserializes the data bits obtained from the wire into the
      * respective header and payload which are of type Packet
      *
-     * @param byte[] data - data from wire to deserialize
-     * @param int bitOffset bit position where packet header starts in data
+     * @param data - data from wire to deserialize
+     * @param bitOffset bit position where packet header starts in data
      *        array
-     * @param int size of packet in bits
+     * @param size size of packet in bits
      * @return Packet
      * @throws PacketException
      */
@@ -205,7 +205,7 @@ public abstract class Packet {
      * normal Packet.serialize() path. An example is the checksum computation
      * for IPv4
      *
-     * @param byte[] - serialized bytes
+     * @param myBytes serialized bytes
      * @throws PacketException
      */
     protected void postSerializeCustomOperation(byte[] myBytes)
@@ -220,8 +220,8 @@ public abstract class Packet {
      * Currently only IPv4 and ICMP do checksum computation and validation. TCP
      * and UDP need to implement these if required.
      *
-     * @param byte[] data The byte stream representing the Ethernet frame
-     * @param int startBitOffset The bit offset from where the byte array corresponding to this Packet starts in the frame
+     * @param data The byte stream representing the Ethernet frame
+     * @param startBitOffset The bit offset from where the byte array corresponding to this Packet starts in the frame
      * @throws PacketException
      */
     protected void postDeserializeCustomOperation(byte[] data, int startBitOffset)
@@ -255,8 +255,6 @@ public abstract class Packet {
      * 'fieldname'. The offset is present in the hdrFieldCoordMap of the
      * respective packet class
      *
-     * @param String
-     *            fieldName
      * @return Integer - startOffset of the requested field
      */
     public int getfieldOffset(String fieldName) {
@@ -268,8 +266,6 @@ public abstract class Packet {
      * 'fieldname'. The numBits are present in the hdrFieldCoordMap of the
      * respective packet class
      *
-     * @param String
-     *            fieldName
      * @return Integer - number of bits of the requested field
      */
     public int getfieldnumBits(String fieldName) {
index b97be83..e6029f7 100644 (file)
     </plugins>
   </build>
 
-  <profiles>
-    <!-- Turn off doclint. -->
-    <profile>
-      <id>jdk8</id>
-      <activation>
-        <jdk>[1.8,)</jdk>
-      </activation>
-      <build>
-        <plugins>
-          <plugin>
-            <groupId>org.apache.maven.plugins</groupId>
-            <artifactId>maven-javadoc-plugin</artifactId>
-            <configuration>
-              <additionalparam>-Xdoclint:none</additionalparam>
-            </configuration>
-          </plugin>
-        </plugins>
-      </build>
-    </profile>
-  </profiles>
-
   <scm>
     <connection>scm:git:http://git.opendaylight.org/gerrit/controller.git</connection>
     <developerConnection>scm:git:ssh://git.opendaylight.org:29418/controller.git</developerConnection>
index 334ccc2..e153861 100644 (file)
@@ -147,7 +147,7 @@ public abstract class AbstractDispatcher<S extends ProtocolSession<?>, L extends
      * Creates a client.
      *
      * @param address remote address
-     * @param connectStrategy Reconnection strategy to be used when initial connection fails
+     * @param strategy Reconnection strategy to be used when initial connection fails
      *
      * @return Future representing the connection process. Its result represents the combined success of TCP connection
      *         as well as session negotiation.
@@ -266,7 +266,7 @@ public abstract class AbstractDispatcher<S extends ProtocolSession<?>, L extends
     }
 
     /**
-     * @deprecated Should only be used with {@link AbstractDispatcher#AbstractDispatcher()}
+     * @deprecated Should only be used with AbstractDispatcher#AbstractDispatcher()
      */
     @Deprecated
     @Override
index 8a19828..ddd10d2 100644 (file)
@@ -25,7 +25,7 @@ import com.google.common.base.Preconditions;
  * needing to provide only
  *
  * @param <M> Protocol message type
- * @param <S> Protocol session type, has to extend ProtocolSession<M>
+ * @param <S> Protocol session type, has to extend {@code ProtocolSession<M>}
  */
 @Deprecated
 public abstract class AbstractSessionNegotiator<M, S extends AbstractProtocolSession<?>> extends ChannelInboundHandlerAdapter implements SessionNegotiator<S> {
index dfe0208..06b2730 100644 (file)
@@ -19,7 +19,7 @@ public interface SessionListener<M, S extends ProtocolSession<?>, T extends Term
     /**
      * Fired when the session was established successfully.
      *
-     * @param remoteParams Peer address families which we accepted
+     * @param session New session
      */
     void onSessionUp(S session);
 
index ecb9e65..ed60abb 100644 (file)
@@ -29,7 +29,7 @@ import com.google.common.base.Preconditions;
  *
  * Initial sleep time is specified as minSleep. Each subsequent unsuccessful attempt multiplies this time by a constant
  * factor (sleepFactor) -- this allows for either constant reconnect times (sleepFactor = 1), or various degrees of
- * exponential back-off (sleepFactor > 1). Maximum sleep time between attempts can be capped to a specific value
+ * exponential back-off (sleepFactor &gt; 1). Maximum sleep time between attempts can be capped to a specific value
  * (maxSleep).
  *
  * The strategy can optionally give up based on two criteria:
index 74c384d..bc438e6 100644 (file)
       </plugin>
     </plugins>
   </build>
-
-  <profiles>
-    <!-- Turn off doclint on aggregated API javadoc build. -->
-    <profile>
-      <id>jdk8</id>
-      <activation>
-        <jdk>[1.8,)</jdk>
-      </activation>
-
-      <build>
-        <plugins>
-          <plugin>
-            <groupId>org.apache.maven.plugins</groupId>
-            <artifactId>maven-javadoc-plugin</artifactId>
-            <configuration>
-              <additionalparam>-Xdoclint:none</additionalparam>
-            </configuration>
-          </plugin>
-        </plugins>
-      </build>
-    </profile>
-  </profiles>
 </project>
index 275858c..77b555c 100644 (file)
@@ -29,7 +29,8 @@ public interface ConfigRegistry extends LookupRegistry, ServiceReferenceReadable
     /**
      * Opens new configuration transaction.
      *
-     * @return {@link ObjectName} of {@link ConfigTransactionControllerMXBean}
+     * @return {@link ObjectName} of
+     *         {@link org.opendaylight.controller.config.api.jmx.ConfigTransactionControllerMXBean}
      */
     ObjectName beginConfig();
 
@@ -38,8 +39,8 @@ public interface ConfigRegistry extends LookupRegistry, ServiceReferenceReadable
      *
      * @param transactionControllerON
      *            {@link ObjectName} of
-     *            {@link ConfigTransactionControllerMXBean} that was received in
-     *            {@link #beginConfig()} method call.
+     *            {@link org.opendaylight.controller.config.api.jmx.ConfigTransactionControllerMXBean} that was
+     *            received in {@link #beginConfig()} method call.
      * @return CommitStatus
      * @throws ValidationException
      *             if validation fails
index 41673bc..e6c92fd 100644 (file)
@@ -18,7 +18,7 @@ public interface RuntimeBeanRegistratorAwareModule extends Module {
     /**
      * Configuration framework will call this setter on all modules implementing
      * this interface. It is responsibility of modules or rather their instances
-     * to close registrator in their {@link Closeable#close()} method. Same
+     * to close registrator in their {@link java.io.Closeable#close()} method. Same
      * module will get the same registrator during reconfiguration.
      *
      * @param rootRuntimeBeanRegistrator
index fa2aa1f..f7b56fe 100644 (file)
@@ -21,7 +21,6 @@ public interface ServiceReferenceWritableRegistry extends ServiceReferenceReadab
 
     /**
      * Remove service reference.
-     * @return true iif removed
      * @throws IllegalArgumentException if service interface name is not advertised by any module
      */
     void removeServiceReference(String serviceInterfaceName, String refName) throws InstanceNotFoundException;
index aacafad..0e8f6fd 100644 (file)
@@ -17,16 +17,15 @@ import java.lang.annotation.Target;
  * of a module. This annotation must be present for each dependency setter in
  * {@link org.opendaylight.controller.config.spi.Module} M(X)Bean interface.
  * Together with name of dependent bean the {@link #value()} will be used to get
- * {@link ObjectName} of dependency.
+ * {@link javax.management.ObjectName} of dependency.
  *
  * <p>
  * Example:<br>
  *
  * <code>
- *
- * @RequireInterface(value = ThreadPoolServiceInterface.class, optional =
- *                         false)<br/> void setThreadPool(ObjectName on);
- *                         </code>
+ * {@literal @}RequireInterface(value = ThreadPoolServiceInterface.class, optional = false)<br>
+ * void setThreadPool(ObjectName on);
+ * </code>
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.METHOD)
index e5123e2..b59bf2d 100644 (file)
@@ -11,7 +11,7 @@ import org.opendaylight.controller.config.api.ConfigTransactionController;
 
 /**
  * Those are executed by Jolokia clients on configuration transaction
- * represented by {@link ConfigMBeanServer} instance. Note: Reason for having
+ * represented by <code>ConfigMBeanServer</code> instance. Note: Reason for having
  * methods in super interface is that JMX allows only one MXBean to be
  * implemented and implementations can expose additional methods to be exported. <br>
  * Implementation of {@link ConfigTransactionController} is not required to
index 13efafb..2548711 100644 (file)
@@ -49,9 +49,6 @@ public abstract class ConfigJMXNotification extends Notification {
      * Creates notification about successful commit execution.
      *
      * Intended for config-persister.
-     *
-     * @param transactionName
-     * @param cfgSnapshot
      */
     public static CommitJMXNotification afterCommit(NotificationBroadcasterSupport source, String messages) {
         return new CommitJMXNotification(source, messages);
index 7fcc0cc..9f6a551 100644 (file)
@@ -15,7 +15,7 @@ import org.slf4j.LoggerFactory;
 
 /**
  * Base implementation of Module. This implementation contains base logic for Module reconfiguration with associated fields.
- * @param <M> Type of module implementation. Enables easier implementation for the {@link #isSame} method
+ * @param <M> Type of module implementation. Enables easier implementation for the <code>isSame()</code> method
  */
 public abstract class AbstractModule<M extends AbstractModule<M>> implements org.opendaylight.controller.config.spi.Module {
 
index 9926363..1a8c140 100644 (file)
@@ -15,12 +15,12 @@ import org.opendaylight.controller.config.api.annotations.AbstractServiceInterfa
 import org.osgi.framework.BundleContext;
 
 /**
- * Factory which creates {@link Module instances. An instance of this interface
+ * Factory which creates {@link Module} instances. An instance of this interface
  * needs to be exported into the OSGi Service Registry. Such an instance
  * provides metadata describing services which can be published from it.
  *
- * Each {@link Module } can optionally be instantiated with a
- * {@link DynamicMBean} which represents the configuration of the currently
+ * Each {@link Module} can optionally be instantiated with a
+ * {@link javax.management.DynamicMBean} which represents the configuration of the currently
  * running instance.
  */
 public interface ModuleFactory {
@@ -56,7 +56,7 @@ public interface ModuleFactory {
      * Create a new Module instance. The returned object is expected to use the
      * dependencyResolver provided when resolving ObjectNames to actual Module
      * instances. A reference to an abstract view of the previous configuration
-     * is also provided in the form of a {@link DynamicMBean}. Implementations
+     * is also provided in the form of a {@link javax.management.DynamicMBean}. Implementations
      * should use the MBeanInfo interface to understand the structure of the
      * configuration information.
      *
@@ -71,7 +71,7 @@ public interface ModuleFactory {
      * @param old
      *            existing module from platform MBeanServer that is being
      *            reconfigured. Implementations should inspect its attributes
-     *            using {@link DynamicMBean#getAttribute(String)} and set those
+     *            using {@link javax.management.DynamicMBean#getAttribute(String)} and set those
      *            attributes on newly created module. If reconfiguration of live
      *            instances is supported, this live instance can be retreived
      *            using
index f80494f..5f169de 100644 (file)
@@ -18,10 +18,6 @@ public class ArrayAttributeReadingStrategy extends AbstractAttributeReadingStrat
 
     private final AttributeReadingStrategy innerStrategy;
 
-    /**
-     * @param attributeIfc
-     * @param innerStrategy
-     */
     public ArrayAttributeReadingStrategy(String nullableDefault, AttributeReadingStrategy innerStrategy) {
         super(nullableDefault);
         this.innerStrategy = innerStrategy;
index 30726db..10602ce 100644 (file)
@@ -160,7 +160,7 @@ public class Config {
     }
 
     /**
-     * return a map containing namespace -> moduleName -> instanceName map. Attribute parsing is omitted.
+     * return a map containing namespace -&gt; moduleName -&gt; instanceName map. Attribute parsing is omitted.
      */
     public Map<String, Multimap<String, ModuleElementDefinition>> fromXmlModulesMap(XmlElement xml,
             EditStrategyType defaultEditStrategyType, ServiceRegistryWrapper serviceTracker) throws DocumentedException {
index 894858d..67ed296 100644 (file)
@@ -40,7 +40,7 @@ import org.slf4j.LoggerFactory;
  * of {@link org.opendaylight.controller.config.spi.Module#validate()} and
  * {@link org.opendaylight.controller.config.spi.Module#getInstance()} is also
  * guaranteed by
- * {@link org.opendaylight.controller.config.manager.impl.ConfigTransactionControllerInternal}
+ * org.opendaylight.controller.config.manager.impl.ConfigTransactionControllerInternal
  * so the actual {@link org.opendaylight.controller.config.spi.Module} needs not
  * to be thread safe.
  * </p>
index 84e7270..15122b4 100644 (file)
@@ -12,7 +12,7 @@ import org.opendaylight.controller.config.spi.ModuleFactory;
 import org.osgi.framework.BundleContext;
 
 /**
- * {@link org.opendaylight.controller.config.manager.impl.ConfigTransactionControllerImpl}
+ * org.opendaylight.controller.config.manager.impl.ConfigTransactionControllerImpl
  * receives list of factories using this interface. For testing, this could be
  * implemented as hard coded list of objects, for OSGi this would look for all
  * services in OSGi Service Registry are registered under
index 70ed695..206a623 100644 (file)
@@ -16,7 +16,7 @@ import org.opendaylight.controller.config.api.jmx.ObjectNameUtil;
 
 /**
  * This subclass is used for registering readable module into JMX, it is also
- * used as underlying provider in {@link RuntimeBeanRegistratorImpl}. Closing
+ * used as underlying provider in RuntimeBeanRegistratorImpl. Closing
  * the instance thus unregisters all JMX beans related to the module excluding
  * currently open transactions.
  */
index 62215d6..6969a3b 100644 (file)
@@ -28,7 +28,7 @@ import org.slf4j.LoggerFactory;
  *
  * Primary customizer may return tracking object,
  * which will be passed to it during invocation of
- * {@link BundleTrackerCustomizer#removedBundle(Bundle, BundleEvent, Future)}
+ * {@link BundleTrackerCustomizer#removedBundle(Bundle, BundleEvent, Object)}
  *
  *
  * This extender modifies behaviour to not leak platform thread
index 66c89d2..9bbfa4d 100644 (file)
         <module>yang-jmx-generator-it</module>
       </modules>
     </profile>
-    <!-- Turn off doclint. -->
-    <profile>
-      <id>jdk8</id>
-      <activation>
-        <jdk>[1.8,)</jdk>
-      </activation>
-      <build>
-        <plugins>
-          <plugin>
-            <groupId>org.apache.maven.plugins</groupId>
-            <artifactId>maven-javadoc-plugin</artifactId>
-            <configuration>
-              <additionalparam>-Xdoclint:none</additionalparam>
-            </configuration>
-          </plugin>
-        </plugins>
-      </build>
-    </profile>
   </profiles>
 </project>
index 2b130e3..48895d2 100644 (file)
@@ -13,9 +13,8 @@ import org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil;
 import org.opendaylight.yangtools.yang.model.api.Module;
 
 /**
- * Maps from module namespaces to java package names using a Map<String,
- * String>, where key is namespace prefix and value is package that replaces
- * matched prefix.
+ * Maps from module namespaces to java package names using a Map&lt;String, String&gt;,
+ * where key is namespace prefix and value is package that replaces matched prefix.
  */
 public class PackageTranslator {
     private final Map<String, String> namespacePrefixToPackageMap;
index d9a6dd0..697f022 100644 (file)
@@ -60,7 +60,7 @@ public abstract class AbstractAttribute implements AttributeIfc {
      *
      * @return Yang name converted to cammel case, starting with a capital
      *         letter. For details see
-     *         {@link ModuleMXBeanEntry#findJavaNamePrefix(org.opendaylight.yangtools.yang.model.api.SchemaNode)}
+     *         {@link org.opendaylight.controller.config.yangjmxgenerator.ModuleMXBeanEntry#getJavaNamePrefix()}
      */
     @Override
     public String getUpperCaseCammelCase() {
index 0746013..2431472 100644 (file)
     </dependency>
   </dependencies>
 
-  <profiles>
-    <!-- Turn off doclint. -->
-    <profile>
-      <id>jdk8</id>
-      <activation>
-        <jdk>[1.8,)</jdk>
-      </activation>
-      <build>
-        <plugins>
-          <plugin>
-            <groupId>org.apache.maven.plugins</groupId>
-            <artifactId>maven-javadoc-plugin</artifactId>
-            <configuration>
-              <additionalparam>-Xdoclint:none</additionalparam>
-            </configuration>
-          </plugin>
-        </plugins>
-      </build>
-    </profile>
-  </profiles>
-
   <scm>
     <connection>scm:git:http://git.opendaylight.org/gerrit/controller.git</connection>
     <developerConnection>scm:git:ssh://git.opendaylight.org:29418/controller.git</developerConnection>
index 6a6266a..6880775 100644 (file)
@@ -15,7 +15,7 @@ import org.opendaylight.yangtools.yang.model.api.SchemaPath;
 
 /**
  * Event source is a node in topology which is able to produces notifications.
- * To register event source you use {@link EventSourceRegistry#registerEventSource(EventSource)()}.
+ * To register event source you use {@link EventSourceRegistry#registerEventSource(EventSource)}.
  * EventSourceRegistry will request registered event source to publish notifications
  * whenever EventSourceRegistry has been asked to publish a certain type of notifications.
  * EventSourceRegistry will call method JoinTopic to request EventSource to publish notification.
@@ -38,4 +38,4 @@ public interface EventSource extends EventSourceService, AutoCloseable {
      */
     List<SchemaPath> getAvailableNotifications();
 
-}
\ No newline at end of file
+}
index 10d3b5b..8f9b530 100644 (file)
@@ -8,18 +8,17 @@
 package org.opendaylight.controller.messagebus.spi;
 
 /**
- *EventSourceRegistry is used to register {@link EventSource}.
- *
+ * EventSourceRegistry is used to register {@link EventSource}.
  */
 public interface EventSourceRegistry extends AutoCloseable {
 
     /**
      * Registers the given EventSource for public consumption. The EventSource is
-     * associated with the node identified via {@linkEventSource#getSourceNodeKey}.
+     * associated with the node identified via {@link EventSource#getSourceNodeKey}.
      *
      * @param eventSource the EventSource instance to register
-     * @return an EventSourceRegistration instance that is used to unregister the EventSource via {@link EventSourceRegistrationImpl#close()}.
+     * @return an EventSourceRegistration instance that is used to unregister the EventSource via {@link EventSourceRegistration#close()}.
      */
     <T extends EventSource> EventSourceRegistration<T> registerEventSource(T eventSource);
 
-}
\ No newline at end of file
+}
index cc20662..02247ff 100644 (file)
@@ -31,7 +31,7 @@ public final class Util {
      * Method filters qnames based on wildcard strings
      *
      * @param list
-     * @param patterh matching pattern
+     * @param pattern matching pattern
      * @return list of filtered qnames
      */
     public static List<SchemaPath> expandQname(final List<SchemaPath> list, final Pattern pattern) {
index fc04389..0137360 100644 (file)
         <module>benchmark-data-store</module>
       </modules>
     </profile>
-    <!-- Turn off doclint. -->
-    <profile>
-      <id>jdk8</id>
-      <activation>
-        <jdk>[1.8,)</jdk>
-      </activation>
-      <build>
-        <plugins>
-          <plugin>
-            <groupId>org.apache.maven.plugins</groupId>
-            <artifactId>maven-javadoc-plugin</artifactId>
-            <configuration>
-              <additionalparam>-Xdoclint:none</additionalparam>
-            </configuration>
-          </plugin>
-        </plugins>
-      </build>
-    </profile>
   </profiles>
 </project>
index 29e8a47..f6930e8 100644 (file)
@@ -24,11 +24,11 @@ import scala.concurrent.duration.FiniteDuration;
 
 /**
  * This is a sample implementation of a Role Change Listener which is an actor, which registers itself to the ClusterRoleChangeNotifier
- * <p/>
+ * <p>
  * The Role Change listener receives a SetNotifiers message with the notifiers to register itself with.
- * <p/>
+ * <p>
  * It kicks of a scheduler which sents registration messages to the notifiers, till it gets a RegisterRoleChangeListenerReply
- * <p/>
+ * <p>
  * If all the notifiers have been regsitered with, then it cancels the scheduler.
  * It starts the scheduler again when it receives a new registration
  *
index 652771b..0e701e3 100644 (file)
@@ -13,10 +13,12 @@ import scala.concurrent.duration.FiniteDuration;
 
 /**
  * Configuration Parameter interface for configuring the Raft consensus system
- * <p/>
+ *
+ * <p>
  * Any component using this implementation might want to provide an implementation of
  * this interface to configure
- * <p/>
+ *
+ * <p>
  * A default implementation will be used if none is provided.
  *
  * @author Kamal Rameshan
index 2d2f95b..317ce6a 100644 (file)
@@ -41,7 +41,8 @@ public class DefaultConfigParamsImpl implements ConfigParams {
     /**
      * The interval at which a heart beat message will be sent to the remote
      * RaftActor.
-     * <p/>
+     *
+     * <p>
      * Since this is set to 100 milliseconds the Election timeout should be
      * at least 200 milliseconds
      */
index e8c9b45..264f7a5 100644 (file)
@@ -12,10 +12,12 @@ import javax.annotation.Nullable;
 
 /**
  * ElectionTerm contains information about a RaftActors election term.
- * <p/>
+ *
+ * <p>
  * This information includes the last known current term of the RaftActor
  * and which candidate was voted for by the RaftActor in that term.
- * <p/>
+ *
+ * <p>
  * This class ensures that election term information is persisted.
  */
 public interface ElectionTerm {
index 8d29614..e3fa649 100644 (file)
@@ -59,7 +59,8 @@ import org.opendaylight.yangtools.concepts.Immutable;
  * in a cluster. It implements the RAFT algorithm as described in the paper
  * <a href='https://ramcloud.stanford.edu/wiki/download/attachments/11370504/raft.pdf'>
  * In Search of an Understandable Consensus Algorithm</a>
- * <p/>
+ *
+ * <p>
  * RaftActor has 3 states and each state has a certain behavior associated
  * with it. A Raft actor can behave as,
  * <ul>
@@ -67,27 +68,26 @@ import org.opendaylight.yangtools.concepts.Immutable;
  * <li> A Follower (or) </li>
  * <li> A Candidate </li>
  * </ul>
- * <p/>
- * <p/>
+ *
+ * <p>
  * A RaftActor MUST be a Leader in order to accept requests from clients to
  * change the state of it's encapsulated state machine. Once a RaftActor becomes
  * a Leader it is also responsible for ensuring that all followers ultimately
  * have the same log and therefore the same state machine as itself.
- * <p/>
- * <p/>
+ *
+ * <p>
  * The current behavior of a RaftActor determines how election for leadership
  * is initiated and how peer RaftActors react to request for votes.
- * <p/>
- * <p/>
+ *
+ * <p>
  * Each RaftActor also needs to know the current election term. It uses this
  * information for a couple of things. One is to simply figure out who it
  * voted for in the last election. Another is to figure out if the message
  * it received to update it's state is stale.
- * <p/>
- * <p/>
+ *
+ * <p>
  * The RaftActor uses akka-persistence to store it's replicated log.
  * Furthermore through it's behaviors a Raft Actor determines
- * <p/>
  * <ul>
  * <li> when a log entry should be persisted </li>
  * <li> when a log entry should be applied to the state machine (and) </li>
index f3ffe13..b087914 100644 (file)
@@ -26,7 +26,8 @@ import scala.concurrent.duration.FiniteDuration;
 /**
  * A raft actor support class that participates in leadership transfer. An instance is created upon
  * initialization of leadership transfer.
- * <p/>
+ *
+ * <p>
  * The transfer process is as follows:
  * <ol>
  * <li>Send a LeaderStateChanged message with a null leader Id to the local RoleChangeNotifier to notify
@@ -35,14 +36,15 @@ import scala.concurrent.duration.FiniteDuration;
  *     their local RoleChangeNotifiers.</li>
  * <li>Call {@link RaftActor#pauseLeader} passing this RaftActorLeadershipTransferCohort
  *     instance. This allows derived classes to perform work prior to transferring leadership.</li>
- * <li>When the pause is complete, the {@link #run} method is called which in turn calls
- *     {@link Leader#transferLeadership}.</li>
+ * <li>When the pause is complete, the run method is called which in turn calls
+ *     {@link Leader#transferLeadership(RaftActorLeadershipTransferCohort)}.</li>
  * <li>The Leader calls {@link #transferComplete} on successful completion.</li>
  * <li>Wait a short period of time for the new leader to be elected to give the derived class a chance to
  *     possibly complete work that was suspended while we were transferring.</li>
  * <li>On notification of the new leader from the RaftActor or on time out, notify {@link OnComplete} callbacks.</li>
  * </ol>
- * <p/>
+ *
+ * <p>
  * NOTE: All methods on this class must be called on the actor's thread dispatcher as they may access/modify
  * internal state.
  *
index 73ab6ea..cd70812 100644 (file)
@@ -61,7 +61,8 @@ public interface ReplicatedLog {
 
     /**
      * Removes entries from the in-memory log and the persisted log starting at the given index.
-     * <p/>
+     *
+     * <p>
      * The persisted information would then be used during recovery to properly
      * reconstruct the state of the in-memory replicated log
      *
index fab1714..31bf99c 100644 (file)
@@ -50,7 +50,8 @@ import scala.concurrent.duration.FiniteDuration;
 
 /**
  * The behavior of a RaftActor when it is in the Leader state
- * <p/>
+ *
+ * <p>
  * Leaders:
  * <ul>
  * <li> Upon election: send initial empty AppendEntries RPCs
@@ -64,7 +65,7 @@ import scala.concurrent.duration.FiniteDuration;
  * follower (§5.3)
  * <li> If AppendEntries fails because of log inconsistency:
  * decrement nextIndex and retry (§5.3)
- * <li> If there exists an N such that N > commitIndex, a majority
+ * <li> If there exists an N such that N &gt; commitIndex, a majority
  * of matchIndex[i] ≥ N, and log[N].term == currentTerm:
  * set commitIndex = N (§5.3, §5.4).
  * </ul>
@@ -699,7 +700,8 @@ public abstract class AbstractLeader extends AbstractRaftActorBehavior {
 
     /**
      * Initiates a snapshot capture to install on a follower.
-     * <p/>
+     *
+     * <p>
      * Install Snapshot works as follows
      *   1. Leader initiates the capture snapshot by calling createSnapshot on the RaftActor.
      *   2. On receipt of the CaptureSnapshotReply message, the RaftActor persists the snapshot and makes a call to
index b86d28b..ac7dbab 100644 (file)
@@ -24,7 +24,8 @@ import org.opendaylight.controller.cluster.raft.messages.RequestVoteReply;
 
 /**
  * The behavior of a RaftActor when it is in the Candidate raft state.
- * <p/>
+ *
+ * <p>
  * Candidates (§5.2):
  * <ul>
  * <li> On conversion to candidate, start election:
index 3f68b50..d4747da 100644 (file)
@@ -41,7 +41,6 @@ import org.opendaylight.controller.cluster.raft.persisted.ServerConfigurationPay
 
 /**
  * The behavior of a RaftActor in the Follower raft state.
- * <p/>
  * <ul>
  * <li> Respond to RPCs from candidates and leaders
  * <li> If election timeout elapses without receiving AppendEntries
index 658c129..9ba39c2 100644 (file)
@@ -15,16 +15,18 @@ import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply;
 
 /**
  * Leader which is termed as isolated.
- * <p/>
+ *
+ * <p>
  * If the reply from the majority of the followers  is not received then the leader changes its behavior
  * to IsolatedLeader. An isolated leader may have followers and they would continue to receive replicated messages.
- * <p/>
+ *
+ * <p>
  * A schedule is run, at an interval of (10 * Heartbeat-time-interval),  in the Leader
  * to check if its isolated or not.
- * <p/>
+ *
+ * <p>
  * In the Isolated Leader , on every AppendEntriesReply, we aggressively check if the leader is isolated.
  * If no, then the state is switched back to Leader.
- *
  */
 public class IsolatedLeader extends AbstractLeader {
     IsolatedLeader(RaftActorContext context, @Nullable AbstractLeader initializeFromLeader) {
index 4821d98..f5f3f51 100644 (file)
@@ -24,7 +24,8 @@ import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply;
 
 /**
  * The behavior of a RaftActor when it is in the Leader state.
- * <p/>
+ *
+ * <p>
  * Leaders:
  * <ul>
  * <li> Upon election: send initial empty AppendEntries RPCs
@@ -38,7 +39,7 @@ import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply;
  * follower (§5.3)
  * <li> If AppendEntries fails because of log inconsistency:
  * decrement nextIndex and retry (§5.3)
- * <li> If there exists an N such that N > commitIndex, a majority
+ * <li> If there exists an N such that N &gt; commitIndex, a majority
  * of matchIndex[i] ≥ N, and log[N].term == currentTerm:
  * set commitIndex = N (§5.3, §5.4).
  * </ul>
@@ -107,14 +108,14 @@ public class Leader extends AbstractLeader {
      * <li>Start a timer (Stopwatch).</li>
      * <li>Send an initial AppendEntries heartbeat to all followers.</li>
      * <li>On AppendEntriesReply, check if the follower's new match Index matches the leader's last index</li>
-     * <li>If it matches, </li>
+     * <li>If it matches,
      *   <ul>
      *   <li>Send an additional AppendEntries to ensure the follower has applied all its log entries to its state.</li>
      *   <li>Send an ElectionTimeout to the follower to immediately start an election.</li>
      *   <li>Notify {@link RaftActorLeadershipTransferCohort#transferComplete}.</li>
-     *   </ul>
+     *   </ul></li>
      * <li>Otherwise if the election time out period elapses, notify
-     *     {@link RaftActorLeadershipTransferCohort#abortTtransfer}.</li>
+     *     {@link RaftActorLeadershipTransferCohort#abortTransfer}.</li>
      * </ul>
      *
      * @param leadershipTransferCohort the cohort participating in the leadership transfer
index 09f5186..bb54688 100644 (file)
@@ -22,7 +22,8 @@ import org.opendaylight.controller.cluster.raft.persisted.NoopPayload;
  * the log with the leader's current term. Once the no-op entry is committed, all prior entries are committed
  * indirectly. Once all entries are committed, ie commitIndex matches the last log index, it switches to the
  * normal Leader state.
- * <p/>
+ *
+ * <p>
  * The use of a no-op entry in this manner is outlined in the last paragraph in §8 of the
  * <a href="https://raft.github.io/raft.pdf">extended raft version</a>.
  *
index 8f23a89..945ace7 100644 (file)
@@ -15,7 +15,8 @@ import java.io.Serializable;
  * Request to locate the leader raft actor. Each {@link org.opendaylight.controller.cluster.raft.RaftActor} must
  * respond with a {@link FindLeaderReply} containing the address of the leader, as it is known to that particular
  * actor.
- * <p/>
+ *
+ * <p>
  * This message is intended for testing purposes only.
  */
 @VisibleForTesting
index 5fbeb92..90cec9d 100644 (file)
@@ -17,7 +17,8 @@ import javax.annotation.Nullable;
  * Reply to {@link FindLeader} message, containing the address of the leader actor, as known to the raft actor which
  * sent the message. If the responding actor does not have knowledge of the leader, {@link #getLeaderActor()} will
  * return {@link Optional#empty()}.
- * <p/>
+ *
+ * <p>
  * This message is intended for testing purposes only.
  */
 @VisibleForTesting
index c535c22..183e340 100644 (file)
@@ -13,12 +13,12 @@ package org.opendaylight.controller.cluster.raft.policy;
  * we may want to be able to determine which Raft replica should become the leader - with Raft elections are
  * randomized so it is not possible to specify which replica should be the leader. The ability to specify
  * the leader would be quite useful when testing a raft cluster.
- * <p/>
+ *
+ * <p>
  * Similarly we may want to customize when exactly we apply a modification to the state - with Raft a modification
  * is only applied to the state when the modification is replicated to a majority of the replicas. The ability to
  * apply a modification to the state before consensus would be useful in scenarios where you have only 2 nodes
  * in a Raft cluster and one of them is down but you still want the RaftActor to apply a modification to the state.
- *
  */
 public interface RaftPolicy {
     /**
index e8d6a45..08141e8 100644 (file)
     <tag>HEAD</tag>
     <url>https://wiki.opendaylight.org/view/OpenDaylight_Controller:MD-SAL</url>
   </scm>
-
-  <profiles>
-    <!-- Turn off doclint on aggregated API javadoc build. -->
-    <profile>
-      <id>jdk8</id>
-      <activation>
-        <jdk>[1.8,)</jdk>
-      </activation>
-
-      <build>
-        <plugins>
-          <plugin>
-            <groupId>org.apache.maven.plugins</groupId>
-            <artifactId>maven-javadoc-plugin</artifactId>
-            <configuration>
-              <additionalparam>-Xdoclint:none</additionalparam>
-            </configuration>
-          </plugin>
-        </plugins>
-      </build>
-    </profile>
-  </profiles>
 </project>
index d9f0e08..54692f4 100644 (file)
@@ -19,8 +19,8 @@ package org.opendaylight.controller.md.sal.binding.api;
  * to data change notifications on any node of clustered datastore. DataChangeListener enables data change notifications
  * only at leader of the datastore shard.</p>
  *
- * @Deprecated Replaced by {@link ClusteredDataTreeChangeListener}
+ * @deprecated Replaced by {@link ClusteredDataTreeChangeListener}
  */
 @Deprecated
-public interface ClusteredDataChangeListener extends DataChangeListener{
+public interface ClusteredDataChangeListener extends DataChangeListener {
 }
index afeb21c..f8dd3b0 100644 (file)
@@ -69,7 +69,6 @@ public interface DataObjectModification<T extends DataObject> extends org.openda
      * Returns before-state of top level container. Implementations are encouraged,
      * but not required to provide this state.
      *
-     * @param root Class representing data container
      * @return State of object before modification. Null if subtree was not present,
      *         or the implementation cannot provide the state.
      */
@@ -78,7 +77,6 @@ public interface DataObjectModification<T extends DataObject> extends org.openda
     /**
      * Returns after-state of top level container.
      *
-     * @param root Class representing data container
      * @return State of object after modification. Null if subtree is not present.
      */
     @Nullable T getDataAfter();
index 9d12e44..f899eb1 100644 (file)
@@ -12,7 +12,7 @@ import org.opendaylight.yangtools.concepts.ListenerRegistration;
 import org.opendaylight.yangtools.yang.binding.DataObject;
 
 /**
- * A {@link DOMService} which allows users to register for changes to a
+ * A {@link BindingService} which allows users to register for changes to a
  * subtree.
  */
 public interface DataTreeChangeService extends BindingService {
@@ -52,4 +52,4 @@ public interface DataTreeChangeService extends BindingService {
      *         delivery of change events.
      */
     @Nonnull <T extends DataObject,L extends DataTreeChangeListener<T>> ListenerRegistration<L> registerDataTreeChangeListener(@Nonnull DataTreeIdentifier<T> treeId, @Nonnull L listener);
-}
\ No newline at end of file
+}
index a90d6da..13d0a92 100644 (file)
@@ -40,7 +40,7 @@ public final class DataTreeIdentifier<T extends DataObject> implements Immutable
     }
 
     /**
-     * Return the {@link YangInstanceIdentifier} of the root node.
+     * Return the {@link InstanceIdentifier} of the root node.
      *
      * @return Instance identifier corresponding to the root node.
      */
@@ -82,4 +82,4 @@ public final class DataTreeIdentifier<T extends DataObject> implements Immutable
         return getClass().getSimpleName() + "{datastoreType = " + datastoreType + ", rootIdentifier = " +
                 rootIdentifier + "}";
     }
-}
\ No newline at end of file
+}
index 7f8b734..393839c 100644 (file)
@@ -61,7 +61,7 @@ public interface NotificationPublishService extends BindingService {
      * @param notification
      *            the notification to publish.
      * @return A listenable future which will report completion when the service has finished
-     * propagating the notification to its immediate registrants, or {@value #REJECTED} if resource
+     * propagating the notification to its immediate registrants, or {@link #REJECTED} if resource
      * constraints prevent
      * @throws NullPointerException if the notification is null
      */
@@ -80,7 +80,7 @@ public interface NotificationPublishService extends BindingService {
      * @param unit a TimeUnit determining how to interpret the
      *             timeout parameter
      * @return A listenable future which will report completion when the service has finished
-     * propagating the notification to its immediate registrants, or {@value #REJECTED} if resource
+     * propagating the notification to its immediate registrants, or {@link #REJECTED} if resource
      * constraints prevent
      * @throws InterruptedException if interrupted while waiting
      * @throws NullPointerException if the notification or unit is null
index ba35235..c0e8ea5 100644 (file)
@@ -21,7 +21,7 @@ import org.opendaylight.yangtools.yang.binding.NotificationListener;
  * are registered using {@link #registerNotificationListener(org.opendaylight.yangtools.yang.binding.NotificationListener)}
  * method.
  *
- * <h5>Dispatch Listener Example</h5>
+ * <h3>Dispatch Listener Example</h3>
  * <p>
  * Lets assume we have following YANG model:
  *
@@ -40,14 +40,14 @@ import org.opendaylight.yangtools.yang.binding.NotificationListener;
  * </pre>
  *
  * The generated interface will be:
- * <pre>
+ * {@code
  *  public interface ExampleListener extends NotificationListener {
  *      void onStart(Start notification);
  *      void onStop(Stop notification);
  *  }
- * </pre>
+ * }
  * The following defines an implementation of the generated interface:
- * <pre>
+ * {@code
  *  public class MyExampleListener implements ExampleListener {
  *      public void onStart(Start notification) {
  *          // do something
@@ -57,12 +57,12 @@ import org.opendaylight.yangtools.yang.binding.NotificationListener;
  *          // do something
  *      }
  *  }
- * </pre>
+ * }
  * The implementation is registered as follows:
- * <pre>
+ * {@code
  *  MyExampleListener listener = new MyExampleListener();
  *  ListenerRegistration<NotificationListener> reg = service.registerNotificationListener( listener );
- * </pre>
+ * }
  * The <code>onStart</code> method will be invoked when someone publishes a <code>Start</code> notification and
  * the <code>onStop</code> method will be invoked when someone publishes a <code>Stop</code> notification.
  */
index bd78c58..9972ce7 100644 (file)
@@ -78,7 +78,7 @@ public abstract class AbstractBrokerAwareActivator implements BundleActivator {
 
     /**
      * Called when this bundle is started (before
-     * {@link #onSessionInitiated(ProviderContext)} so the Framework can perform
+     * {@link BindingAwareProvider#onSessionInitiated(ProviderContext)} so the Framework can perform
      * the bundle-specific activities necessary to start this bundle. This
      * method can be used to register services or to allocate any resources that
      * this bundle needs.
@@ -88,7 +88,7 @@ public abstract class AbstractBrokerAwareActivator implements BundleActivator {
      *
      * @param context
      *            The execution context of the bundle being started.
-     * @throws Exception
+     * @throws RuntimeException
      *             If this method throws an exception, this bundle is marked as
      *             stopped and the Framework will remove this bundle's
      *             listeners, unregister all services registered by this bundle,
@@ -110,7 +110,7 @@ public abstract class AbstractBrokerAwareActivator implements BundleActivator {
      * This method must complete and return to its caller in a timely manner.
      *
      * @param context The execution context of the bundle being stopped.
-     * @throws Exception If this method throws an exception, the bundle is still
+     * @throws RuntimeException If this method throws an exception, the bundle is still
      *         marked as stopped, and the Framework will remove the bundle's
      *         listeners, unregister all services registered by the bundle, and
      *         release all services used by the bundle.
index 8ede747..b934800 100644 (file)
@@ -18,7 +18,7 @@ import org.osgi.framework.BundleContext;
  * Binding-aware core of the SAL layer responsible for wiring the SAL consumers.
  *
  * The responsibility of the broker is to maintain registration of SAL
- * functionality {@link Consumer}s and {@link Provider}s, store provider and
+ * functionality Consumers and Providers, store provider and
  * consumer specific context and functionality registration via
  * {@link ConsumerContext} and provide access to infrastructure services, which
  * removes direct dependencies between providers and consumers.
@@ -68,9 +68,9 @@ public interface BindingAwareBroker {
      * The consumer is required to use returned session for all communication
      * with broker or one of the broker services. The session is announced to
      * the consumer by invoking
-     * {@link Consumer#onSessionInitiated(ConsumerContext)}.
+     * {@link BindingAwareConsumer#onSessionInitialized(ConsumerContext)}.
      *
-     * @param cons
+     * @param consumer
      *            Consumer to be registered.
      * @return a session specific to consumer registration
      * @throws IllegalArgumentException
@@ -92,7 +92,7 @@ public interface BindingAwareBroker {
      * <p>
      * During the registration, the broker obtains the initial functionality
      * from consumer, using the
-     * {@link BindingAwareProvider#getImplementations()}, and register that
+     * BindingAwareProvider#getImplementations(), and register that
      * functionality into system and concrete infrastructure services.
      *
      * <p>
@@ -106,7 +106,7 @@ public interface BindingAwareBroker {
      * {@link BindingAwareProvider#onSessionInitiated(ProviderContext)}.
      *
      *
-     * @param prov
+     * @param provider
      *            Provider to be registered.
      * @return a session unique to the provider registration.
      * @throws IllegalArgumentException
@@ -127,7 +127,7 @@ public interface BindingAwareBroker {
      * The session serves to store SAL context (e.g. registration of
      * functionality) for the consumer and provides access to the SAL
      * infrastructure services and other functionality provided by
-     * {@link Provider}s.
+     * {@link BindingAwareProvider}s.
      */
     interface ConsumerContext extends RpcConsumerRegistry {
 
@@ -192,7 +192,7 @@ public interface BindingAwareBroker {
          * Register particular instance identifier to be processed by this
          * RpcService
          *
-         * Deprecated in favor of {@link RoutedRegistration#registerPath(Object, Object)}.
+         * Deprecated in favor of RoutedRegistration#registerPath(Object, Object).
          *
          * @param context
          * @param instance
@@ -204,7 +204,7 @@ public interface BindingAwareBroker {
          * Unregister particular instance identifier to be processed by this
          * RpcService
          *
-         * Deprecated in favor of {@link RoutedRegistration#unregisterPath(Object, Object)}.
+         * Deprecated in favor of RoutedRegistration#unregisterPath(Class, InstanceIdentifier).
          *
          * @param context
          * @param instance
index bcbd687..b3b3e07 100644 (file)
@@ -64,9 +64,6 @@ import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ConsumerCo
 *      DataBroker databroker = session.getSALService(BindingDataBroker.class);
 * }
 * }
-* @see org.opendaylight.controller.md.sal.common.api.data.BindingDataBroker
-* for more info on using the DataBroker.
-*
 */
 public interface BindingAwareConsumer {
 
index 35583c0..8088632 100644 (file)
@@ -45,27 +45,28 @@ import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ProviderCo
  *
  * To get a NotificationService:
  *
- * {code
+ * {@code
  * public void onSessionInitiated(ProviderContext session) {
  *      NotificationProviderService notificationService = session.getSALService(NotificationProviderService.class);
  * }
+ * }
  * For more information on sending notifications via the NotificationProviderService
  * @see org.opendaylight.controller.sal.binding.api.NotificationProviderService
  *
  * To register an RPC implementation:
  *
- * {code
+ * {@code
  * public void onSessionInitiated(ProviderContext session) {
  *    RpcRegistration<MyService> registration = session.addRpcImplementation(MyService.class, myImplementationInstance);
  * }
+ * }
  *
  * <p>
- *
  * Where MyService.class is a Service interface generated from a yang model with RPCs modeled in it and myImplementationInstance
  * is an instance of a class that implements MyService.
  *
  * To register a Routed RPC Implementation:
- * {code
+ * {@code
  * public void onSessionInitiated(ProviderContext session) {
  *   RoutedRpcRegistration<SalFlowService> flowRegistration = session.addRoutedRpcImplementation(SalFlowService.class, salFlowServiceImplementationInstance);
      flowRegistration.registerPath(NodeContext.class, nodeInstanceId);
@@ -76,7 +77,7 @@ import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ProviderCo
  * of a class that implements SalFlowService.
  * <p>
  * The line:
- * {code
+ * {@code
  * flowRegistration.registerPath(NodeContext.class, nodeInstanceId);
  * }
  * Is indicating that the RPC implementation is registered to handle RPC invocations that have their NodeContext pointing to the node with instance id nodeInstanceId.
@@ -92,14 +93,11 @@ import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ProviderCo
  *
  * To get a DataBroker to allow access to the data tree:
  *
- * {code
+ * {@code
  * public void onSessionInitiated(final ProviderContext session) {
  *      DataBroker databroker = session.getSALService(BindingDataBroker.class);
  * }
  * }
- * @see org.opendaylight.controller.md.sal.common.api.data.BindingDataBroker
- * for more info on using the DataBroker.
- *
  */
 public interface BindingAwareProvider {
 
index dd66aa6..015988e 100644 (file)
@@ -20,6 +20,7 @@ import org.opendaylight.yangtools.yang.binding.Notification;
  * <li>Dispatch listener - listener, which implements <code>{ModelName}Listener</code> interface,
  * which has dispatch methods for each defined notification. Methods are invoked based on notification type (class).
  * </li>
+ * </ul>
  *
  * <h3>Generic Listener</h3>
  * <p>
@@ -47,11 +48,11 @@ import org.opendaylight.yangtools.yang.binding.Notification;
  * are registered using {@link #registerNotificationListener(org.opendaylight.yangtools.yang.binding.NotificationListener)}
  * method.
  *
- * <h5>Dispatch Listener Example</h5>
+ * <h4>Dispatch Listener Example</h4>
  * <p>
  * Lets assume we have following YANG model:
  *
- * <pre>
+ * {@code
  * module example {
  *      ...
  *
@@ -63,17 +64,17 @@ import org.opendaylight.yangtools.yang.binding.Notification;
  *           ...
  *      }
  * }
- * </pre>
+ * }
  *
  * The generated interface will be:
- * <pre>
+ * {@code
  *  public interface ExampleListener extends NotificationListener {
  *      void onStart(Start notification);
  *      void onStop(Stop notification);
  *  }
- * </pre>
+ * }
  * The following defines an implementation of the generated interface:
- * <pre>
+ * {@code
  *  public class MyExampleListener implements ExampleListener {
  *      public void onStart(Start notification) {
  *          // do something
@@ -83,12 +84,12 @@ import org.opendaylight.yangtools.yang.binding.Notification;
  *          // do something
  *      }
  *  }
- * </pre>
+ * }
  * The implementation is registered as follows:
- * <pre>
+ * {@code
  *  MyExampleListener listener = new MyExampleListener();
  *  ListenerRegistration<NotificationListener> reg = service.registerNotificationListener( listener );
- * </pre>
+ * }
  * The <code>onStart</code> method will be invoked when someone publishes a <code>Start</code> notification and
  * the <code>onStop</code> method will be invoked when someone publishes a <code>Stop</code> notification.
  *
index 0c5e764..d31a2fe 100644 (file)
@@ -49,7 +49,7 @@ public interface RpcConsumerRegistry extends BindingAwareService, BindingService
      * to listen for Rpc Result. This will asynchronously listen for future result in executor and
      * will not block current thread.
      *
-     * <pre>
+     * {@code
      *   final Future<RpcResult<SomeRpcOutput>> future = someRpcService.someRpc( ... );
      *   Futures.addCallback(JdkFutureAdapters.listenInThreadPool(future), new FutureCallback<RpcResult<SomeRpcOutput>>() {
      *
@@ -61,7 +61,9 @@ public interface RpcConsumerRegistry extends BindingAwareService, BindingService
      *          // RPC failed
      *       }
      *   );
-     * </pre>
+     * }
+     * }
+     *
      * @param serviceInterface the interface of the RPC Service. Typically this is an interface generated
      *                         from a YANG model.
      * @return the proxy for the requested RPC service. This method never returns null.
index 22db985..759dbe0 100644 (file)
@@ -68,11 +68,11 @@ import org.opendaylight.yangtools.yang.binding.RpcService;
  *
  * <h3>Routed RPC example</h3>
  * <p>
- * <h5>1. Defining a Context Type</h5>
+ * <h4>1. Defining a Context Type</h4>
  * <p>
  * The following snippet declares a simple YANG <code>identity</code> named <code>example-context</code>:
  *
- * <pre>
+ * {@code
  * module example {
  *     ...
  *     identity example-context {
@@ -80,7 +80,7 @@ import org.opendaylight.yangtools.yang.binding.RpcService;
  *     }
  *     ...
  * }
- * </pre>
+ * }
  * <p>
  * We then use the declared identity to define a context type by using it in combination
  * with the <code>context-instance</code> YANG extension. We'll associate the context type
@@ -90,7 +90,7 @@ import org.opendaylight.yangtools.yang.binding.RpcService;
  * The following YANG snippet imports the <code>yang-ext</code> module and defines the list
  * element named <code>item</code> inside a container named <code>foo</code>:
  *
- * <pre>
+ * {@code
  * module foo {
  *     ...
  *     import yang-ext {prefix ext;}
@@ -104,7 +104,7 @@ import org.opendaylight.yangtools.yang.binding.RpcService;
  *     }
  *     ...
  * }
- * </pre>
+ * }
  * <p>
  * The statement <code>ext:context-instance "example-context";</code> inside the list element
  * declares that any instance identifier referencing <code>item</code> in the data
@@ -257,7 +257,7 @@ public interface RpcProviderRegistry extends //
      * @param serviceInterface the YANG-generated interface of the RPC Service for which to register.
      * @param implementation the implementation instance to register.
      * @return a RoutedRpcRegistration instance which can be used to register paths for the RPC
-     *         implementation via invoking {@link RoutedRpcRegistration#registerPath(....).
+     *         implementation via invoking RoutedRpcRegistration#registerPath(Class, InstanceIdentifer).
      *         {@link RoutedRpcRegistration#close()} should be called to unregister the implementation
      *         and all previously registered paths when no longer needed.
      *
index d1f9d3e..47855da 100644 (file)
@@ -29,10 +29,10 @@ public interface DataBrokerService extends BindingAwareService,
      *
      * @return new blank data modification transaction.
      * @deprecated Replaced by more specific transaction types. Please use
-     *          {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadOnlyTransaction(),
-     *          {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadWriteTransaction()
+     *          {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadOnlyTransaction()},
+     *          {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadWriteTransaction()}
      *          or
-     *          {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newWriteOnlyTransaction().
+     *          {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newWriteOnlyTransaction()}.
      */
     @Deprecated
     DataModificationTransaction beginTransaction();
index b769812..7e72bd4 100644 (file)
@@ -17,15 +17,11 @@ import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 import org.opendaylight.yangtools.yang.common.RpcResult;
 
 /**
- *
- *
  * @deprecated Replaced by more specific transaction types. Please use
- *          {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadOnlyTransaction(),
- *          {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadWriteTransaction()
+ *          {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadOnlyTransaction()},
+ *          {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadWriteTransaction()}
  *          or
- *          {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newWriteOnlyTransaction().
- *
- *
+ *          {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newWriteOnlyTransaction()}.
  */
 @Deprecated
 public interface DataModificationTransaction extends
@@ -41,7 +37,7 @@ public interface DataModificationTransaction extends
      * Initiates a two-phase commit of candidate data.
      *
      * <p>
-     * The {@link Consumer} could initiate a commit of candidate data
+     * The Consumer could initiate a commit of candidate data
      *
      * <p>
      * The successful commit changes the state of the system and may affect
@@ -49,15 +45,11 @@ public interface DataModificationTransaction extends
      *
      * <p>
      * The effects of successful commit of data are described in the
-     * specifications and YANG models describing the {@link Provider} components
-     * of controller. It is assumed that {@link Consumer} has an understanding
+     * specifications and YANG models describing the Provider components
+     * of controller. It is assumed that the Consumer has an understanding
      * of this changes.
      *
      *
-     * @see org.opendaylight.controller.md.sal.common.api.data.DataCommitHandler for further information how two-phase commit is
-     *      processed.
-     * @param store
-     *            Identifier of the store, where commit should occur.
      * @return Result of the commit, containing success information or list of
      *         encountered errors, if commit was not successful.
      */
index fc0d396..cc3ee4b 100644 (file)
@@ -26,10 +26,10 @@ import com.google.common.base.Preconditions;
  * To get instance of synchronized wrapper use {@link #from(DataModificationTransaction)}
  *
  * @deprecated Replaced by more specific transaction types. Please use
- *          {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadOnlyTransaction(),
- *          {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadWriteTransaction()
+ *          {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadOnlyTransaction()},
+ *          {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newReadWriteTransaction()}
  *          or
- *          {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newWriteOnlyTransaction().
+ *          {@link org.opendaylight.controller.md.sal.binding.api.DataBroker#newWriteOnlyTransaction()}.
  *
  */
 @Deprecated
index 3264309..65cef56 100644 (file)
@@ -29,7 +29,7 @@ import org.slf4j.LoggerFactory;
  * expected to arrive in a given time interval does not arrive. It attempts to keep track of all the messages that
  * received between the arrival of two instances of the same message and the amount of time it took to process each
  * of those messages.
- * <br/>
+ * <br>
  * Usage of the API is as follows,
  * <pre>
  *
index 5e631b9..523417e 100644 (file)
@@ -17,7 +17,8 @@ import org.opendaylight.controller.cluster.reporting.MetricsReporter;
 
 /**
  * Represents behaviour that can be exhibited by actors of type {@link akka.actor.UntypedActor}
- * <p/>
+ *
+ * <p>
  * This behaviour meters actor's default behaviour. It captures 2 metrics:
  * <ul>
  *     <li>message processing rate of actor's receive block</li>
@@ -70,11 +71,13 @@ public class MeteringBehavior implements Procedure<Object> {
     /**
      * Uses 2 timers to measure message processing rate. One for overall message processing rate and
      * another to measure rate by message type. The timers are re-used if they were previously created.
-     * <p/>
+     *
+     * <p>
      * {@link com.codahale.metrics.MetricRegistry} maintains a reservoir for different timers where
      * collected timings are kept. It exposes various metrics for each timer based on collected
      * data. Eg: count of messages, 99, 95, 50... percentiles, max, mean etc.
-     * <p/>
+     *
+     * <p>
      * These metrics are exposed as JMX bean.
      *
      * @see <a href="http://dropwizard.github.io/metrics/manual/core/#timers">
index c41d707..95f1372 100644 (file)
@@ -19,7 +19,8 @@ import org.opendaylight.controller.cluster.common.actor.AbstractUntypedActor;
 /**
  * The RoleChangeNotifier is responsible for receiving Raft role and leader state change messages and notifying
  * the listeners (within the same node), which are registered with it.
- * <p/>
+ *
+ * <p>
  * The RoleChangeNotifier is instantiated by the Shard and injected into the RaftActor.
  */
 public class RoleChangeNotifier extends AbstractUntypedActor implements AutoCloseable {
index 1d0a103..b970ba4 100644 (file)
@@ -11,7 +11,8 @@ package org.opendaylight.controller.cluster.raft.protobuff.client.messages;
 /**
  * An instance of a Payload class is meant to be used as the Payload for
  * AppendEntries.
- * <p/>
+ *
+ * <p>
  * When an actor which is derived from RaftActor attempts to persistData it
  * must pass an instance of the Payload class. Similarly when state needs to
  * be applied to the derived RaftActor it will be passed an instance of the
index 9b93744..3dbb612 100644 (file)
@@ -17,7 +17,8 @@ import com.google.common.cache.LoadingCache;
  * Maintains metrics registry that is provided to reporters.
  * At the moment only one reporter exists {@code JmxReporter}.
  * More reporters can be added.
- * <p/>
+ *
+ * <p>
  * The consumers of this class will only be interested in {@code MetricsRegistry}
  * where metrics for that consumer gets stored.
  */
index 35f23a4..7cb672e 100644 (file)
@@ -15,10 +15,9 @@ import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 
 /**
- * <p></p>
  * A clustered Entity is something which is shared by multiple applications across a cluster. An Entity has a type
  * and an identifier.
- * </p>
+ *
  * <p>
  * The type describes the type of the Entity where examples of a type maybe "openflow" or "netconf"
  * etc. An Entity type could be tied to how exactly an application shares and "owns" an entity. For example we may want
@@ -26,16 +25,15 @@ import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  * first served basis. On the other hand for netconf entity types we may want applications to gain ownership based on
  * a load balancing approach. While this mechanism of assigning a ownership acquisition strategy is not finalized the
  * intention is that the entity type will play a role in determining the strategy and thus should be put in place.
- * </p>
+ *
  * <p>
  * The identifier is a YangInstanceIdentifier. The reason for the choice of YangInstanceIdentifier is because it
  * can easily be used to represent a data node. For example an inventory node represents a shared entity and it is best
  * referenced by the YangInstanceIdentifier if the inventory node is stored in the data store.
- * </p>
+ *
+ * <p>
  * Note that an entity identifier must conform to a valid yang schema. If there is no existing yang schema to
  * represent an entity, the general-entity yang model can be used.
- * <p>
- * </p>
  */
 public final class Entity implements Serializable {
     private static final long serialVersionUID = 1L;
index a0d029c..b966589 100644 (file)
@@ -49,6 +49,7 @@ public interface AsyncConfigurationCommitHandler<P extends Path<P>, D> {
      * </li>
      * </ul>
      * </li>
+     * </ul>
      * @param request
      *            Commit Request submitted by client, which contains
      *            information about modifications and read-only view as
index 8265fc4..2af9f05 100644 (file)
@@ -97,8 +97,7 @@ public interface AsyncDataBroker<P extends Path<P>, D, L extends AsyncDataChange
      * </pre>
      *
      *
-     * @see http://www.idevelopment.info/data/LDAP/LDAP_Resources/
-     *      SEARCH_Setting_the_SCOPE_Parameter.shtml
+     * @see <a href="http://www.idevelopment.info/data/LDAP/LDAP_Resources/SEARCH_Setting_the_SCOPE_Parameter.shtml">LDAP</a>
      */
     enum DataChangeScope {
 
index 53194b3..a7a9fef 100644 (file)
@@ -43,8 +43,10 @@ public interface AsyncDataChangeListener<P extends Path<P>, D> extends EventList
      *
      * <p>
      * <b>Note</b>: This method may be invoked from a shared thread pool.
+     * <ul>
      * <li>Implementations <b>SHOULD NOT</b> perform CPU-intensive operations on the calling thread.
      * <li>Implementations <b>MUST NOT block the calling thread</b> - to do so could lead to deadlock
+     * </ul>
      * scenarios.
      *
      *<br>
index afa8670..053d634 100644 (file)
@@ -55,9 +55,6 @@ import org.opendaylight.yangtools.concepts.Path;
  *            tree
  * @param <D>
  *            Type of data (payload), which represents data payload
- *
- * @see org.opendaylight.controller.md.sal.binding.api.ReadTransaction
- * @see org.opendaylight.controller.md.sal.dom.api.DOMDataReadTransaction
  */
 public interface AsyncReadTransaction<P extends Path<P>, D> extends AsyncTransaction<P, D> {
 
index e47b54a..cc22bb9 100644 (file)
@@ -132,8 +132,6 @@ public interface AsyncWriteTransaction<P extends Path<P>, D> extends AsyncTransa
      * <p>
      * This call logically seals the transaction, which prevents the client from
      * further changing data tree using this transaction. Any subsequent calls to
-     * {@link #put(LogicalDatastoreType, Path, Object)},
-     * {@link #merge(LogicalDatastoreType, Path, Object)} or
      * {@link #delete(LogicalDatastoreType, Path)} will fail with
      * {@link IllegalStateException}.
      *
@@ -149,24 +147,24 @@ public interface AsyncWriteTransaction<P extends Path<P>, D> extends AsyncTransa
      * The effects of a successful commit of data depends on data change listeners
      * ({@link AsyncDataChangeListener}) and commit participants
      * ({@link AsyncConfigurationCommitHandler}) that are registered with the data broker.
-     * <p>
+     *
      * <h3>Example usage:</h3>
      * <pre>
      *  private void doWrite( final int tries ) {
      *      WriteTransaction writeTx = dataBroker.newWriteOnlyTransaction();
      *
      *      MyDataObject data = ...;
-     *      InstanceIdentifier<MyDataObject> path = ...;
+     *      InstanceIdentifier&lt;MyDataObject&gt; path = ...;
      *      writeTx.put( LogicalDatastoreType.OPERATIONAL, path, data );
      *
-     *      Futures.addCallback( writeTx.submit(), new FutureCallback<Void>() {
+     *      Futures.addCallback( writeTx.submit(), new FutureCallback&lt;Void&gt;() {
      *          public void onSuccess( Void result ) {
      *              // succeeded
      *          }
      *
      *          public void onFailure( Throwable t ) {
      *              if( t instanceof OptimisticLockFailedException ) {
-     *                  if( ( tries - 1 ) > 0 ) {
+     *                  if( ( tries - 1 ) &lt; 0 ) {
      *                      // do retry
      *                      doWrite( tries - 1 );
      *                  } else {
@@ -214,7 +212,7 @@ public interface AsyncWriteTransaction<P extends Path<P>, D> extends AsyncTransa
      * which are based on same initial state, Tx 1 completes successfully
      * before Tx 2 is submitted.
      *
-     * <table>
+     * <table summary="">
      * <tr><th>Initial state</th><th>Tx 1</th><th>Tx 2</th><th>Result</th></tr>
      * <tr><td>Empty</td><td>put(A,1)</td><td>put(A,2)</td><td>Tx 2 will fail, state is A=1</td></tr>
      * <tr><td>Empty</td><td>put(A,1)</td><td>merge(A,2)</td><td>A=2</td></tr>
@@ -238,7 +236,7 @@ public interface AsyncWriteTransaction<P extends Path<P>, D> extends AsyncTransa
      * which are based on same initial state, Tx 1 completes successfully
      * before Tx 2 is submitted.
      *
-     * <table>
+     * <table summary="">
      * <tr><th>Initial state</th><th>Tx 1</th><th>Tx 2</th><th>Result</th></tr>
      *
      * <tr><td>Empty</td><td>put(TOP,[])</td><td>put(TOP,[])</td><td>Tx 2 will fail, state is TOP=[]</td></tr>
index f90098c..5356c56 100644 (file)
@@ -85,11 +85,6 @@ public interface DataModification<P extends Path<P>, D> extends DataChange<P, D>
      * controller. It is assumed that Consumer has an understanding of this
      * changes.
      *
-     *
-     * @see DataCommitHandler for further information how two-phase commit is
-     *      processed.
-     * @param store
-     *            Identifier of the store, where commit should occur.
      * @return Result of the Commit, containing success information or list of
      *         encountered errors, if commit was not successful. The Future
      *         blocks until {@link TransactionStatus#COMMITED} or
index 11f2803..12d9da6 100644 (file)
@@ -26,7 +26,7 @@ import org.opendaylight.yangtools.concepts.Path;
  * t1.submit();
  *
  * AsyncReadTransaction t2 = broker.newReadOnlyTransaction();
- * Optional<?> maybeData = t2.read(id).get();
+ * Optional&lt;?&gt; maybeData = t2.read(id).get();
  *
  * it may happen, that it sees maybeData.isPresent() == false, simply because
  * t1 has not completed the processes of being applied and t2 is actually
index 9646adc..dd89e00 100644 (file)
@@ -13,7 +13,7 @@ import java.util.List;
 import org.opendaylight.yangtools.util.concurrent.ListenerNotificationQueueStats;
 
 /**
- * MXBean interface for {@link QueuedNotificationManager} statistic metrics.
+ * MXBean interface for {@link org.opendaylight.yangtools.util.concurrent.QueuedNotificationManager} statistic metrics.
  *
  * @author Thomas Pantelis
  */
index e1f2777..cee7344 100644 (file)
@@ -25,7 +25,7 @@ import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 /**
  * Actor for a DataChangeListener.
  *
- * @Deprecated Replaced by {@link DataTreeChangeListener}
+ * @deprecated Replaced by {@link DataTreeChangeListener}
  */
 @Deprecated
 public class DataChangeListener extends AbstractUntypedActor {
index 4a1be98..26f18bd 100644 (file)
@@ -93,7 +93,8 @@ import scala.concurrent.duration.FiniteDuration;
 
 /**
  * A Shard represents a portion of the logical data tree.
- * <p/>
+ *
+ * <p>
  * Our Shard uses InMemoryDataTree as it's internal representation and delegates all requests it
  */
 public class Shard extends RaftActor {
index ef6436a..f18271a 100644 (file)
@@ -77,7 +77,8 @@ import scala.concurrent.duration.Duration;
  * Internal shard state, similar to a DOMStore, but optimized for use in the actor system,
  * e.g. it does not expose public interfaces and assumes it is only ever called from a
  * single thread.
- * <p/>
+ *
+ * <p>
  * This class is not part of the API contract and is subject to change at any time.
  */
 @NotThreadSafe
index 1e23120..b62b056 100644 (file)
@@ -32,7 +32,8 @@ interface TransactionContext {
      * Invoked by {@link TransactionContextWrapper} when it has finished handing
      * off operations to this context. From this point on, the context is responsible
      * for throttling operations.
-     * <p/>
+     *
+     * <p>
      * Implementations can rely on the wrapper calling this operation in a synchronized
      * block, so they do not need to ensure visibility of this state transition themselves.
      */
index 986cca5..d177498 100644 (file)
@@ -20,7 +20,8 @@ import scala.concurrent.Future;
 /**
  * A {@link Mapper} extracting the {@link ActorSelection} pointing to the actor which
  * is backing a particular transaction.
- * <p/>
+ *
+ * <p>
  * This class is not for general consumption. It is public only to support the pre-lithium compatibility
  * package.
  * TODO: once we remove compatibility, make this class package-private and final.
index 919f944..ff2c89c 100644 (file)
@@ -14,8 +14,8 @@ import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
 /**
  * A message about a DataTree having been changed. The message is not
  * serializable on purpose. For delegating the change across cluster nodes,
- * this needs to be intercepted by a local agent and forwarded as
- * a {@link DataTreeDelta}.
+ * this needs to be intercepted by a local agent and forwarded as reconstructed
+ * candidate.
  */
 public final class DataTreeChanged {
     private final Collection<DataTreeCandidate> changes;
index 380e71e..0179d8e 100644 (file)
@@ -10,14 +10,14 @@ package org.opendaylight.controller.cluster.datastore.messages;
 
 /**
  * FindLocalShard is a message that should be sent to the
- * {@link org.opendaylight.controller.cluster.datastore.shardmanager.ShardManager} when we need to find a reference
+ * org.opendaylight.controller.cluster.datastore.shardmanager.ShardManager when we need to find a reference
  * to a LocalShard.
  */
 public class FindLocalShard {
     private final String shardName;
     private final boolean waitUntilInitialized;
 
-    public FindLocalShard(String shardName, boolean waitUntilInitialized) {
+    public FindLocalShard(final String shardName, final boolean waitUntilInitialized) {
         this.shardName = shardName;
         this.waitUntilInitialized = waitUntilInitialized;
     }
index 5c58a89..9e546f8 100644 (file)
@@ -12,13 +12,13 @@ import akka.actor.ActorRef;
 
 /**
  * LocalShardFound is a message that is sent by the
- * {@link org.opendaylight.controller.cluster.datastore.shardmanager.ShardManager}
+ * org.opendaylight.controller.cluster.datastore.shardmanager.ShardManager
  * when it finds a shard with the specified name in it's local shard registry.
  */
 public class LocalShardFound {
     private final ActorRef path;
 
-    public LocalShardFound(ActorRef path) {
+    public LocalShardFound(final ActorRef path) {
         this.path = path;
     }
 
index 381eb56..47ec169 100644 (file)
@@ -10,7 +10,7 @@ package org.opendaylight.controller.cluster.datastore.messages;
 
 /**
  * LocalShardNotFound is a message that is sent by the
- * {@link org.opendaylight.controller.cluster.datastore.shardmanager.ShardManager}
+ * org.opendaylight.controller.cluster.datastore.shardmanager.ShardManager
  * when it cannot locate a shard in it's local registry with the shardName specified.
  */
 public class LocalShardNotFound {
@@ -21,7 +21,7 @@ public class LocalShardNotFound {
      *
      * @param shardName the name of the shard that could not be found
      */
-    public LocalShardNotFound(String shardName) {
+    public LocalShardNotFound(final String shardName) {
         this.shardName = shardName;
     }
 
index 97b5e74..a04fbd0 100644 (file)
@@ -14,18 +14,19 @@ import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification
 
 /**
  * Represents a modification to the data store.
+ *
  * <p>
  * Simple modifications can be of type,
+ * <ul>
  * <li> {@link org.opendaylight.controller.cluster.datastore.modification.WriteModification}
  * <li> {@link org.opendaylight.controller.cluster.datastore.modification.MergeModification}
  * <li> {@link org.opendaylight.controller.cluster.datastore.modification.DeleteModification}
- * </p>
+ * </ul>
  *
  * <p>
  * Modifications can in turn be lumped into a single
  * {@link org.opendaylight.controller.cluster.datastore.modification.CompositeModification}
  * which can then be applied to a write transaction.
- * </p>
  */
 public interface Modification extends Externalizable {
 
index 0f52dac..1dbbcba 100644 (file)
@@ -19,9 +19,12 @@ import org.opendaylight.yangtools.concepts.WritableObject;
 /**
  * Enumeration of all ABI versions supported by this implementation of persistence. An ABI version has to be bumped
  * whenever:
- * - a new event is defined
- * - serialization format is changed
- * <p/>
+ * <ul>
+ * <li>a new event is defined</li>
+ * <li>serialization format is changed</li>
+ * </ul>
+ *
+ * <p>
  * This version effectively defines the protocol version between actors participating on a particular shard. A shard
  * participant instance should oppose RAFT candidates which produce persistence of an unsupported version. If a follower
  * encounters an unsupported version it must not become fully-operational, as it does not have an accurate view
index 25cfda0..0ddc785 100644 (file)
@@ -17,11 +17,13 @@ import javax.annotation.Nonnull;
  * an interface because we want to make sure all subclasses implement the externalizable proxy pattern, for which
  * we need to force {@link #writeReplace()} to be abstract. We do that by making it final and exposing a protected
  * {@link #externalizableProxy()} method.
- * <p/>
+ *
+ * <p>
  * All concrete subclasses of this class should be final so as to form a distinct set of possible metadata. Since
  * metadata is serialized along with {@link MetadataShardDataTreeSnapshot}, this set is part of the serialization format
  * guarded by {@link PayloadVersion}.
- * <p/>
+ *
+ * <p>
  * If a new metadata type is introduced or a type is removed, {@link PayloadVersion} needs to be bumped to ensure
  * compatibility.
  *
index 0440b7f..496069d 100644 (file)
@@ -16,7 +16,8 @@ import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 public interface ShardStrategy {
     /**
      * Find the name of the shard in which the data pointed to by the specified path belongs in.
-     * <p/>
+     *
+     * <p>
      * Should return the name of the default shard DefaultShardStrategy.DEFAULT_SHARD
      * if no matching shard was found
      *
index 083cd10..7392b15 100644 (file)
@@ -36,7 +36,7 @@ public interface DOMDataTreeListener extends EventListener {
      * a connection to external subtree source is broken. The listener will not receive any other
      * callbacks, but its registration still needs to be closed to prevent resource leak.
      *
-     * @param cause Collection of failure causes, may not be null or empty.
+     * @param causes Collection of failure causes, may not be null or empty.
      */
     void onDataTreeFailed(@Nonnull Collection<DOMDataTreeListeningException> causes);
 }
index cbfa012..48f47d1 100644 (file)
@@ -44,14 +44,14 @@ public interface DOMDataTreeProducer extends DOMDataTreeProducerFactory, AutoClo
      * previously allocated must have been either submitted or cancelled by the
      * time this method is invoked.
      *
-     * @param barrier Indicates whether this transaction should be a barrier. A barrier
+     * @param isolated Indicates whether this transaction should be a barrier. A barrier
      *                transaction is processed separately from any preceding transactions.
      *                Non-barrier transactions may be merged and processed in a batch,
      *                such that any observers see the modifications contained in them as
      *                if the modifications were made in a single transaction.
      * @return A new {@link DOMDataWriteTransaction}
-     * @throws {@link IllegalStateException} if a previous transaction was not closed.
-     * @throws {@link IllegalThreadStateException} if the calling thread context does not
+     * @throws IllegalStateException if a previous transaction was not closed.
+     * @throws IllegalThreadStateException if the calling thread context does not
      *         match the lifecycle rules enforced by the producer state (e.g. bound or unbound).
      *         This exception is thrown on a best effort basis and programs should not rely
      *         on it for correct operation.
@@ -73,10 +73,10 @@ public interface DOMDataTreeProducer extends DOMDataTreeProducerFactory, AutoClo
      * Once this method returns successfully, this (parent) producer loses the ability to
      * access the specified paths until the resulting (child) producer is shut down.
      *
-     * @throws {@link IllegalStateException} if there is an open transaction
-     * @throws {@link IllegalArgumentException} if subtrees contains a subtree which is not
+     * @throws IllegalStateException if there is an open transaction
+     * @throws IllegalArgumentException if subtrees contains a subtree which is not
      *         accessible by this producer
-     * @throws {@link IllegalThreadStateException} if the calling thread context does not
+     * @throws IllegalThreadStateException if the calling thread context does not
      *         match the lifecycle rules enforced by the producer state (e.g. bound or unbound).
      *         This exception is thrown on a best effort basis and programs should not rely
      *         on it for correct operation.
index 89ac8d1..46726da 100644 (file)
@@ -20,7 +20,7 @@ public interface DOMDataTreeProducerFactory {
      *
      * @param subtrees The collection of subtrees the resulting producer should have access to.
      * @return A {@link DOMDataTreeProducer} instance.
-     * @throws {@link IllegalArgumentException} if subtrees is empty.
+     * @throws IllegalArgumentException if subtrees is empty.
      */
     @Nonnull DOMDataTreeProducer createProducer(@Nonnull Collection<DOMDataTreeIdentifier> subtrees);
 }
index 21ff44c..bb4d547 100644 (file)
@@ -58,5 +58,5 @@ public interface DOMDataTreeService extends DOMDataTreeProducerFactory, DOMServi
      *                                  feedback loop
      */
     @Nonnull <T extends DOMDataTreeListener> ListenerRegistration<T> registerListener(@Nonnull T listener,
-        @Nonnull Collection<DOMDataTreeIdentifier> subtrees, boolean allowRxMerges, @Nonnull Collection<DOMDataTreeProducer> producers);
+        @Nonnull Collection<DOMDataTreeIdentifier> subtrees, boolean allowRxMerges, @Nonnull Collection<DOMDataTreeProducer> producers) throws DOMDataTreeLoopException;
 }
index b8fe263..76999ec 100644 (file)
@@ -19,6 +19,9 @@ import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  */
 public interface DOMDataWriteTransaction extends AsyncWriteTransaction<YangInstanceIdentifier, NormalizedNode<?, ?>> {
 
+    @Override
+    void delete(LogicalDatastoreType store, YangInstanceIdentifier path);
+
     /**
      * Stores a piece of data at the specified path. This acts as an add / replace
      * operation, which is to say that whole subtree will be replaced by the specified data.
index 2233442..7e9d56e 100644 (file)
@@ -16,8 +16,8 @@ import javax.annotation.Nonnull;
  * Aside for marking these, they also provide runtime query to detect whether
  * a particular trait is in fact available.
  *
- * <T> Base {@link DOMService}
- * <E> Extension type
+ * @param <T> Base {@link DOMService}
+ * @param <E> Extension type
  */
 @Beta
 public interface DOMExtensibleService<T extends DOMExtensibleService<T, E>, E extends DOMServiceExtension<T, E>> extends DOMService {
index b4df6b4..f80a124 100644 (file)
@@ -41,12 +41,15 @@ public interface DOMNotificationPublishService extends DOMService, BrokerService
      * Abstract subclasses can refine the return type as returning a promise of a
      * more specific type, e.g.:
      *
+     * {@code
      *     public interface DeliveryStatus { int getListenerCount(); }
      *     ListenableFuture<? extends DeliveryStatus> putNotification(DOMNotification notification);
+     * }
      *
      * Once the Future succeeds, the resulting object can be queried for traits using
      * instanceof, e.g:
      *
+     * {@code
      *     // Can block when (for example) the implemention's ThreadPool queue is full
      *     Object o = service.putNotification(notif).get();
      *     if (o instanceof DeliveryStatus) {
@@ -83,7 +86,7 @@ public interface DOMNotificationPublishService extends DOMService, BrokerService
      * @param notification Notification to be published.
      * @return A listenable future which will report completion when the service
      *         has finished propagating the notification to its immediate registrants,
-     *         or {@value #REJECTED} if resource constraints prevent
+     *         or {@link #REJECTED} if resource constraints prevent
      *         the implementation from accepting the notification for delivery.
      * @throws NullPointerException if notification is null.
      */
@@ -102,7 +105,7 @@ public interface DOMNotificationPublishService extends DOMService, BrokerService
      * @param unit a TimeUnit determining how to interpret the timeout parameter
      * @return A listenable future which will report completion when the service
      *         has finished propagating the notification to its immediate registrants,
-     *         or {@value #REJECTED} if resource constraints prevent
+     *         or {@link #REJECTED} if resource constraints prevent
      *         the implementation from accepting the notification for delivery.
      * @throws InterruptedException if interrupted while waiting
      * @throws NullPointerException if notification or unit is null.
index 4d0aa66..b57b505 100644 (file)
@@ -11,10 +11,9 @@ package org.opendaylight.controller.md.sal.dom.api;
  * <p>
  * This exception indicates that given notification can not be processed by corresponding mechanism.
  * More info can be provided in message.
- * <p/>
+ *
  * <p>
  * Expected use: {@link DOMNotificationPublishService}
- * </p>
  */
 public class DOMNotificationRejectedException extends Exception {
     private static final long serialVersionUID = 1L;
index 036ea24..33f009a 100644 (file)
@@ -26,7 +26,7 @@ public interface DOMNotificationService extends DOMService, BrokerService {
      * @param listener Notification instance to register
      * @param types Notification types which should be delivered to the listener. Duplicate
      *              entries are processed only once, null entries are ignored.
-     * @return Registration handle. Invoking {@link DOMNotificationListenerRegistration#close()}
+     * @return Registration handle. Invoking {@link ListenerRegistration#close()}
      *         will stop the delivery of notifications to the listener
      * @throws IllegalArgumentException if types is empty or contains an invalid element, such as
      *         null or a SchemaPath which does not represent a valid {@link DOMNotification} type.
@@ -42,7 +42,7 @@ public interface DOMNotificationService extends DOMService, BrokerService {
      * @param listener Notification instance to register
      * @param types Notification types which should be delivered to the listener. Duplicate
      *              entries are processed only once, null entries are ignored.
-     * @return Registration handle. Invoking {@link DOMNotificationListenerRegistration#close()}
+     * @return Registration handle. Invoking {@link ListenerRegistration#close()}
      *         will stop the delivery of notifications to the listener
      * @throws IllegalArgumentException if types is empty or contains an invalid element, such as
      *         null or a SchemaPath which does not represent a valid {@link DOMNotification} type.
index 48f6ab6..e0c95a1 100644 (file)
@@ -44,8 +44,8 @@ public interface DOMRpcService extends DOMService {
      * to prevent this scenario from occurring.
      *
      * @param listener {@link DOMRpcAvailabilityListener} instance to register
-     * @return A {@link DOMRpcAvailabilityListenerRegistration} representing this registration. Performing
-     *         a {@link DOMRpcAvailabilityListenerRegistration#close()} will cancel it. Returned object
+     * @return A {@link ListenerRegistration} representing this registration. Performing
+     *         a {@link ListenerRegistration#close()} will cancel it. Returned object
      *         is guaranteed to be non-null.
      */
     @Nonnull <T extends DOMRpcAvailabilityListener> ListenerRegistration<T> registerRpcListener(@Nonnull T listener);
index f0c4be2..b5c3977 100644 (file)
@@ -41,7 +41,7 @@ public interface Consumer {
      * @deprecated - no longer used or needed
      * *
      * Suggested implementation until removed:
-     * @code {
+     * {@code
      * public Collection<ConsumerFunctionality> getConsumerFunctionality() {
      *    return Collections.emptySet();
      * }
index 4895d10..ea6f69c 100644 (file)
@@ -45,7 +45,7 @@ public interface Provider {
      * @deprecated - No longer used or needed
      *
      * Suggested implementation until removed:
-     * @code {
+     * {@code
      * public Collection<ProviderFunctionality> getProviderFunctionality() {
      *  return Collections.emptySet();
      * }
index fef26fe..8dde797 100644 (file)
@@ -17,6 +17,7 @@ import java.util.concurrent.atomic.AtomicIntegerFieldUpdater;
 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction;
+import org.opendaylight.controller.md.sal.dom.api.DOMDataReadTransaction;
 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction;
@@ -88,7 +89,7 @@ abstract class AbstractDOMForwardedTransactionFactory<T extends DOMStoreTransact
      *
      * Subtransaction for reading is selected by supplied
      * {@link LogicalDatastoreType} as parameter for
-     * {@link DOMDataReadOnlyTransaction#read(LogicalDatastoreType,org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)}
+     * {@link DOMDataReadOnlyTransaction#read(LogicalDatastoreType,org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)}
      * .
      *
      * Id of returned transaction is retrieved via
@@ -116,27 +117,27 @@ abstract class AbstractDOMForwardedTransactionFactory<T extends DOMStoreTransact
      * <p>
      * Implementation of composite Write-only transaction is following:
      *
-     * <ul>
-     * <li>
-     * {@link DOMDataWriteTransaction#put(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
+     * <ul><li>
+     * {@link DOMDataWriteTransaction#put(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
      * - backing subtransaction is selected by {@link LogicalDatastoreType},
-     * {@link DOMStoreWriteTransaction#write(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
+     * {@link DOMStoreWriteTransaction#write(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
      * is invoked on selected subtransaction.
-     * <li>
-     * {@link DOMDataWriteTransaction#merge(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
+     * </li><li>
+     * {@link DOMDataWriteTransaction#merge(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
      * - backing subtransaction is selected by {@link LogicalDatastoreType},
-     * {@link DOMStoreWriteTransaction#merge(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
+     * {@link DOMStoreWriteTransaction#merge(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
      * is invoked on selected subtransaction.
-     * <li>
-     * {@link DOMDataWriteTransaction#delete(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)
+     * </li><li>
+     * {@link DOMDataWriteTransaction#delete(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)}
      * - backing subtransaction is selected by {@link LogicalDatastoreType},
-     * {@link DOMStoreWriteTransaction#delete(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)} is invoked on
+     * {@link DOMStoreWriteTransaction#delete(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)} is invoked on
      * selected subtransaction.
-     * <li> {@link DOMDataWriteTransaction#commit()} - results in invoking
+     * </li><li> {@link DOMDataWriteTransaction#commit()} - results in invoking
      * {@link DOMStoreWriteTransaction#ready()}, gathering all resulting cohorts
      * and then invoking finalized implementation callback
-     * {@link #submit(DOMDataWriteTransaction, Iterable)} with transaction which
+     * {@link #submit(DOMDataWriteTransaction, Collection)} with transaction which
      * was commited and gathered results.
+     * </li>
      * </ul>
      *
      * Id of returned transaction is generated via
@@ -166,30 +167,30 @@ abstract class AbstractDOMForwardedTransactionFactory<T extends DOMStoreTransact
      *
      * <ul>
      * <li>
-     * {@link DOMDataWriteTransaction#read(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)}
+     * {@link DOMDataReadTransaction#read(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)}
      * - backing subtransaction is selected by {@link LogicalDatastoreType},
-     * {@link DOMStoreWriteTransaction#read(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)} is invoked on
+     * {@link DOMStoreReadTransaction#read(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)} is invoked on
      * selected subtransaction.
      * <li>
-     * {@link DOMDataWriteTransaction#put(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
+     * {@link DOMDataWriteTransaction#put(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
      * - backing subtransaction is selected by {@link LogicalDatastoreType},
-     * {@link DOMStoreWriteTransaction#write(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
+     * {@link DOMStoreWriteTransaction#write(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
      * is invoked on selected subtransaction.
      * <li>
-     * {@link DOMDataWriteTransaction#merge(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
+     * {@link DOMDataWriteTransaction#merge(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
      * - backing subtransaction is selected by {@link LogicalDatastoreType},
-     * {@link DOMStoreWriteTransaction#merge(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
+     * {@link DOMStoreWriteTransaction#merge(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode)}
      * is invoked on selected subtransaction.
      * <li>
-     * {@link DOMDataWriteTransaction#delete(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)
+     * {@link DOMDataWriteTransaction#delete(LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)}
      * - backing subtransaction is selected by {@link LogicalDatastoreType},
-     * {@link DOMStoreWriteTransaction#delete(org.opendaylight.yangtools.yang.data.api.InstanceIdentifier)} is invoked on
+     * {@link DOMStoreWriteTransaction#delete(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier)} is invoked on
      * selected subtransaction.
      * <li> {@link DOMDataWriteTransaction#commit()} - results in invoking
      * {@link DOMStoreWriteTransaction#ready()}, gathering all resulting cohorts
      * and then invoking finalized implementation callback
-     * {@link #submit(DOMDataWriteTransaction, Iterable)} with transaction which
-     * was commited and gathered results.
+     * {@link #submit(DOMDataWriteTransaction, Collection)} with transaction which
+     * was committed and gathered results.
      * <li>
      * </ul>
      *
index 106abca..fba643d 100644 (file)
@@ -22,7 +22,7 @@ import javax.annotation.Nullable;
  *
  * It can optionally capture the context where it was allocated.
  *
- * <T> identifier type
+ * @param <T> identifier type
  */
 @Beta
 public abstract class AbstractDOMStoreTransaction<T> implements DOMStoreTransaction {
index 986a153..ec54e42 100644 (file)
@@ -13,7 +13,7 @@ import com.google.common.util.concurrent.ListenableFuture;
  * Interface implemented by the {@link DOMStore} and exposed for each {@link DOMStoreWriteTransaction}
  * upon its transition to Ready state. The frontend (DOMStore user) uses this interface to drive the
  * commit procedure across potentially multiple DOMStores using the Three-Phase-Commit (3PC) Protocol,
- * as described in {@link https://en.wikipedia.org/wiki/Three-phase_commit}.
+ * as described in <a href="https://en.wikipedia.org/wiki/Three-phase_commit">Three-Phase-Commit Protocol</a>.
  */
 public interface DOMStoreThreePhaseCommitCohort {
 
@@ -29,6 +29,7 @@ public interface DOMStoreThreePhaseCommitCohort {
      *         true if transaction is approved by data store.
      *         <li>false if the transaction is not approved by data store and
      *         should be aborted.
+     *         </ul>
      */
     ListenableFuture<Boolean> canCommit();
 
index 0a09052..1964fd4 100644 (file)
@@ -18,7 +18,7 @@ public interface DOMStoreWriteTransaction extends DOMStoreTransaction {
      * specified path.
      *
      * If you need add or merge of current object with specified use
-     * {@link #merge(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType, org.opendaylight.yangtools.concepts.Path, Object)}
+     * {@link #merge(YangInstanceIdentifier, NormalizedNode)}.
      *
      *
      * @param path
@@ -36,10 +36,6 @@ public interface DOMStoreWriteTransaction extends DOMStoreTransaction {
      * operation, which is to say that whole subtree will be replaced by
      * specified path.
      *
-     * If you need add or merge of current object with specified use
-     * {@link #merge(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType, org.opendaylight.yangtools.concepts.Path, Object)}
-     *
-     *
      * @param path
      * @param data
      *            Data object to be written
index 8e5957c..1e68c61 100644 (file)
@@ -27,7 +27,7 @@ import org.slf4j.LoggerFactory;
  * Implementation of read-only transaction backed by {@link DataTreeSnapshot}
  * which delegates most of its calls to similar methods provided by underlying snapshot.
  *
- * <T> identifier type
+ * @param <T> identifier type
  */
 @Beta
 public final class SnapshotBackedReadTransaction<T> extends AbstractDOMStoreTransaction<T> implements DOMStoreReadTransaction {
index a02d768..dc600dd 100644 (file)
@@ -159,9 +159,6 @@ public class SnapshotBackedWriteTransaction<T> extends AbstractDOMStoreTransacti
     }
 
     /**
-     * Prototype implementation of
-     * {@link #ready(org.opendaylight.controller.sal.core.spi.data.SnapshotBackedWriteTransaction)}
-     *
      * This class is intended to be implemented by Transaction factories
      * responsible for allocation of {@link org.opendaylight.controller.sal.core.spi.data.SnapshotBackedWriteTransaction} and
      * providing underlying logic for applying implementation.
@@ -190,4 +187,4 @@ public class SnapshotBackedWriteTransaction<T> extends AbstractDOMStoreTransacti
          */
         protected abstract DOMStoreThreePhaseCommitCohort transactionReady(SnapshotBackedWriteTransaction<T> tx, DataTreeModification tree);
     }
-}
\ No newline at end of file
+}
index 21e1634..772d446 100644 (file)
         </plugins>
     </build>
 
-    <profiles>
-        <!-- Turn off doclint. -->
-        <profile>
-            <id>jdk8</id>
-            <activation>
-                <jdk>[1.8,)</jdk>
-            </activation>
-            <build>
-                <plugins>
-                    <plugin>
-                        <groupId>org.apache.maven.plugins</groupId>
-                        <artifactId>maven-javadoc-plugin</artifactId>
-                        <configuration>
-                            <additionalparam>-Xdoclint:none</additionalparam>
-                        </configuration>
-                    </plugin>
-                </plugins>
-            </build>
-        </profile>
-    </profiles>
-
     <scm>
         <connection>scm:git:http://git.opendaylight.org/gerrit/controller.git</connection>
         <developerConnection>scm:git:ssh://git.opendaylight.org:29418/controller.git</developerConnection>
index 7c5efc2..43f5dbc 100644 (file)
@@ -34,7 +34,8 @@ import scala.concurrent.duration.FiniteDuration;
 
 /**
  * Registry to look up cluster nodes that have registered for a given rpc.
- * <p/>
+ *
+ * <p>
  * It uses {@link org.opendaylight.controller.remote.rpc.registry.gossip.BucketStore} to maintain this
  * cluster wide information.
  */
index 9230591..439c131 100644 (file)
@@ -44,19 +44,21 @@ import scala.concurrent.duration.FiniteDuration;
 
 /**
  * Gossiper that syncs bucket store across nodes in the cluster.
- * <p/>
+ *
+ * <p>
  * It keeps a local scheduler that periodically sends Gossip ticks to
  * itself to send bucket store's bucket versions to a randomly selected remote
  * gossiper.
- * <p/>
+ *
+ * <p>
  * When bucket versions are received from a remote gossiper, it is compared
  * with bucket store's bucket versions. Which ever buckets are newer
  * locally, are sent to remote gossiper. If any bucket is older in bucket store,
  * a gossip status is sent to remote gossiper so that it can send the newer buckets.
- * <p/>
+ *
+ * <p>
  * When a bucket is received from a remote gossiper, its sent to the bucket store
  * for update.
- *
  */
 public class Gossiper extends AbstractUntypedActorWithMetering {
 
diff --git a/pom.xml b/pom.xml
index 26c9915..58d1fd0 100644 (file)
--- a/pom.xml
+++ b/pom.xml
     <tag>HEAD</tag>
     <url>https://wiki.opendaylight.org/view/OpenDaylight_Controller:Main</url>
   </scm>
-
-  <profiles>
-    <!-- Turn off doclint on aggregated API javadoc build. -->
-    <profile>
-      <id>jdk8</id>
-      <activation>
-        <jdk>[1.8,)</jdk>
-      </activation>
-
-      <build>
-        <plugins>
-          <plugin>
-            <groupId>org.apache.maven.plugins</groupId>
-            <artifactId>maven-javadoc-plugin</artifactId>
-            <configuration>
-              <additionalparam>-Xdoclint:none</additionalparam>
-            </configuration>
-          </plugin>
-        </plugins>
-      </build>
-    </profile>
-  </profiles>
 </project>

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.