add docs [ci skip]

r-obert · r-obert · commit 3743228846cd · 2017-06-24T14:38:05.000+01:00
diff --git a/lib/pry/config/memoization.rb b/lib/pry/config/memoization.rb
@@ -2,6 +2,23 @@ module Pry::Config::Memoization
   MEMOIZED_METHODS = Hash.new {|h,k| h[k] = [] }
 
   module ClassMethods
+    #
+    # Defines one or more methods who return a constant value after being
+    # called once.
+    #
+    # @example
+    #   class Foo
+    #     include Pry::Config::Memoization
+    #     def_memoized({
+    #       foo: proc {1+10},
+    #       bar: proc{"aaa"<<"a"}
+    #     })
+    #   end
+    #
+    # @param [{String => Proc}] method_table
+    #
+    # @return [void]
+    #
     def def_memoized(method_table)
       method_table.each do |method_name, method|
         define_method(method_name) do
@@ -17,6 +34,10 @@ def self.included(mod)
     mod.extend(ClassMethods)
   end
 
+  #
+  # @return [Array<Symbol>]
+  #   Returns the names of methods that have been defined by {ClassMethods#def_memoized}.
+  #
   def memoized_methods
     MEMOIZED_METHODS[self.class]
   end
