Added documentation.

postmodern · Aug 15, 2013 · acda16e · acda16e
1 parent 7da78d7
commit acda16e
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/lib/ffi/libc/libc.rb b/lib/ffi/libc/libc.rb
@@ -184,6 +184,18 @@ def self.each_ifaddrs
 
     attach_function :sys_getrusage, :getrusage, [:int, :pointer], :int
 
+    #
+    # Gets the RUsage for the user.
+    #
+    # @param [RUSAGE_SELF, RUSAGE_CHILDREN, RUSAGE_THREAD] who
+    #   Whome to get RUsage statistics for.
+    #
+    # @return [RUsage]
+    #   The RUsage statistics.
+    #
+    # @raise [RuntimeError]
+    #   An error has occurred.
+    #
     def self.getrusage(who=RUSAGE_SELF)
       rusage = RUsage.new