Updating documentation.

src/lib/Phine/Observer/ObserverInterface.php

@@ -5,6 +5,37 @@
 /**
  * Defines how an observer class must be implemented.
  *
+ * Summary
+ * -------
+ *
+ * A class implementing `ObserverInterface` will be able to receive updates
+ * from any subject that implements `SubjectInterface`.
+ *
+ * Starting
+ * --------
+ *
+ * To create a new observer, you will need to create an implementation of
+ * `ObserverInterface`.
+ *
+ *     use Phine\Observer\ObserverInterface;
+ *     use Phine\Observer\SubjectInterface;
+ *
+ *     class MyObserver implements ObserverInterface
+ *     {
+ *         public function receiveUpdate(SubjectInterface $subject)
+ *         {
+ *             // do stuff
+ *         }
+ *     }
+ *
+ * ### Interrupting the Update
+ *
+ * If the observer receives an update, it can interrupt the subject and prevent
+ * it from updating the remaining observers. This can be accomplished by using
+ * the `$subject->interruptUpdate()` method.
+ *
+ * @see SubjectInterface::interruptUpdate()
+ *
  * @author Kevin Herrera <kevin@herrera.io>
  */
 interface ObserverInterface

src/lib/Phine/Observer/Subject.php

@@ -7,7 +7,24 @@
 use Phine\Observer\Exception\SubjectException;
 
 /**
- * The default implementation of the {@link SubjectInterface} interface.
+ * The default implementation of `SubjectInterface`.
+ *
+ * Summary
+ * -------
+ *
+ * The `Subject` class is an implementation of `SubjectInterface`. You may use
+ * the implementation an authoritative example of how the interface should be
+ * implemented. You may optionally extend the class to add (not modify) new
+ * functionality that you may needed.
+ *
+ * Starting
+ * --------
+ *
+ * To start, you will need to simply create an instance of `Subject`:
+ *
+ *     use Phine\Observer\Subject;
+ *
+ *     $subject = new Subject();
  *
  * @author Kevin Herrera <kevin@herrera.io>
  *

src/lib/Phine/Observer/SubjectInterface.php

@@ -18,7 +18,7 @@
  * Starting
  * --------
  *
- * To create a new observer, you will need to create an implementation of
+ * To create a new subject, you will need to create an implementation of
  * `SubjectInterface`. In this example, I will be using the bundled `Subject`
  * implementation.
  *