Fix code examples in PHPDoc

Author: maidmaid

ChoiceList/ArrayKeyChoiceList.php

@@ -29,16 +29,14 @@
  *
  * Example:
  *
- * ```php
- * $choices = array('' => 'Don\'t know', 0 => 'No', 1 => 'Yes');
- * $choiceList = new ArrayKeyChoiceList(array_keys($choices));
+ *     $choices = array('' => 'Don\'t know', 0 => 'No', 1 => 'Yes');
+ *     $choiceList = new ArrayKeyChoiceList(array_keys($choices));
  *
- * $values = $choiceList->getValues()
- * // => array('', '0', '1')
+ *     $values = $choiceList->getValues()
+ *     // => array('', '0', '1')
  *
- * $selectedValues = $choiceList->getValuesForChoices(array(true));
- * // => array('1')
- * ```
+ *     $selectedValues = $choiceList->getValuesForChoices(array(true));
+ *     // => array('1')
  *
  * @author Bernhard Schussek <[email protected]>
  *

ChoiceList/Factory/PropertyAccessDecorator.php

@@ -24,18 +24,14 @@
  *
  * Pass the decorated factory to the constructor:
  *
- * ```php
- * $decorator = new PropertyAccessDecorator($factory);
- * ```
+ *     $decorator = new PropertyAccessDecorator($factory);
  *
  * You can now pass property paths for generating choice values, labels, view
  * indices, HTML attributes and for determining the preferred choices and the
  * choice groups:
  *
- * ```php
- * // extract values from the $value property
- * $list = $createListFromChoices($objects, 'value');
- * ```
+ *     // extract values from the $value property
+ *     $list = $createListFromChoices($objects, 'value');
  *
  * @author Bernhard Schussek <[email protected]>
  */

Extension/Core/ChoiceList/ChoiceList.php

@@ -28,11 +28,9 @@
  * can be stored in the array key pointing to the nested array. The topmost
  * level of the hierarchy may also be a \Traversable.
  *
- * <code>
- * $choices = array(true, false);
- * $labels = array('Agree', 'Disagree');
- * $choiceList = new ArrayChoiceList($choices, $labels);
- * </code>
+ *     $choices = array(true, false);
+ *     $labels = array('Agree', 'Disagree');
+ *     $choiceList = new ArrayChoiceList($choices, $labels);
  *
  * @author Bernhard Schussek <[email protected]>
  *

Extension/Core/ChoiceList/ObjectChoiceList.php

@@ -26,12 +26,10 @@
  * Supports generation of choice labels, choice groups and choice values
  * by calling getters of the object (or associated objects).
  *
- * <code>
- * $choices = array($user1, $user2);
+ *     $choices = array($user1, $user2);
  *
- * // call getName() to determine the choice labels
- * $choiceList = new ObjectChoiceList($choices, 'name');
- * </code>
+ *     // call getName() to determine the choice labels
+ *     $choiceList = new ObjectChoiceList($choices, 'name');
  *
  * @author Bernhard Schussek <[email protected]>
  *

Extension/Core/ChoiceList/SimpleChoiceList.php

@@ -22,12 +22,10 @@
  * creating nested arrays. The title of the sub-hierarchy can be stored in the
  * array key pointing to the nested array.
  *
- * <code>
- * $choiceList = new SimpleChoiceList(array(
- *     'creditcard' => 'Credit card payment',
- *     'cash' => 'Cash payment',
- * ));
- * </code>
+ *     $choiceList = new SimpleChoiceList(array(
+ *         'creditcard' => 'Credit card payment',
+ *         'cash' => 'Cash payment',
+ *     ));
  *
  * @author Bernhard Schussek <[email protected]>
  *

Extension/Validator/ViolationMapper/ViolationPath.php

@@ -198,9 +198,7 @@ public function isIndex($index)
      *
      * Consider the following violation path:
      *
-     * <code>
-     * children[address].children[office].data.street
-     * </code>
+     *     children[address].children[office].data.street
      *
      * In this example, "address" and "office" map to forms, while
      * "street does not.

FormRendererEngineInterface.php

@@ -53,11 +53,9 @@ public function getResourceForBlockName(FormView $view, $blockName);
      * and continues with the child of that root, the child of that child etc.
      * The following is an example for a block hierarchy:
      *
-     * <code>
-     * form_widget
-     * text_widget
-     * url_widget
-     * </code>
+     *     form_widget
+     *     text_widget
+     *     url_widget
      *
      * In this example, "url_widget" is the most specific block, while the other
      * blocks are its ancestors in the hierarchy.
