瀏覽代碼

Document interface method (#3959)

This should give a better idea of what this method is supposed to be
doing.
Grégoire Paris 9 年之前
父節點
當前提交
2674406027
共有 2 個文件被更改,包括 7 次插入3 次删除
  1. 4 2
      Builder/BuilderInterface.php
  2. 3 1
      Builder/FormContractorInterface.php

+ 4 - 2
Builder/BuilderInterface.php

@@ -22,8 +22,10 @@ use Sonata\AdminBundle\Admin\FieldDescriptionInterface;
 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);
 }

+ 3 - 1
Builder/FormContractorInterface.php

@@ -16,7 +16,7 @@ use Symfony\Component\Form\FormBuilder;
 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 @@ interface FormContractorInterface extends BuilderInterface
     public function getFormBuilder($name, array $options = array());
 
     /**
+     * Should provide Symfony form options.
+     *
      * @abstract
      *
      * @param string                    $type