Follow-up to #2415505: Add @Event documentation to all ConfigEvents
This issue is for adding the @Event tag and appropriate documentation to the following list of events.
$this->eventDispatcher->dispatch(EntityTypeEvents::CREATE, new EntityTypeEvent($entity_type)); $this->eventDispatcher->dispatch(EntityTypeEvents::DELETE, new EntityTypeEvent($entity_type)); $this->eventDispatcher->dispatch(EntityTypeEvents::UPDATE, new EntityTypeEvent($entity_type, $original));
This documentation should include the following information:
- What the event is
- What it is used for
- What kind of $event object is passed along.
- @see links to related classes (event class, representative class where event is dispatched, representative class where event is subscribed to).
See the parent issue for a documentation template, and more information: #2382169: [meta] Add @Event to all events defined by drupal core
Beta eval: Unfrozen API documentation change.
Comment | File | Size | Author |
---|---|---|---|
#1 | 2425379-1-entitytype-events-docs.patch | 2.62 KB | eojthebrave |
Comments
Comment #1
eojthebraveHere's a first pass at the documentation for these events.
Comment #2
jhodgdonLooks good to me, thanks!
Comment #3
jhodgdonComment #5
webchickCommitted and pushed to 8.0.x. Thanks!