Improve StatementContextBase documentation

Clarify intended behavior of addPhaseCompletedListener().

Change-Id: I23025cfb64a7069e84c0f0c182f3c78e500e2e73
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>

diff --git a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/reactor/StatementContextBase.java b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/reactor/StatementContextBase.java
index 21af8fc0afde925601dfa1087ad2791e80603e56..4d35ad624c703c1d2389f2252a2584cda08e2a51 100644 (file)
--- a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/reactor/StatementContextBase.java
+++ b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/reactor/StatementContextBase.java
@@ -608,7 +608,12 @@ public abstract class StatementContextBase<A, D extends DeclaredStatement<A>, E
     }
 
     /**
-     * Adds {@link OnPhaseFinished} listener for a {@link ModelProcessingPhase} end.
+     * Adds {@link OnPhaseFinished} listener for a {@link ModelProcessingPhase} end. If the base has already completed
+     * the listener is notified immediately.
+     *
+     * @param phase requested completion phase
+     * @param listener listener to invoke
+     * @throws NullPointerException if any of the arguments is null
      */
     void addPhaseCompletedListener(final ModelProcessingPhase phase, final OnPhaseFinished listener) {
         Preconditions.checkNotNull(phase, "Statement context processing phase cannot be null at: %s",