Document BindingCodec/Serializer/Deserializer

[mdsal.git] / binding / yang-binding / src / main / java / org / opendaylight / yangtools / yang / binding / BindingCodec.java

diff --git a/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/BindingCodec.java b/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/BindingCodec.java
index a812126336d724542b0b2c47180de2849157a0fa..e8c9a107d1feac640707d89df6386bf2347a0d6a 100644 (file)
--- a/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/BindingCodec.java
+++ b/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/BindingCodec.java
@@ -9,6 +9,11 @@ package org.opendaylight.yangtools.yang.binding;
 
 import org.opendaylight.yangtools.concepts.Codec;
 
+/**
+ * Combination of {@link BindingSerializer} and {@link BindingDeserializer}. This interface is present in this package
+ * only due to constraints imposed by current implementation.
+ */
+// FIXME: MDSAL-401: deprecate this interface once we no longer to have in a public place
 public interface BindingCodec<P, I> extends BindingSerializer<P, I>, BindingDeserializer<I, P>, Codec<P, I> {
 
     @Override