API docs progress

This commit is contained in:
Samuel Georges 2017-03-15 18:03:26 +11:00
parent ec18697ae2
commit 18c6bb63a2
3 changed files with 11 additions and 8 deletions

View File

@ -36,12 +36,12 @@ class RelationController extends ControllerBehavior
const PARAM_EXTRA_CONFIG = '_relation_extra_config'; const PARAM_EXTRA_CONFIG = '_relation_extra_config';
/** /**
* @var Backend\Classes\WidgetBase Reference to the search widget object. * @var Backend\Widgets\Search Reference to the search widget object.
*/ */
protected $searchWidget; protected $searchWidget;
/** /**
* @var Backend\Classes\WidgetBase Reference to the toolbar widget object. * @var Backend\Widgets\Toolbar Reference to the toolbar widget object.
*/ */
protected $toolbarWidget; protected $toolbarWidget;

View File

@ -24,8 +24,9 @@ class FormField
public $fieldName; public $fieldName;
/** /**
* @var string If the field element names should be contained in an array. * @var string If the field element names should be contained in an array. Eg:
* Eg: <input name="nameArray[fieldName]" /> *
* <input name="nameArray[fieldName]" />
*/ */
public $arrayName; public $arrayName;
@ -616,8 +617,10 @@ class FormField
} }
/** /**
* Returns the final model and attribute name of a nested attribute. * Returns the final model and attribute name of a nested attribute. Eg:
* Eg: list($model, $attribute) = $this->resolveAttribute('person[phone]'); *
* list($model, $attribute) = $this->resolveAttribute('person[phone]');
*
* @param string $attribute. * @param string $attribute.
* @return array * @return array
*/ */

View File

@ -49,7 +49,7 @@ class ListColumn
/** /**
* @var string Model attribute to use for the display value, this will * @var string Model attribute to use for the display value, this will
* override any $sqlSelect definition. * override any `$sqlSelect` definition.
*/ */
public $valueFrom; public $valueFrom;
@ -60,7 +60,7 @@ class ListColumn
/** /**
* @var string Custom SQL for selecting this record display value, * @var string Custom SQL for selecting this record display value,
* the @ symbol is replaced with the table name. * the `@` symbol is replaced with the table name.
*/ */
public $sqlSelect; public $sqlSelect;