Add yang.binding.contract documentation

Document the contents of the contract package.

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

diff --git a/binding/yang-binding/src/main/java/module-info.java b/binding/yang-binding/src/main/java/module-info.java
index ba86e6a12fe6ee60efca080418be46a080075967..51ad61fba402d6e707db311c115ce9aabe6ebce6 100644 (file)
--- a/binding/yang-binding/src/main/java/module-info.java
+++ b/binding/yang-binding/src/main/java/module-info.java
@@ -11,6 +11,8 @@ module org.opendaylight.yangtools.yang.binding {
     exports org.opendaylight.yangtools.yang.binding.contract;
     exports org.opendaylight.yangtools.yang.binding.util;
 
+    requires transitive com.google.common;
+    requires transitive org.opendaylight.yangtools.concepts;
     requires transitive org.opendaylight.yangtools.yang.common;
     requires org.opendaylight.yangtools.util;
 

diff --git a/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/contract/package-info.java b/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/contract/package-info.java
index 6d19e8c16a7ad4a02a7979afd1f5bb7ab7c281df..9c73e281a185ce8d369a70961896f6d4eb8c4d3c 100644 (file)
--- a/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/contract/package-info.java
+++ b/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/contract/package-info.java
@@ -5,5 +5,12 @@
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
+/**
+ * Various binding contracts. Notable members include
+ * <ul>
+ *   <li>{@link Naming} of classes and methods</li>
+ *   <li>resolution of YANG-to-Java namespace conflicts via {@link StatementNamespace}</li>
+ * </ul>
+ */
 @org.osgi.annotation.bundle.Export
-package org.opendaylight.yangtools.yang.binding.contract;
\ No newline at end of file
+package org.opendaylight.yangtools.yang.binding.contract;