summaryrefslogtreecommitdiff
path: root/src/library/scala/sys
diff options
context:
space:
mode:
authorterma <artem.stasuk@gmail.com>2014-09-11 16:40:49 -0400
committerterma <artem.stasuk@gmail.com>2014-09-11 16:40:49 -0400
commitb416dc6be9079bd9940d0585c49a12288020dcdf (patch)
tree3242e78107428e2ae8fadf2caa12db6c75e99b5f /src/library/scala/sys
parent87ca181e7b6874cce734a4a40f90fe4af2391d97 (diff)
downloadscala-b416dc6be9079bd9940d0585c49a12288020dcdf.tar.gz
scala-b416dc6be9079bd9940d0585c49a12288020dcdf.tar.bz2
scala-b416dc6be9079bd9940d0585c49a12288020dcdf.zip
SI-8817 Correct scaladoc for scala.sys.addShutdownHook
- Remove mention that shutdown hook is daemon thread - Add link on scala.sys.ShutdownHookThread class
Diffstat (limited to 'src/library/scala/sys')
-rw-r--r--src/library/scala/sys/package.scala9
1 files changed, 4 insertions, 5 deletions
diff --git a/src/library/scala/sys/package.scala b/src/library/scala/sys/package.scala
index 386bd84113..e493603bc2 100644
--- a/src/library/scala/sys/package.scala
+++ b/src/library/scala/sys/package.scala
@@ -61,16 +61,15 @@ package object sys {
def env: immutable.Map[String, String] = immutable.Map(System.getenv().asScala.toSeq: _*)
/** Register a shutdown hook to be run when the VM exits.
- * The newly created thread is marked as a daemon so it will not
- * interfere with VM shutdown. The hook is automatically registered:
- * the returned value can be ignored, but is available in case the
- * Thread requires further modification. It can also be unregistered
- * by calling ShutdownHookThread#remove().
+ * The hook is automatically registered: the returned value can be ignored,
+ * but is available in case the Thread requires further modification.
+ * It can also be unregistered by calling ShutdownHookThread#remove().
*
* Note that shutdown hooks are NOT guaranteed to be run.
*
* @param body the body of code to run at shutdown
* @return the Thread which will run the shutdown hook.
+ * @see [[scala.sys.ShutdownHookThread]]
*/
def addShutdownHook(body: => Unit): ShutdownHookThread = ShutdownHookThread(body)