Issue #2415513 by eojthebrave: Add @Event documentation to all RoutingEvents

core/lib/Drupal/Core/Routing/RoutingEvents.php

@@ -13,21 +13,55 @@
 final class RoutingEvents {
 
   /**
-   * THE DYNAMIC event is fired on a route collection to allow new routes.
+   * Name of the event fired during route collection to allow new routes.
    *
-   * This event is used to add new routes based upon existing routes.
+   * This event is used to add new routes based upon existing routes, giving
+   * modules the opportunity to dynamically generate additional routes. The
+   * event listener method receives a \Drupal\Core\Routing\RouteBuildEvent
+   * instance.
+   *
+   * @Event
+   *
+   * @see \Drupal\Core\Routing\RouteBuildEvent
+   * @see \Drupal\Core\EventSubscriber\EntityRouteProviderSubscriber
+   * @see \Drupal\Core\Routing\RouteBuilder::rebuild()
+   *
+   * @var string
    */
   const DYNAMIC = 'routing.route_dynamic';
 
   /**
-   * The ALTER event is fired on a route collection to allow changes to routes.
+   * Name of the event fired during route collection to allow changes to routes.
+   *
+   * This event is used to process new routes before they get saved, giving
+   * modules the opportunity to alter routes provided by any other module. The
+   * event listener method receives a \Drupal\Core\Routing\RouteBuildEvent
+   * instance.
+   *
+   * @Event
    *
-   * This event is used to process new routes before they get saved.
+   * @see \Symfony\Component\Routing\RouteCollection
+   * @see \Drupal\system\EventSubscriber\AdminRouteSubscriber
+   * @see \Drupal\Core\Routing\RouteBuilder::rebuild()
+   *
+   * @var string
    */
   const ALTER = 'routing.route_alter';
 
   /**
-   * The FINISHED event is fired when the route building ended.
+   * Name of the event fired to indicate route building has ended.
+   *
+   * This event gives modules the opportunity to perform some action after route
+   * building has completed. The event listener receives a
+   * \Symfony\Component\EventDispatcher\Event instance.
+   *
+   * @Event
+   *
+   * @see \Symfony\Component\EventDispatcher\Event
+   * @see \Drupal\Core\EventSubscriber\MenuRouterRebuildSubscriber
+   * @see \Drupal\Core\Routing\RouteBuilder::rebuild()
+   *
+   * @var string
    */
   const FINISHED = 'routing.route_finished';