commit f53bc2b1041e14e3cfdaca7ab76b9224cfdf6c8e
author sangyun-han <sangyun0628@khu.ac.kr> Wed Mar 30 11:11:06 2016 +0900
committer sangyun-han <sangyun0628@khu.ac.kr> Wed Mar 30 11:11:06 2016 +0900
tree f691eee1744d3bef0645a7cb53298d361e3270ec
parent 375f4be24a2b1bf84114d254a6e03965d9a604b6

Add comment in GroupOperation for javadoc

Change-Id: Idef516e9e7af3d8fdb94ba3d13da8bb614e12c55

core/api/src/main/java/org/onosproject/net/group/GroupOperation.java

diff --git a/core/api/src/main/java/org/onosproject/net/group/GroupOperation.java b/core/api/src/main/java/org/onosproject/net/group/GroupOperation.java
index 42ef9dd..c60b6dc 100644
--- a/core/api/src/main/java/org/onosproject/net/group/GroupOperation.java
+++ b/core/api/src/main/java/org/onosproject/net/group/GroupOperation.java
@@ -149,6 +149,14 @@
 
     }
 
+    /**
+     * Creates failure group operation object by setting failure code
+     * to inform the failure reason.
+     *
+     * @param groupOperation the original group operation
+     * @param failureCode failure code for a failed group operation
+     * @return failed group operation object
+     */
     public static GroupOperation createFailedGroupOperation(GroupOperation groupOperation,
                                                             GroupMsgErrorCode failureCode) {
         checkNotNull(groupOperation);