neko.vm.Tls.hx documentation

from http://nekovm.org/doc/view/thread

std/neko/vm/Tls.hx

@@ -21,19 +21,34 @@
  */
 package neko.vm;
 
+/**
+	Creates thread local storage.
+*/
 class Tls<T> {
 
 	var t : Dynamic;
 	public var value(get,set) : T;
 
+	/**
+		Creates thread local storage. This is placeholder that can store
+		a value that will be different depending on the local thread. 
+		Set the tls value to `null` before exiting the thread 
+		or the memory will never be collected.
+	*/
 	public function new() {
 		t = tls_create();
 	}
 
+	/**
+		Returns the value set by tls_set for the local thread.
+	*/
 	function get_value() : T {
 		return tls_get(t);
 	}
 
+	/**
+		Set the value of the TLS for the local thread.
+	*/
 	function set_value( v : T ) {
 		tls_set(t,v);
 		return v;
@@ -42,5 +57,4 @@ class Tls<T> {
 	static var tls_create = neko.Lib.load("std","tls_create",0);
 	static var tls_get = neko.Lib.load("std","tls_get",1);
 	static var tls_set = neko.Lib.load("std","tls_set",2);
-
-}
+}