Move binding.model.api documentation
[mdsal.git] / binding / mdsal-binding-model-api / src / main / java / org / opendaylight / mdsal / binding / model / api / package-info.java
1 /*
2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 /**
9  * Model of Java classes generated from YANG. Some information on naming:
10  *
11  * <ul>
12  * <li>
13  * {@link Type} refers to a Java class, interface or primitive type. This is something that is used as the type
14  * specifier of a variable declaration.
15  * </li>
16  * <li>
17  * {@link GeneratedType} refers to a Java class or interface. It can either be a top-level or a nested class or
18  * interface.
19  * </li>
20  * <li>
21  * {@link GeneratedTransferObject} refers to {@link GeneratedType}, which is a concrete class. These are generated to
22  * encapsulate the YANG type hierarchy as expressed by 'typedef' and 'type' statement use. If it has a superclass, it is
23  * also referred to as an {@code Extended Type}.
24  * </li>
25  * </ul>
26  */
27 package org.opendaylight.mdsal.binding.model.api;