Expand rfc7950.stmt documentation 04/65404/1
authorRobert Varga <robert.varga@pantheon.tech>
Fri, 10 Nov 2017 00:47:26 +0000 (01:47 +0100)
committerRobert Varga <robert.varga@pantheon.tech>
Fri, 10 Nov 2017 00:47:26 +0000 (01:47 +0100)
Add a few more words on the contents of this package.

Change-Id: Ib3c225f934d9f6ee403ae494070c92da69f8859a
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/package-info.java

index 5a409a9c3ef57e9319a173a8c36ccd4ee547c0f3..5e7209da101c2d594fefa7f36626d33e7ba31cee 100644 (file)
  * interactions follow properly-exposed API interfaces.
  *
  * <p>
- * Common base and utility classes for individual statement implementations are maintained in this package.
+ * Common base and utility classes for individual statement implementations are maintained in this package. This package
+ * is not meant for consumption by end users and should be used only by parser extensions.
+ *
+ * <p>
+ * Do not use bare implementation classes exposed from statement sub-packages, as their details are explicitly outside
+ * of API contract. The only exception to this rule are the StatementSupport classes, which allow for correlation and
+ * creation of known YANG statements.
  *
  * @author Robert Varga
  */