about summary refs log tree commit diff
path: root/src/libstd/thread
diff options
context:
space:
mode:
authorCorey Farwell <coreyf@rwell.org>2016-06-23 18:16:37 -0400
committerCorey Farwell <coreyf@rwell.org>2016-06-24 08:13:30 -0400
commit6e848be5f8071f1fe6110b3ec2bee0776126f79b (patch)
treeb01f4163668172e846fe1cb0b293bb3814cf93d4 /src/libstd/thread
parent8c63d12dc3abc9ef16ca5ec3cf03f0dfbf09c3a5 (diff)
downloadrust-6e848be5f8071f1fe6110b3ec2bee0776126f79b.tar.gz
rust-6e848be5f8071f1fe6110b3ec2bee0776126f79b.zip
Indicate how the `JoinHandle` struct is created.
Diffstat (limited to 'src/libstd/thread')
-rw-r--r--src/libstd/thread/mod.rs6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/libstd/thread/mod.rs b/src/libstd/thread/mod.rs
index 1f78b32bcf3..355e0f50cef 100644
--- a/src/libstd/thread/mod.rs
+++ b/src/libstd/thread/mod.rs
@@ -610,6 +610,12 @@ impl<T> JoinInner<T> {
 /// Due to platform restrictions, it is not possible to `Clone` this
 /// handle: the ability to join a child thread is a uniquely-owned
 /// permission.
+///
+/// This `struct` is created by the [`thread::spawn`] function and the
+/// [`thread::Builder::spawn`] method.
+///
+/// [`thread::spawn`]: fn.spawn.html
+/// [`thread::Builder::spawn`]: struct.Builder.html#method.spawn
 #[stable(feature = "rust1", since = "1.0.0")]
 pub struct JoinHandle<T>(JoinInner<T>);