Move binding.model.api documentation

[mdsal.git] / binding / mdsal-binding-model-api / src / main / java / org / opendaylight / mdsal / binding / model / api / package-info.java

diff --git a/binding/mdsal-binding-model-api/src/main/java/org/opendaylight/mdsal/binding/model/api/package-info.java b/binding/mdsal-binding-model-api/src/main/java/org/opendaylight/mdsal/binding/model/api/package-info.java
index 9af600c9562143ba0c67f2ccd783bed22b523f0c..26ee930515d4deeb8b012ce0d49020cca7e93869 100644 (file)
--- a/binding/mdsal-binding-model-api/src/main/java/org/opendaylight/mdsal/binding/model/api/package-info.java
+++ b/binding/mdsal-binding-model-api/src/main/java/org/opendaylight/mdsal/binding/model/api/package-info.java
@@ -5,4 +5,23 @@
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
+/**
+ * Model of Java classes generated from YANG. Some information on naming:
+ *
+ * <ul>
+ * <li>
+ * {@link Type} refers to a Java class, interface or primitive type. This is something that is used as the type
+ * specifier of a variable declaration.
+ * </li>
+ * <li>
+ * {@link GeneratedType} refers to a Java class or interface. It can either be a top-level or a nested class or
+ * interface.
+ * </li>
+ * <li>
+ * {@link GeneratedTransferObject} refers to {@link GeneratedType}, which is a concrete class. These are generated to
+ * encapsulate the YANG type hierarchy as expressed by 'typedef' and 'type' statement use. If it has a superclass, it is
+ * also referred to as an {@code Extended Type}.
+ * </li>
+ * </ul>
+ */
 package org.opendaylight.mdsal.binding.model.api;
\ No newline at end of file