Add more std documentation

1 files changed, 20 insertions, 1 deletions

diff --git a/src/lib/ptr.rs b/src/lib/ptr.rs
index 8d730732c3c..35644ab840b 100644
--- a/src/lib/ptr.rs
+++ b/src/lib/ptr.rs
@@ -1,13 +1,32 @@
-// Unsafe pointer utility functions.
+/*
+Module: ptr
 
+Unsafe pointer utility functions
+*/
 native "rust-intrinsic" mod rusti {
     fn addr_of<T>(val: T) -> *mutable T;
     fn ptr_offset<T>(ptr: *T, count: uint) -> *T;
 }
 
+/*
+Function: addr_of
+
+Get an unsafe pointer to a value
+*/
 fn addr_of<T>(val: T) -> *mutable T { ret rusti::addr_of(val); }
+
+/*
+Function: offset
+
+Calculate the offset from a pointer
+*/
 fn offset<T>(ptr: *T, count: uint) -> *T {
     ret rusti::ptr_offset(ptr, count);
 }
 
+/*
+Function: null
+
+Create an unsafe null pointer
+*/
 fn null<T>() -> *T { ret unsafe::reinterpret_cast(0u); }