From 591c152dfc07bc43b132f6ec0f24f2d5e8e06620 Mon Sep 17 00:00:00 2001 From: Brian Anderson Date: Wed, 19 Sep 2012 17:43:41 -0700 Subject: [PATCH] core: Cleanup task_local docs --- src/libcore/task/local_data.rs | 16 +++++++++------- src/libcore/task/local_data_priv.rs | 2 ++ 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/src/libcore/task/local_data.rs b/src/libcore/task/local_data.rs index eefdb9eceee..f8a2b638f98 100644 --- a/src/libcore/task/local_data.rs +++ b/src/libcore/task/local_data.rs @@ -2,15 +2,17 @@ Task local data management -Allows storing boxes with arbitrary types inside, to be accessed anywhere -within a task, keyed by a pointer to a global finaliser function. Useful -for task-spawning metadata (tracking linked failure state), dynamic -variables, and interfacing with foreign code with bad callback interfaces. +Allows storing boxes with arbitrary types inside, to be accessed +anywhere within a task, keyed by a pointer to a global finaliser +function. Useful for dynamic variables, singletons, and interfacing +with foreign code with bad callback interfaces. -To use, declare a monomorphic global function at the type to store, and use -it as the 'key' when accessing. See the 'tls' tests below for examples. +To use, declare a monomorphic global function at the type to store, +and use it as the 'key' when accessing. See the 'tls' tests below for +examples. -Casting 'Arcane Sight' reveals an overwhelming aura of Transmutation magic. +Casting 'Arcane Sight' reveals an overwhelming aura of Transmutation +magic. */ diff --git a/src/libcore/task/local_data_priv.rs b/src/libcore/task/local_data_priv.rs index 640ea3577b3..e2d697f2e89 100644 --- a/src/libcore/task/local_data_priv.rs +++ b/src/libcore/task/local_data_priv.rs @@ -1,3 +1,5 @@ +#[doc(hidden)]; // FIXME #3538 + use local_data::LocalDataKey; trait LocalData { }