Javadoc update

[openflowjava.git] / openflow-protocol-impl / src / main / java / org / opendaylight / openflowjava / protocol / impl / util / MatchDeserializer.java

diff --git a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/MatchDeserializer.java b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/MatchDeserializer.java
index dba41160c0726bc404737574661e8328f987d59d..d17f3a0a29fd509089dd971efbf06e35eca88ca5 100644 (file)
--- a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/MatchDeserializer.java
+++ b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/MatchDeserializer.java
@@ -119,7 +119,7 @@ import org.slf4j.LoggerFactory;
 import com.google.common.base.Joiner;\r
 \r
 /**\r
- * Class for easy creation of matches\r
+ * Deserializes ofp_match (OpenFlow v1.3) and its oxm_fields structures\r
  * @author timotej.kubas\r
  * @author michal.polkorab\r
  */\r
@@ -135,7 +135,7 @@ public abstract class MatchDeserializer {
     /**\r
      * Creates match\r
      * @param in input ByteBuf\r
-     * @return ofp_match\r
+     * @return ofp_match (OpenFlow v1.3)\r
      */\r
     public static Match createMatch(ByteBuf in) {\r
         if (in.readableBytes() > 0) {\r
@@ -163,9 +163,10 @@ public abstract class MatchDeserializer {
     }\r
     \r
     /**\r
+     * Deserializes single match entry (oxm_field)\r
      * @param in input ByteBuf\r
-     * @param matchLength to infer size of array\r
-     * @return MatchEntriesList\r
+     * @param matchLength length of match entry\r
+     * @return MatchEntriesList list containing one match entry\r
      */\r
     public static List<MatchEntries> createMatchEntry(ByteBuf in, int matchLength) {\r
         return createMatchEntriesInternal(in, matchLength, true);\r
@@ -173,8 +174,8 @@ public abstract class MatchDeserializer {
     \r
     /**\r
      * @param in input ByteBuf\r
-     * @param matchLength to infer size of array\r
-     * @return MatchEntriesList\r
+     * @param matchLength length of match entries\r
+     * @return MatchEntriesList list of match entries\r
      */\r
     public static List<MatchEntries> createMatchEntries(ByteBuf in, int matchLength) {\r
         return createMatchEntriesInternal(in, matchLength, false);\r