Merge "Bug 2366: Introducing support for statement ANTLR4 parser as defined in RFC602...

[yangtools.git] / yang / yang-model-api / src / main / java / org / opendaylight / yangtools / yang / model / api / package-info.java

diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/package-info.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/package-info.java
index 82764762cea990c0e23c09ea9d19c34052f5e1ea..424c64b081ebff70b0841a2bcba368f2c9c02194 100644 (file)
--- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/package-info.java
+++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/package-info.java
@@ -1,22 +1,40 @@
 /*
-  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
-  *
-  * This program and the accompanying materials are made available under the
-  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
-  * and is available at http://www.eclipse.org/legal/epl-v10.html
-  */
+ * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
 
 /**
- * Definition of structures and DOM Like API of processed YANG schema
+ * Definition of structures and DOM like API of effected YANG schema
+ *
+ * <p>
+ * This package is structured into following logical units:
+ * <dl>
+ * <dt>YANG Meta model</dt>
+ * <dd>Meta model of YANG, which defines basic concepts and building blocks of YANG models
+ * such as {@link org.opendaylight.yangtools.yang.model.api.meta.ModelStatement}.</dd>
+ * <dt>YANG Statement model</dt>
+ * <dd>Concrete java model of YANG statements, which defines basic relationship between statements
+ * and represents these statements.</dd>
+ *
+ * <dt>YANG Effective model</dt>
+ * <dd>Effective model of processed YANG models, which represents semantic interpretation
+ * of YANG models and provides convenience views for interpreting models.
+ * </dd>
+ * </dl>
+ *
  *
- * <h3>YANG Statement mapping</h3>
+ * <h2>YANG Effective model</h2>
+ * <h3>Effective model statement mapping</h3>
  *
  * <dl>
  * <dt>anyxml
  *   <dd>{@link org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode}
  *
  * <dt>argument
- *   <dd>{@link org.opendaylight.yangtools.yang.model.api.ExtensionDefinition#getArgumentName()}
+ *   <dd>{@link org.opendaylight.yangtools.yang.model.api.ExtensionDefinition#getArgument()}
  *
  *
  * <dt>augment
@@ -36,7 +54,7 @@
  *   <dd>{@link org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode}
  *
  * <dt>choice
- *   <dd>{@link org.opendaylight.yangtools.yang.model.api.ChoiceNode}
+ *   <dd>{@link org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode}
  *
  * <dt>config
  *   <dd>{@link org.opendaylight.yangtools.yang.model.api.DataSchemaNode#isConfiguration()}
@@ -108,7 +126,7 @@
  *
  * <dt>length
  *   <dd>{@link org.opendaylight.yangtools.yang.model.api.type.LengthConstraint}
- *   <dd>{@link org.opendaylight.yangtools.yang.model.api.type.StringTypeDefinition#getLengthStatements()}
+ *   <dd>{@link org.opendaylight.yangtools.yang.model.api.type.StringTypeDefinition#getLengthConstraints()}
  *
  * <dt>list
  *   <dd>{@link org.opendaylight.yangtools.yang.model.api.ListSchemaNode}
@@ -149,7 +167,7 @@
  *   <dd>{@link org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition#getPathStatement()}
  *
  * <dt>pattern
- *   <dd>{@link org.opendaylight.yangtools.yang.model.base.type.api.PatternConstraint}
+ *   <dd>{@link org.opendaylight.yangtools.yang.model.api.type.PatternConstraint}
  *   <dd>{@link org.opendaylight.yangtools.yang.model.api.type.StringTypeDefinition}
  *
  * <dt>position
@@ -164,8 +182,8 @@
  *
  * <dt>range
  *   <dd>{@link org.opendaylight.yangtools.yang.model.api.type.RangeConstraint}
- *   <dd>{@link org.opendaylight.yangtools.yang.model.api.type.IntegerTypeDefinition#getRangeStatements()}
- *   <dd>{@link org.opendaylight.yangtools.yang.model.api.type.UnsignedIntegerTypeDefinition#getRangeStatements()}
+ *   <dd>{@link org.opendaylight.yangtools.yang.model.api.type.IntegerTypeDefinition#getRangeConstraints()}
+ *   <dd>{@link org.opendaylight.yangtools.yang.model.api.type.UnsignedIntegerTypeDefinition#getRangeConstraints()}
  *
  * <dt>reference
  *   <dd>{@link org.opendaylight.yangtools.yang.model.api.SchemaNode#getReference()}
@@ -207,7 +225,7 @@
  *
  * <dt>uses
  *   <dd>{@link org.opendaylight.yangtools.yang.model.api.UsesNode}
- *   <dd>{@link org.opendaylight.yangtools.yang.model.api.DataNodeContainere#getUses()}
+ *   <dd>{@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer#getUses()}
  *
  * <dt>value
  *   <dd>{@link org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition.EnumPair#getValue()}