From 15b999d16bbd52cba9f70922ea403ebc16f27e02 Mon Sep 17 00:00:00 2001
From: Alex Pott <alex.a.pott@googlemail.com>
Date: Wed, 8 Jun 2016 10:17:57 +0100
Subject: [PATCH] Issue #2533220 by snehi, pjonckiere, mirom, chx, jhodgdon,
 dawehner: RouteBuilderInterface has no docblock

---
 .../Core/Routing/RouteBuilderInterface.php    | 21 +++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)

diff --git a/core/lib/Drupal/Core/Routing/RouteBuilderInterface.php b/core/lib/Drupal/Core/Routing/RouteBuilderInterface.php
index 83b1d3ed100..d191cb9a6c8 100644
--- a/core/lib/Drupal/Core/Routing/RouteBuilderInterface.php
+++ b/core/lib/Drupal/Core/Routing/RouteBuilderInterface.php
@@ -2,10 +2,27 @@
 
 namespace Drupal\Core\Routing;
 
+/**
+ * Rebuilds the route information and dumps it.
+ *
+ * Rebuilding the route information is the process of gathering all routing data
+ * from .routing.yml files, creating a
+ * \Symfony\Component\Routing\RouteCollection object out of it, and dispatching
+ * that object as a \Drupal\Core\Routing\RouteBuildEvent to all registered
+ * listeners. After that, the \Symfony\Component\Routing\RouteCollection object
+ * is used to dump the data. Examples of a dump include filling up the routing
+ * table, auto-generating Apache mod_rewrite rules, or auto-generating a PHP
+ * matcher class.
+ *
+ * @see \Drupal\Core\Routing\MatcherDumperInterface
+ * @see \Drupal\Core\Routing\RouteProviderInterface
+ *
+ * @ingroup routing
+ */
 interface RouteBuilderInterface {
 
   /**
-   * Rebuilds the route info and dumps to dumper.
+   * Rebuilds the route information and dumps it.
    *
    * @return bool
    *   Returns TRUE if the rebuild succeeds, FALSE otherwise.
@@ -13,7 +30,7 @@ interface RouteBuilderInterface {
   public function rebuild();
 
   /**
-   * Rebuilds the route info and dumps to dumper if necessary.
+   * Rebuilds the route information if necessary, and dumps it.
    *
    * @return bool
    *   Returns TRUE if the rebuild occurs, FALSE otherwise.