Javadoc update

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

diff --git a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/MatchSerializer.java b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/MatchSerializer.java
index e36e7d4217176516a647f52c15ef3b3ef13f7adf..a6dabe1ced732b2855474938e5b99c185d03915e 100644 (file)
--- a/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/MatchSerializer.java
+++ b/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/MatchSerializer.java
@@ -88,15 +88,16 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;\r
 \r
 /**\r
+ * Serializes ofp_match (OpenFlow v1.3) and its oxm_fields structures\r
  * @author michal.polkorab\r
- *\r
+ * @author timotej.kubas\r
  */\r
 public class MatchSerializer {\r
     \r
     private static final Logger LOGGER = LoggerFactory.getLogger(MatchSerializer.class);\r
 \r
     /**\r
-     * Encodes OF match\r
+     * Encodes match (OpenFlow v1.3)\r
      * @param match ofp_match object\r
      * @param out output ByteBuf\r
      */\r
@@ -128,8 +129,8 @@ public class MatchSerializer {
 \r
     /**\r
      * Encodes MatchEntries\r
-     * @param matchEntries\r
-     * @param out\r
+     * @param matchEntries list of match entries (oxm_fields)\r
+     * @param out output ByteBuf\r
      */\r
     public static void encodeMatchEntries(List<MatchEntries> matchEntries, ByteBuf out) {\r
         if (matchEntries == null) {\r
@@ -499,7 +500,7 @@ public class MatchSerializer {
     }\r
 \r
     /**\r
-     * Computes length of ofp_match structure (in bytes)\r
+     * Computes length of match (in bytes)\r
      * @param match\r
      * @return length of ofp_match (excluding padding)\r
      */\r
@@ -514,7 +515,7 @@ public class MatchSerializer {
 \r
     /**\r
      * Computes length of MatchEntries (in bytes)\r
-     * @param matchEntries\r
+     * @param matchEntries list of match entries (oxm_fields)\r
      * @return length of MatchEntries\r
      */\r
     public static int computeMatchEntriesLength(List<MatchEntries> matchEntries) {\r