public function FieldConfigBase::setDescription

public FieldConfigBase::setDescription($description)

Sets a human readable description.

Descriptions are usually used on user interfaces where the data is edited or displayed.

Parameters

string $description: The description for this field.

Return value

$this

Overrides FieldConfigInterface::setDescription

File

core/lib/Drupal/Core/Field/FieldConfigBase.php, line 311

Class

FieldConfigBase
Base class for configurable field definitions.

Namespace

Drupal\Core\Field

Code

public function setDescription($description) {
  $this->description = $description;
  return $this;
}

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Field!FieldConfigBase.php/function/FieldConfigBase::setDescription/8.1.x