Commit 8e2fa49f authored by alexpott's avatar alexpott

Issue #2684319 by TravisCarden, jhodgdon: ConfigFormBaseTrait::config()...

Issue #2684319 by TravisCarden, jhodgdon: ConfigFormBaseTrait::config() @return doxygen is inaccurate
parent daa52e9f
......@@ -30,11 +30,6 @@ trait ConfigFormBaseTrait {
/**
* Retrieves a configuration object.
*
* Objects that use the trait need to implement the
* \Drupal\Core\Form\ConfigFormBaseTrait::getEditableConfigNames() to declare
* which configuration objects this method returns override free and mutable.
* This ensures that overrides do not pollute saved configuration.
*
* @param string $name
* The name of the configuration object to retrieve. The name corresponds to
* a configuration file. For @code \Drupal::config('book.admin') @endcode,
......@@ -42,7 +37,9 @@ trait ConfigFormBaseTrait {
* configuration file.
*
* @return \Drupal\Core\Config\Config|\Drupal\Core\Config\ImmutableConfig
* A configuration object.
* An editable configuration object if the given name is listed in the
* getEditableConfigNames() method or an immutable configuration object if
* not.
*/
protected function config($name) {
/** @var \Drupal\Core\Config\ConfigFactoryInterface $config_factory */
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment