From edfafb1a4de8f6bbc5466aede072aadda7971584 Mon Sep 17 00:00:00 2001
From: Marcelo Vanzin <vanzin@cloudera.com>
Date: Mon, 20 Apr 2015 11:12:43 -0700
Subject: [PATCH] Better scaladoc.

---
 core/src/main/scala/org/apache/spark/util/Utils.scala | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/core/src/main/scala/org/apache/spark/util/Utils.scala b/core/src/main/scala/org/apache/spark/util/Utils.scala
index af33ae9b690ee..7b0de1ae55b78 100644
--- a/core/src/main/scala/org/apache/spark/util/Utils.scala
+++ b/core/src/main/scala/org/apache/spark/util/Utils.scala
@@ -2138,6 +2138,9 @@ private[spark] object Utils extends Logging {
 
   /**
    * Adds a shutdown hook with default priority.
+   *
+   * @param hook The code to run during shutdown.
+   * @return A handle that can be used to unregister the shutdown hook.
    */
   def addShutdownHook(hook: () => Unit): AnyRef = {
     addShutdownHook(DEFAULT_SHUTDOWN_PRIORITY, hook)
@@ -2146,6 +2149,9 @@ private[spark] object Utils extends Logging {
   /**
    * Adds a shutdown hook with the given priority. Hooks with lower priority values run
    * first.
+   *
+   * @param hook The code to run during shutdown.
+   * @return A handle that can be used to unregister the shutdown hook.
    */
   def addShutdownHook(priority: Int, hook: () => Unit): AnyRef = {
     shutdownHooks.add(priority, hook)
@@ -2153,6 +2159,9 @@ private[spark] object Utils extends Logging {
 
   /**
    * Remove a previously installed shutdown hook.
+   *
+   * @param ref A handle returned by `addShutdownHook`.
+   * @return Whether the hook was removed.
    */
   def removeShutdownHook(ref: AnyRef): Boolean = {
     shutdownHooks.remove(ref)