X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fsal%2Fyang-prototype%2Fyang%2Fyang-model-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fyang%2Fmodel%2Fapi%2FIdentitySchemaNode.java;h=7e08238c04888d1d38c966f74620a95548bfb2c9;hb=refs%2Fchanges%2F65%2F365%2F2;hp=d1e68182c37f6a06abcc929b0661637cca1b6d98;hpb=626c9943156ed658f0a4cf11858ccc19b9c316cf;p=controller.git

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 d1e68182c3..7e08238c04 100644
--- 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 @@
 /*
-  * 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
+ */
 package org.opendaylight.controller.yang.model.api;
 
+/**
+ * Interface describing YANG 'identity' statement.
+ * <p>
+ * The 'identity' statement is used to define a new globally unique, abstract,
+ * and untyped identity. Its only purpose is to denote its name, semantics, and
+ * existence. The built-in datatype "identityref" can be used to reference
+ * identities within a data model.
+ * </p>
+ */
 public interface IdentitySchemaNode extends SchemaNode {
 
+    /**
+     * @return an existing identity, from which the new identity is derived or
+     *         null, if the identity is defined from scratch.
+     */
     IdentitySchemaNode getBaseIdentity();
 
 }