Add yang.binding.contract documentation

[mdsal.git] / binding / yang-binding / src / main / java / org / opendaylight / yangtools / yang / binding / contract / package-info.java

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;