Fix javadoc HTML5 compliance 31/80931/2
authorRobert Varga <robert.varga@pantheon.tech>
Sat, 16 Mar 2019 11:57:58 +0000 (12:57 +0100)
committerRobert Varga <robert.varga@pantheon.tech>
Sat, 16 Mar 2019 12:11:49 +0000 (13:11 +0100)
This fixes up javadocs so that they are HTML5-compliant.

Change-Id: Ie62191a3235903ecba5be46a5423b878afa67553
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/CursorAwareWriteTransaction.java
binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/WriteTransaction.java
dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMDataTreeCursorAwareTransaction.java
dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMDataTreeWriteTransaction.java

index fd2585812786af94a85e0f845368fddd9bdc90e3..a47589d232c9fefc216698732ff5cf455e4969e3 100644 (file)
@@ -45,9 +45,8 @@ public interface CursorAwareWriteTransaction extends DataTreeCursorProvider {
      * Invoking cancel() on finished transaction (future returned by {@link #commit()} already
      * successfully completed) will always fail (return false).
      *
-     * @return <tt>false</tt> if the task could not be cancelled, typically because it has already
-     *         completed normally; <tt>true</tt> otherwise
-     *
+     * @return {@code false} if the task could not be cancelled, typically because it has already
+     *         completed normally; {@code true} otherwise
      */
     boolean cancel();
 
index 7095cfde44f3a9e53821b442c6137288c4f5912f..32015b5f037eccaf92e8b686512f826e095b78bc 100644 (file)
@@ -89,8 +89,8 @@ public interface WriteTransaction extends Transaction, WriteOperations {
      * Invoking cancel() on finished transaction (future returned by {@link #commit()} already successfully completed)
      * will always fail (return false).
      *
-     * @return <tt>false</tt> if the task could not be cancelled, typically because it has already completed normally;
-     *         <tt>true</tt> otherwise
+     * @return {@code false} if the task could not be cancelled, typically because it has already completed normally;
+     *         {@code true} otherwise
      */
     boolean cancel();
 
@@ -172,7 +172,8 @@ public interface WriteTransaction extends Transaction, WriteOperations {
      * Following table shows state changes and failures between two concurrent transactions, which are based on same
      * initial state, Tx 1 completes successfully before Tx 2 is committed.
      *
-     * <table summary="Change compatibility of leaf values">
+     * <table>
+     * <caption>Change compatibility of leaf values</caption>
      * <tr>
      * <th>Initial state</th>
      * <th>Tx 1</th>
@@ -249,7 +250,8 @@ public interface WriteTransaction extends Transaction, WriteOperations {
      * Following table shows state changes and failures between two concurrent transactions, which are based on same
      * initial state, Tx 1 completes successfully before Tx 2 is committed.
      *
-     * <table summary="Change compatibility of containers">
+     * <table>
+     * <caption>Change compatibility of containers</caption>
      * <tr>
      * <th>Initial state</th>
      * <th>Tx 1</th>
index 6bec2776b34c9d6ebda2b9974f8ca2a3ed8521f4..691b736c606c24af668c1870596cbe510ddbdf7b 100644 (file)
@@ -37,9 +37,8 @@ public interface DOMDataTreeCursorAwareTransaction extends DOMDataTreeCursorProv
      * Invoking cancel() on a finished transaction (future returned by {@link #commit()} already
      * successfully completed will always fail (return false).
      *
-     * @return <tt>false</tt> if the task could not be cancelled, typically because it has already
-     *         completed normally; <tt>true</tt> otherwise
-     *
+     * @return {@code false} if the task could not be cancelled, typically because it has already
+     *         completed normally; {@code true} otherwise
      */
     boolean cancel();
 
index 31f16280e15af95e1c7b132b8bb9f154deb55655..989ed4751a49e9d54a42c3911c6897326a19bf68 100644 (file)
@@ -166,7 +166,8 @@ public interface DOMDataTreeWriteTransaction extends DOMDataTreeTransaction, DOM
      * Following table shows state changes and failures between two concurrent transactions, which are based on same
      * initial state, Tx 1 completes successfully before Tx 2 is committed.
      *
-     * <table summary="Change compatibility of leaf values">
+     * <table>
+     * <caption>Change compatibility of leaf values</caption>
      * <tr>
      * <th>Initial state</th>
      * <th>Tx 1</th>
@@ -243,7 +244,8 @@ public interface DOMDataTreeWriteTransaction extends DOMDataTreeTransaction, DOM
      * Following table shows state changes and failures between two concurrent transactions, which are based on same
      * initial state, Tx 1 completes successfully before Tx 2 is committed.
      *
-     * <table summary="Change compatibility of containers">
+     * <table>
+     * <caption>Change compatibility of containers</caption>
      * <tr>
      * <th>Initial state</th>
      * <th>Tx 1</th>
@@ -445,8 +447,8 @@ public interface DOMDataTreeWriteTransaction extends DOMDataTreeTransaction, DOM
      * Invoking cancel() on finished transaction (future returned by {@link #commit()} already successfully completed)
      * will always fail (return false).
      *
-     * @return <tt>false</tt> if the task could not be cancelled, typically because it has already completed normally;
-     *         <tt>true</tt> otherwise
+     * @return {@code false} if the task could not be cancelled, typically because it has already completed normally;
+     *         {@code true} otherwise
      */
     boolean cancel();
 }