Merge pull request #360 from enumag/patch-3

Improve docblocks of ResolvedEvent
prooph · Mar 15, 2019 · fdd5514 · fdd5514
2 parents e2b95ee + f0730fe
commit fdd5514
Showing 1 changed file with 4 additions and 5 deletions.
diff --git a/src/ResolvedEvent.php b/src/ResolvedEvent.php
@@ -21,20 +21,19 @@
 class ResolvedEvent implements InternalResolvedEvent
 {
     /**
-     * The event, or the resolved link event if this is a link event
+     * If this ResolvedEvent is a link, this will contain the linked event.
+     * If this ResolvedEvent is a simple event without link, the event will be here.
      * @var RecordedEvent|null
      */
     private $event;
     /**
-     * The link event if this ResolvedEvent is a link event.
+     * If this ResolvedEvent is a link, this will contain the link. Otherwise it will be empty.
      * @var RecordedEvent|null
      */
     private $link;
     /**
      * Returns the event that was read or which triggered the subscription.
-     *
-     * If this ResolvedEvent represents a link event, the Link
-     * will be the OriginalEvent otherwise it will be the event.
+     * If this ResolvedEvent is a link, this will contain the link. Otherwise it will be the event.
      * @var RecordedEvent|null
      */
     private $originalEvent;