From 18c6bb63a2fea553c4ba03845bc6dff8d4eda1db Mon Sep 17 00:00:00 2001 From: Samuel Georges Date: Wed, 15 Mar 2017 18:03:26 +1100 Subject: [PATCH] API docs progress --- modules/backend/behaviors/RelationController.php | 4 ++-- modules/backend/classes/FormField.php | 11 +++++++---- modules/backend/classes/ListColumn.php | 4 ++-- 3 files changed, 11 insertions(+), 8 deletions(-) diff --git a/modules/backend/behaviors/RelationController.php b/modules/backend/behaviors/RelationController.php index 5a46a38ac..989e74718 100644 --- a/modules/backend/behaviors/RelationController.php +++ b/modules/backend/behaviors/RelationController.php @@ -36,12 +36,12 @@ class RelationController extends ControllerBehavior 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; /** - * @var Backend\Classes\WidgetBase Reference to the toolbar widget object. + * @var Backend\Widgets\Toolbar Reference to the toolbar widget object. */ protected $toolbarWidget; diff --git a/modules/backend/classes/FormField.php b/modules/backend/classes/FormField.php index 4be372c04..4fab49b49 100644 --- a/modules/backend/classes/FormField.php +++ b/modules/backend/classes/FormField.php @@ -24,8 +24,9 @@ class FormField public $fieldName; /** - * @var string If the field element names should be contained in an array. - * Eg: + * @var string If the field element names should be contained in an array. Eg: + * + * */ public $arrayName; @@ -616,8 +617,10 @@ class FormField } /** - * Returns the final model and attribute name of a nested attribute. - * Eg: list($model, $attribute) = $this->resolveAttribute('person[phone]'); + * Returns the final model and attribute name of a nested attribute. Eg: + * + * list($model, $attribute) = $this->resolveAttribute('person[phone]'); + * * @param string $attribute. * @return array */ diff --git a/modules/backend/classes/ListColumn.php b/modules/backend/classes/ListColumn.php index f73b0f820..e145fd601 100644 --- a/modules/backend/classes/ListColumn.php +++ b/modules/backend/classes/ListColumn.php @@ -49,7 +49,7 @@ class ListColumn /** * @var string Model attribute to use for the display value, this will - * override any $sqlSelect definition. + * override any `$sqlSelect` definition. */ public $valueFrom; @@ -60,7 +60,7 @@ class ListColumn /** * @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;