Skip to content

Improve the documentation around events #11878

Closed
@dawehner

Description

@dawehner

Hi symfony folks.

We try to make the documentation better around events in general (see https://www.drupal.org/node/2264049 for more detail). At the moment we saw several issues

  • There is no documentation, how to subscribe to events (beside of the one on symfony.com which is no strict API reference): For example there could be a short example on EventDispatcherInterface how to a) dispatch an event b) subscribe to an event
  • There is no trivial way to find all available events atm. One way how we can improve that is to tag all event classes/constants with "@category Events" (just a general suggestion) Once we are doing that tools like phpdocumentor can build a list of them and maybe even tools like the symfony2-phpstorm integration could use that as base for more autocompletion
  • There should be also an easy relation between the constant classes, if available, and the Event classes. Maybe an @uses or @see on the them

This was mostly inspired by https://www.drupal.org/node/2264049#comment-8969713

It would be great to get some discussion going on how we can improve in that area

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions