Browse Source

neko.vm.Gc.hx documentation

From http://nekovm.org/doc/view/misc
Mark Knol 10 years ago
parent
commit
5e0fa3857c
1 changed files with 6 additions and 2 deletions
  1. 6 2
      std/neko/vm/Gc.hx

+ 6 - 2
std/neko/vm/Gc.hx

@@ -22,16 +22,20 @@
 package neko.vm;
 
 class Gc {
-
+	/**
+		Run the Neko garbage collector.
+	*/
 	public static function run( major : Bool ) {
 		_run(major);
 	}
 
+	/**
+		Return the size of the GC heap and the among of free space, in bytes
+	*/
 	public static function stats() : { heap : Int, free : Int } {
 		return _stats();
 	}
 
 	static var _run = neko.Lib.load("std","run_gc",1);
 	static var _stats = neko.Lib.load("std","gc_stats",0);
-
 }