[hotfix][docs] Update addShutdownHookThread javadocs

tongcheng-elong · Jan 9, 2019 · a93e91a · a93e91a
1 parent 4782236
commit a93e91a
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/flink-core/src/main/java/org/apache/flink/util/ShutdownHookUtil.java b/flink-core/src/main/java/org/apache/flink/util/ShutdownHookUtil.java
@@ -50,7 +50,12 @@ public static Thread addShutdownHook(
  }
 
  /**
- * Adds a shutdown hook to the JVM and returns the Thread, which has been registered.
+ * Adds a shutdown hook to the JVM.
+ *
+ * @param shutdownHook Shutdown hook to be registered.
+ * @param serviceName The name of service.
+ * @param logger The logger to log.
+ * @return Whether the hook has been successfully registered.
  */
  public static boolean addShutdownHookThread(
  final Thread shutdownHook,