@@ -91,11 +89,9 @@ public function getResourceForBlockNameHierarchy(FormView $view, array $blockNam
      * and continues with the child of that root, the child of that child etc.
      * The following is an example for a block hierarchy:
      *
-     * <code>
-     * form_widget
-     * text_widget
-     * url_widget
-     * </code>
+     *     form_widget
+     *     text_widget
+     *     url_widget
      *
      * The second parameter $hierarchyLevel determines the level of the hierarchy
      * that should be rendered.

FormRendererInterface.php

@@ -69,18 +69,14 @@ public function searchAndRenderBlock(FormView $view, $blockNameSuffix, array $va
      * Use this helper for CSRF protection without the overhead of creating a
      * form.
      *
-     * <code>
-     * <input type="hidden" name="token" value="<?php $renderer->renderCsrfToken('rm_user_'.$user->getId()) ?>">
-     * </code>
+     *     <input type="hidden" name="token" value="<?php $renderer->renderCsrfToken('rm_user_'.$user->getId()) ?>">
      *
      * Check the token in your action using the same token ID.
      *
-     * <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 $tokenId The ID of the CSRF token
      *

Forms.php

@@ -18,84 +18,72 @@
  *
  * Use this class to conveniently create new form factories:
  *
- * <code>
- * use Symfony\Component\Form\Forms;
- *
- * $formFactory = Forms::createFormFactory();
- *
- * $form = $formFactory->createBuilder()
- *     ->add('firstName', 'Symfony\Component\Form\Extension\Core\Type\TextType')
- *     ->add('lastName', 'Symfony\Component\Form\Extension\Core\Type\TextType')
- *     ->add('age', 'Symfony\Component\Form\Extension\Core\Type\IntegerType')
- *     ->add('gender', 'Symfony\Component\Form\Extension\Core\Type\ChoiceType', array(
- *         'choices' => array('Male' => 'm', 'Female' => 'f'),
- *         'choices_as_values' => true,
- *     ))
- *     ->getForm();
- * </code>
+ *     use Symfony\Component\Form\Forms;
+ *
+ *     $formFactory = Forms::createFormFactory();
+ *
+ *     $form = $formFactory->createBuilder()
+ *         ->add('firstName', 'Symfony\Component\Form\Extension\Core\Type\TextType')
+ *         ->add('lastName', 'Symfony\Component\Form\Extension\Core\Type\TextType')
+ *         ->add('age', 'Symfony\Component\Form\Extension\Core\Type\IntegerType')
+ *         ->add('gender', 'Symfony\Component\Form\Extension\Core\Type\ChoiceType', array(
+ *             'choices' => array('Male' => 'm', 'Female' => 'f'),
+ *             'choices_as_values' => true,
+ *         ))
+ *         ->getForm();
  *
  * You can also add custom extensions to the form factory:
  *
- * <code>
- * $formFactory = Forms::createFormFactoryBuilder()
- *     ->addExtension(new AcmeExtension())
- *     ->getFormFactory();
- * </code>
+ *     $formFactory = Forms::createFormFactoryBuilder()
+ *         ->addExtension(new AcmeExtension())
+ *         ->getFormFactory();
  *
  * If you create custom form types or type extensions, it is
  * generally recommended to create your own extensions that lazily
  * load these types and type extensions. In projects where performance
  * does not matter that much, you can also pass them directly to the
  * form factory:
  *
- * <code>
- * $formFactory = Forms::createFormFactoryBuilder()
- *     ->addType(new PersonType())
- *     ->addType(new PhoneNumberType())
- *     ->addTypeExtension(new FormTypeHelpTextExtension())
- *     ->getFormFactory();
- * </code>
+ *     $formFactory = Forms::createFormFactoryBuilder()
+ *         ->addType(new PersonType())
+ *         ->addType(new PhoneNumberType())
+ *         ->addTypeExtension(new FormTypeHelpTextExtension())
+ *         ->getFormFactory();
  *
  * Support for the Validator component is provided by ValidatorExtension.
  * This extension needs a validator object to function properly:
  *
- * <code>
- * use Symfony\Component\Validator\Validation;
- * use Symfony\Component\Form\Extension\Validator\ValidatorExtension;
+ *     use Symfony\Component\Validator\Validation;
+ *     use Symfony\Component\Form\Extension\Validator\ValidatorExtension;
  *
- * $validator = Validation::createValidator();
- * $formFactory = Forms::createFormFactoryBuilder()
- *     ->addExtension(new ValidatorExtension($validator))
- *     ->getFormFactory();
- * </code>
+ *     $validator = Validation::createValidator();
+ *     $formFactory = Forms::createFormFactoryBuilder()
+ *         ->addExtension(new ValidatorExtension($validator))
+ *         ->getFormFactory();
  *
  * Support for the Templating component is provided by TemplatingExtension.
  * This extension needs a PhpEngine object for rendering forms. As second
  * argument you should pass the names of the default themes. Here is an
  * example for using the default layout with "<div>" tags:
  *
- * <code>
- * use Symfony\Component\Form\Extension\Templating\TemplatingExtension;
+ *     use Symfony\Component\Form\Extension\Templating\TemplatingExtension;
  *
- * $formFactory = Forms::createFormFactoryBuilder()
- *     ->addExtension(new TemplatingExtension($engine, null, array(
- *         'FrameworkBundle:Form',
- *     )))
- *     ->getFormFactory();
- * </code>
+ *     $formFactory = Forms::createFormFactoryBuilder()
+ *         ->addExtension(new TemplatingExtension($engine, null, array(
+ *             'FrameworkBundle:Form',
+ *         )))
+ *         ->getFormFactory();
  *
  * The next example shows how to include the "<table>" layout:
  *
- * <code>
- * use Symfony\Component\Form\Extension\Templating\TemplatingExtension;
+ *     use Symfony\Component\Form\Extension\Templating\TemplatingExtension;
  *
- * $formFactory = Forms::createFormFactoryBuilder()
- *     ->addExtension(new TemplatingExtension($engine, null, array(
- *         'FrameworkBundle:Form',
- *         'FrameworkBundle:FormTable',
- *     )))
- *     ->getFormFactory();
- * </code>
+ *     $formFactory = Forms::createFormFactoryBuilder()
+ *         ->addExtension(new TemplatingExtension($engine, null, array(
+ *             'FrameworkBundle:Form',
+ *             'FrameworkBundle:FormTable',
+ *         )))
+ *         ->getFormFactory();
  *
  * @author Bernhard Schussek <[email protected]>
  */