More javadocs added to yang-model-api.

[controller.git] / opendaylight / sal / yang-prototype / yang / yang-model-api / src / main / java / org / opendaylight / controller / yang / model / api / IdentitySchemaNode.java

diff --git a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/IdentitySchemaNode.java b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/IdentitySchemaNode.java
index d1e68182c37f6a06abcc929b0661637cca1b6d98..7e08238c04888d1d38c966f74620a95548bfb2c9 100644 (file)
--- a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/IdentitySchemaNode.java
+++ b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/IdentitySchemaNode.java
@@ -1,14 +1,27 @@
 /*\r
-  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
-  *\r
-  * This program and the accompanying materials are made available under the\r
-  * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
-  * and is available at http://www.eclipse.org/legal/epl-v10.html\r
-  */\r
+ * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
+ *\r
+ * This program and the accompanying materials are made available under the\r
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
+ * and is available at http://www.eclipse.org/legal/epl-v10.html\r
+ */\r
 package org.opendaylight.controller.yang.model.api;\r
 \r
+/**\r
+ * Interface describing YANG 'identity' statement.\r
+ * <p>\r
+ * The 'identity' statement is used to define a new globally unique, abstract,\r
+ * and untyped identity. Its only purpose is to denote its name, semantics, and\r
+ * existence. The built-in datatype "identityref" can be used to reference\r
+ * identities within a data model.\r
+ * </p>\r
+ */\r
 public interface IdentitySchemaNode extends SchemaNode {\r
 \r
+    /**\r
+     * @return an existing identity, from which the new identity is derived or\r
+     *         null, if the identity is defined from scratch.\r
+     */\r
     IdentitySchemaNode getBaseIdentity();\r
 \r
 }\r