lib/compo/parent_tracker.rb in compo-0.3.0 vs lib/compo/parent_tracker.rb in compo-0.3.1

@@ -8,9 +8,19 @@
   # current parent and ID function as instance variables.  It also implements
   # #parent, and #id in terms of the ID function.
   module ParentTracker
     extend Forwardable
 
+    # Initialises the ParentTracker
+    #
+    # This constructor sets the tracker up so it initially has an instance of
+    # Parentless as its 'parent'.
+    #
+    # @api  semipublic
+    # @example  Creates a new ParentTracker.
+    #   ParentTracker.new
+    #
+    # @return [Void]
     def initialize
       super()
       remove_parent
     end