Fix checkstyle violations in sal-binding-api

[controller.git] / opendaylight / md-sal / sal-binding-api / src / main / java / org / opendaylight / controller / sal / binding / api / NotificationService.java

diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/NotificationService.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/NotificationService.java
index dd66aa67f8a78451e9c31b851987455678306ea7..8f3e1470e48e6c6a109781081193b3d35fd3f01f 100644 (file)
--- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/NotificationService.java
+++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/sal/binding/api/NotificationService.java
@@ -20,15 +20,19 @@ 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>
  * A generic listener implements the {@link NotificationListener} interface which has one callback method
  * <code>onNotification</code> that is invoked for any notification type the listener is subscribed to.
+ *
  * <p>
  * A generic listener is subscribed using the {@link #registerNotificationListener(Class, NotificationListener)}
  * method by which you specify the type of notification to receive. A generic listener may be registered for
  * multiple notification types via multiple subscriptions.
+ *
  * <p>
  * Generic listeners allow for a more flexible approach, allowing you to subscribe for just
  * one type of notification from a YANG model. You could also have a general subscription
@@ -38,20 +42,22 @@ import org.opendaylight.yangtools.yang.binding.Notification;
  * </pre>
  *
  * <h3>Dispatch Listener</h3>
+ *
  * <p>
  * A dispatch listener implements a YANG-generated module interface <code>{ModuleName}Listener</code>
  * which handles all the notifications defined in the YANG model. Each notification type translates to
  * a specific method of the form <code>on{NotificationType}</code> on the generated interface.
  * The generated interface also extends the
  * {@link org.opendaylight.yangtools.yang.binding.NotificationListener} interface and implementations
- * are registered using {@link #registerNotificationListener(org.opendaylight.yangtools.yang.binding.NotificationListener)}
- * method.
+ * are registered using
+ * {@link #registerNotificationListener(org.opendaylight.yangtools.yang.binding.NotificationListener)} method.
+ *
+ * <h4>Dispatch Listener Example</h4>
  *
- * <h5>Dispatch Listener Example</h5>
  * <p>
  * Lets assume we have following YANG model:
  *
- * <pre>
+ * {@code
  * module example {
  *      ...
  *
@@ -63,17 +69,18 @@ import org.opendaylight.yangtools.yang.binding.Notification;
  *           ...
  *      }
  * }
- * </pre>
+ * }
  *
+ * <p>
  * 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 +90,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.
  *