Document interface method (#3959)

This should give a better idea of what this method is supposed to be doing.
sonata-project · Jul 5, 2016 · 2674406 · 2674406
1 parent c03fd27
commit 2674406
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/Builder/BuilderInterface.php b/Builder/BuilderInterface.php
@@ -22,8 +22,10 @@
 interface BuilderInterface
 {
     /**
-     * @param AdminInterface            $admin
-     * @param FieldDescriptionInterface $fieldDescription
+     * Adds missing information to the given field description from the model manager metadata, and the given admin.
+     *
+     * @param AdminInterface            $admin            will be used to gather information
+     * @param FieldDescriptionInterface $fieldDescription will be modified
      */
     public function fixFieldDescription(AdminInterface $admin, FieldDescriptionInterface $fieldDescription);
 }
diff --git a/Builder/FormContractorInterface.php b/Builder/FormContractorInterface.php
@@ -16,7 +16,7 @@
 use Symfony\Component\Form\FormFactoryInterface;
 
 /**
- * Interface FormContractorInterface.
+ * This interface should be implemented in persistence bundles.
  *
  * @author  Thomas Rabaix <thomas.rabaix@sonata-project.org>
  */
@@ -40,6 +40,8 @@ public function __construct(FormFactoryInterface $formFactory);
     public function getFormBuilder($name, array $options = array());
 
     /**
+     * Should provide Symfony form options.
+     *
      * @abstract
      *
      * @param string                    $type