This issue is for adding the @Event tag and appropriate documentation to the following list of events.

$this->eventDispatcher->dispatch(FieldStorageDefinitionEvents::CREATE, new FieldStorageDefinitionEvent($storage_definition));
$this->eventDispatcher->dispatch(FieldStorageDefinitionEvents::DELETE, new FieldStorageDefinitionEvent($storage_definition));
$this->eventDispatcher->dispatch(FieldStorageDefinitionEvents::UPDATE, new FieldStorageDefinitionEvent($storage_definition, $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: This is API documentation, so unfrozen. Also very low disruption possibility.

Comments

eojthebrave’s picture

Status: Active » Needs review
StatusFileSize
new2.59 KB

Here's a first pass at this.

eojthebrave’s picture

Issue summary: View changes
jhodgdon’s picture

Status: Needs review » Reviewed & tested by the community

Looks great, thanks! Beta eval, check! :)

webchick’s picture

Status: Reviewed & tested by the community » Fixed

Committed and pushed to 8.0.x. Thanks!

  • webchick committed 53ca7d6 on 8.0.x
    Issue #2415507 by eojthebrave: Add @Event documentation to all...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.