Clarify NotificationListener purpose

This adds a comment about what the intended use of NotificationListener.

Change-Id: I84116fda4f7f68d63e8ad0e97365087df01b564a
Signed-off-by: Robert Varga <rovarga@cisco.com>

diff --git a/yang/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/NotificationListener.java b/yang/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/NotificationListener.java
index 3a8a786a7fa978b84551bfaf78e8db2ef0abc680..6737cf55c892f9c4f4b3847823464888a1da2fa0 100644 (file)
--- a/yang/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/NotificationListener.java
+++ b/yang/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/NotificationListener.java
@@ -10,18 +10,19 @@ package org.opendaylight.yangtools.yang.binding;
 import java.util.EventListener;
 
 /**
- * Marker interface for generated notification listener interfaces
- * 
+ * Marker interface for generated notification listener interfaces. This interface
+ * exists solely as support for generated code. Users should never implement this
+ * interface directly, but rather implement one of the sub-interfaces generated
+ * from a YANG model.
+ *
  * <p>
  * The subclasses of this interface have callbacks for events, which are derived
  * from {@link Notification} class in form void
  * on{NotificationType}(NotificationType notification).
- * 
+ *
  * <p>
  * E.g. if we have notification SessionUp the callback will have signature:
  * <code>void  onSessionUp(SessionUp notification)</code>
- * 
- * 
  */
 public interface NotificationListener extends EventListener {