function DataDefinition::setDescription

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/TypedData/DataDefinition.php \Drupal\Core\TypedData\DataDefinition::setDescription()
  2. 8.9.x core/lib/Drupal/Core/TypedData/DataDefinition.php \Drupal\Core\TypedData\DataDefinition::setDescription()
  3. 10 core/lib/Drupal/Core/TypedData/DataDefinition.php \Drupal\Core\TypedData\DataDefinition::setDescription()

Sets the human-readable description.

Parameters

string|\Drupal\Core\StringTranslation\TranslatableMarkup $description: The description to set.

Return value

static The object itself for chaining.

File

core/lib/Drupal/Core/TypedData/DataDefinition.php, line 108

Class

DataDefinition
A typed data definition class for defining data based on defined data types.

Namespace

Drupal\Core\TypedData

Code

public function setDescription($description) {
    $this->definition['description'] = $description;
    return $this;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.