minor symfony#28301 Fix code examples in PHPDoc (maidmaid)

This PR was merged into the 2.8 branch.

Discussion
----------

Fix code examples in PHPDoc

| Q             | A
| ------------- | ---
| Branch?       | 2.8
| Bug fix?      | yes
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | /
| License       | MIT
| Doc PR        | /

This PR properly indents the code examples in PHPDoc for a clean render.

Commits
-------

1afb043 Fix code examples in PHPDoc

Author: fabpot

src/Symfony/Bridge/Doctrine/Security/RememberMe/DoctrineTokenProvider.php

@@ -27,13 +27,14 @@
  * and to do the conversion of the datetime column.
  *
  * In order to use this class, you need the following table in your database:
- * CREATE TABLE `rememberme_token` (
- *  `series`   char(88)     UNIQUE PRIMARY KEY NOT NULL,
- *  `value`    char(88)     NOT NULL,
- *  `lastUsed` datetime     NOT NULL,
- *  `class`    varchar(100) NOT NULL,
- *  `username` varchar(200) NOT NULL
- * );
+ *
+ *     CREATE TABLE `rememberme_token` (
+ *         `series`   char(88)     UNIQUE PRIMARY KEY NOT NULL,
+ *         `value`    char(88)     NOT NULL,
+ *         `lastUsed` datetime     NOT NULL,
+ *         `class`    varchar(100) NOT NULL,
+ *         `username` varchar(200) NOT NULL
+ *     );
  */
 class DoctrineTokenProvider implements TokenProviderInterface
 {

src/Symfony/Bridge/Twig/TokenParser/DumpTokenParser.php

@@ -19,11 +19,10 @@
  * Token Parser for the 'dump' tag.
  *
  * Dump variables with:
- * <pre>
- *  {% dump %}
- *  {% dump foo %}
- *  {% dump foo, bar %}
- * </pre>
+ *
+ *     {% dump %}
+ *     {% dump foo %}
+ *     {% dump foo, bar %}
  *
  * @author Julien Galenski <julien.galenski@gmail.com>
  */

src/Symfony/Bundle/FrameworkBundle/Kernel/MicroKernelTrait.php

@@ -38,17 +38,17 @@ abstract protected function configureRoutes(RouteCollectionBuilder $routes);
      *
      * You can register extensions:
      *
-     * $c->loadFromExtension('framework', array(
-     *     'secret' => '%secret%'
-     * ));
+     *     $c->loadFromExtension('framework', array(
+     *         'secret' => '%secret%'
+     *     ));
      *
      * Or services:
      *
-     * $c->register('halloween', 'FooBundle\HalloweenProvider');
+     *     $c->register('halloween', 'FooBundle\HalloweenProvider');
      *
      * Or parameters:
      *
-     * $c->setParameter('halloween', 'lot of fun');
+     *     $c->setParameter('halloween', 'lot of fun');
      *
      * @param ContainerBuilder $c
      * @param LoaderInterface  $loader

src/Symfony/Bundle/FrameworkBundle/Templating/Helper/FormHelper.php

@@ -232,18 +232,14 @@ public function block(FormView $view, $blockName, array $variables = array())
      * Use this helper for CSRF protection without the overhead of creating a
      * form.
      *
-     * <code>
-     * echo $view['form']->csrfToken('rm_user_'.$user->getId());
-     * </code>
+     *     echo $view['form']->csrfToken('rm_user_'.$user->getId());
      *
      * Check the token in your action using the same intention.
      *
-     * <code>
-     * $csrfProvider = $this->get('security.csrf.token_generator');
-     * if (!$csrfProvider->isCsrfTokenValid('rm_user_'.$user->getId(), $token)) {
-     *     throw new \RuntimeException('CSRF attack detected.');
-     * }
-     * </code>
+     *     $csrfProvider = $this->get('security.csrf.token_generator');
+     *     if (!$csrfProvider->isCsrfTokenValid('rm_user_'.$user->getId(), $token)) {
+     *         throw new \RuntimeException('CSRF attack detected.');
+     *     }
      *
      * @param string $intention The intention of the protected action
      *

src/Symfony/Component/Config/Definition/PrototypedArrayNode.php

@@ -342,27 +342,31 @@ protected function mergeValues($leftSide, $rightSide)
      * one is same as this->keyAttribute and the other is 'value', then the prototype will be different.
      *
      * For example, assume $this->keyAttribute is 'name' and the value array is as follows:
-     * array(
+     *
      *     array(
-     *         'name' => 'name001',
-     *         'value' => 'value001'
+     *         array(
+     *             'name' => 'name001',
+     *             'value' => 'value001'
+     *         )
      *     )
-     * )
      *
      * Now, the key is 0 and the child node is:
-     * array(
-     *    'name' => 'name001',
-     *    'value' => 'value001'
-     * )
+     *
+     *     array(
+     *        'name' => 'name001',
+     *        'value' => 'value001'
+     *     )
      *
      * When normalizing the value array, the 'name' element will removed from the child node
      * and its value becomes the new key of the child node:
-     * array(
-     *     'name001' => array('value' => 'value001')
-     * )
+     *
+     *     array(
+     *         'name001' => array('value' => 'value001')
+     *     )
      *
      * Now only 'value' element is left in the child node which can be further simplified into a string:
-     * array('name001' => 'value001')
+     *
+     *     array('name001' => 'value001')
      *
      * Now, the key becomes 'name001' and the child node becomes 'value001' and
      * the prototype of child node 'name001' should be a ScalarNode instead of an ArrayNode instance.

src/Symfony/Component/Console/Helper/Table.php

@@ -224,15 +224,14 @@ public function setRow($column, array $row)
      * Renders table to output.
      *
      * Example:
-     * <code>
-     * +---------------+-----------------------+------------------+
-     * | ISBN          | Title                 | Author           |
-     * +---------------+-----------------------+------------------+
-     * | 99921-58-10-7 | Divine Comedy         | Dante Alighieri  |
-     * | 9971-5-0210-0 | A Tale of Two Cities  | Charles Dickens  |
-     * | 960-425-059-0 | The Lord of the Rings | J. R. R. Tolkien |
-     * +---------------+-----------------------+------------------+
-     * </code>
+     *
+     *     +---------------+-----------------------+------------------+
+     *     | ISBN          | Title                 | Author           |
+     *     +---------------+-----------------------+------------------+
+     *     | 99921-58-10-7 | Divine Comedy         | Dante Alighieri  |
+     *     | 9971-5-0210-0 | A Tale of Two Cities  | Charles Dickens  |
+     *     | 960-425-059-0 | The Lord of the Rings | J. R. R. Tolkien |
+     *     +---------------+-----------------------+------------------+
      */
     public function render()
     {
@@ -266,7 +265,9 @@ public function render()
     /**
      * Renders horizontal header separator.
      *
-     * Example: <code>+-----+-----------+-------+</code>
+     * Example:
+     *
+     *     +-----+-----------+-------+
      */
     private function renderRowSeparator()
     {
@@ -297,7 +298,9 @@ private function renderColumnSeparator()
     /**
      * Renders table row.
      *
-     * Example: <code>| 9971-5-0210-0 | A Tale of Two Cities  | Charles Dickens  |</code>
+     * Example:
+     *
+     *     | 9971-5-0210-0 | A Tale of Two Cities  | Charles Dickens  |
      *
      * @param array  $row
      * @param string $cellFormat

src/Symfony/Component/Console/Input/InputDefinition.php

@@ -23,8 +23,8 @@
  * Usage:
  *
  *     $definition = new InputDefinition(array(
- *       new InputArgument('name', InputArgument::REQUIRED),
- *       new InputOption('foo', 'f', InputOption::VALUE_REQUIRED),
+ *         new InputArgument('name', InputArgument::REQUIRED),
+ *         new InputOption('foo', 'f', InputOption::VALUE_REQUIRED),
  *     ));
  *
  * @author Fabien Potencier <fabien@symfony.com>

src/Symfony/Component/Console/Output/StreamOutput.php

@@ -20,11 +20,11 @@
  *
  * Usage:
  *
- * $output = new StreamOutput(fopen('php://stdout', 'w'));
+ *     $output = new StreamOutput(fopen('php://stdout', 'w'));
  *
  * As `StreamOutput` can use any stream, you can also use a file:
  *
- * $output = new StreamOutput(fopen('/path/to/output.log', 'a', false));
+ *     $output = new StreamOutput(fopen('/path/to/output.log', 'a', false));
  *
  * @author Fabien Potencier <fabien@symfony.com>
  */

src/Symfony/Component/CssSelector/CssSelector.php

@@ -17,7 +17,7 @@
  * CssSelector is the main entry point of the component and can convert CSS
  * selectors to XPath expressions.
  *
- * $xpath = CssSelector::toXpath('h1.foo');
+ *     $xpath = CssSelector::toXpath('h1.foo');
  *
  * This component is a port of the Python cssselect library,
  * which is copyright Ian Bicking, @see https://github.com/SimonSapin/cssselect.

src/Symfony/Component/DependencyInjection/Container.php

@@ -33,11 +33,9 @@
  * A service can also be defined by creating a method named
  * getXXXService(), where XXX is the camelized version of the id:
  *
- * <ul>
- *   <li>request -> getRequestService()</li>
- *   <li>mysql_session_storage -> getMysqlSessionStorageService()</li>
- *   <li>symfony.mysql_session_storage -> getSymfony_MysqlSessionStorageService()</li>
- * </ul>
+ *  * request -> getRequestService()
+ *  * mysql_session_storage -> getMysqlSessionStorageService()
+ *  * symfony.mysql_session_storage -> getSymfony_MysqlSessionStorageService()
  *
  * The container can have three possible behaviors when a service does not exist:
  *