BUG-865: deprecate pre-Beryllium parser elements

[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / builder / api / DocumentedNodeBuilder.java

diff --git a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/DocumentedNodeBuilder.java b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/DocumentedNodeBuilder.java
index 4ff4fb87eeeab83bde1d92c0bb3d02396c08e164..804f7f8bebc58a75b5f674164c0a2d05a8306b51 100644 (file)
--- a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/DocumentedNodeBuilder.java
+++ b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/api/DocumentedNodeBuilder.java
@@ -12,7 +12,9 @@ import org.opendaylight.yangtools.yang.model.api.Status;
 /**
  * Mixin-style builder interfac for nodes, which may have documentation attached.
  *
- **/
+ * @deprecated Pre-Beryllium implementation, scheduled for removal.
+ */
+@Deprecated
 public interface DocumentedNodeBuilder {
 
     /**
@@ -26,7 +28,7 @@ public interface DocumentedNodeBuilder {
     /**
      * Set description to this node.
      *
-     * @param description
+     * @param description description of this node
      */
     void setDescription(String description);
 
@@ -40,7 +42,7 @@ public interface DocumentedNodeBuilder {
     /**
      * Set reference to this node.
      *
-     * @param reference
+     * @param reference reference to this node
      */
     void setReference(String reference);
 
@@ -54,7 +56,7 @@ public interface DocumentedNodeBuilder {
     /**
      * Set status to this node.
      *
-     * @param status
+     * @param status status of this node
      */
     void setStatus(Status status);
 }