Issue #1793990 by -enzo-, socketwench: Partial cleanup for Config class documentation

core/lib/Drupal/Core/Config/Config.php

@@ -83,6 +83,9 @@ public function __construct($name, StorageInterface $storage, EventDispatcher $e
 
   /**
    * Initializes a configuration object.
+   *
+   * @return Drupal\Core\Config\Config
+   *   The configuration object.
    */
   public function init() {
     $this->notify('init');
@@ -91,6 +94,9 @@ public function init() {
 
   /**
    * Returns the name of this configuration object.
+   *
+   * @return string
+   *   The name of the configuration object.
    */
   public function getName() {
     return $this->name;
@@ -98,6 +104,9 @@ public function getName() {
 
   /**
    * Sets the name of this configuration object.
+   *
+   * @return Drupal\Core\Config\Config
+   *   The configuration object.
    */
   public function setName($name) {
     $this->name = $name;
@@ -106,6 +115,9 @@ public function setName($name) {
 
   /**
    * Returns whether this configuration object is new.
+   *
+   * @return bool
+   *   TRUE if this config object does not exist in storage.
    */
   public function isNew() {
     return $this->isNew;
@@ -114,7 +126,7 @@ public function isNew() {
   /**
    * Gets data from this config object.
    *
-   * @param $key
+   * @param string $key
    *   A string that maps to a key within the configuration data.
    *   For instance in the following configuation array:
    *   @code
@@ -133,9 +145,9 @@ public function isNew() {
    * cause issues with Booleans, which are casted to "1" (TRUE) or "0" (FALSE).
    * In particular, code relying on === or !== will no longer function properly.
    *
-   * @see http://php.net/manual/language.operators.comparison.php.
+   * @see http://php.net/manual/language.operators.comparison.php
    *
-   * @return
+   * @return mixed
    *   The data that was requested.
    */
   public function get($key = '') {
@@ -162,6 +174,9 @@ public function get($key = '') {
    *
    * @param array $data
    *   The new configuration data.
+   *
+   * @return Drupal\Core\Config\Config
+   *   The configuration object.
    */
   public function setData(array $data) {
     $this->data = $data;
@@ -176,6 +191,9 @@ public function setData(array $data) {
    *
    * @param array $data
    *   The overridden values of the configuration data.
+   *
+   * @return Drupal\Core\Config\Config
+   *   The configuration object.
    */
   public function setOverride(array $data) {
     $this->overrides = NestedArray::mergeDeepArray(array($this->overrides, $data));
@@ -187,6 +205,9 @@ public function setOverride(array $data) {
    * Sets the current data for this configuration object.
    *
    * Merges overridden configuration data into the original data.
+   *
+   * @return Drupal\Core\Config\Config
+   *   The configuration object.
    */
   protected function setOverriddenData() {
     $this->overriddenData = $this->data;
@@ -201,6 +222,9 @@ protected function setOverriddenData() {
    *
    * This method should be called after the original data or the overridden data
    * has been changed.
+   *
+   * @return Drupal\Core\Config\Config
+   *   The configuration object.
    */
   protected function resetOverriddenData() {
     unset($this->overriddenData);
@@ -210,10 +234,13 @@ protected function resetOverriddenData() {
   /**
    * Sets value in this config object.
    *
-   * @param $key
-   *   @todo
-   * @param $value
-   *   @todo
+   * @param string $key
+   *   Identifier to store value in config.
+   * @param string $value
+   *   Value to associate with identifier.
+   *
+   * @return Drupal\Core\Config\Config
+   *   The configuration object.
    */
   public function set($key, $value) {
     // Type-cast value into a string.
@@ -274,8 +301,11 @@ public function castValue($value) {
   /**
    * Unsets value in this config object.
    *
-   * @param $key
+   * @param string $key
    *   Name of the key whose value should be unset.
+   *
+   * @return Drupal\Core\Config\Config
+   *   The configuration object.
    */
   public function clear($key) {
     $parts = explode('.', $key);
@@ -291,6 +321,9 @@ public function clear($key) {
 
   /**
    * Loads configuration data into this object.
+   *
+   * @return Drupal\Core\Config\Config
+   *   The configuration object.
    */
   public function load() {
     $data = $this->storage->read($this->name);
@@ -308,6 +341,9 @@ public function load() {
 
   /**
    * Saves the configuration object.
+   *
+   * @return Drupal\Core\Config\Config
+   *   The configuration object.
    */
   public function save() {
     $this->sortByKey($this->data);
@@ -322,6 +358,9 @@ public function save() {
    *
    * @param $new_name
    *   The new name of the configuration object being constructed.
+   *
+   * @return Drupal\Core\Config\Config
+   *   The configuration object.
    */
   public function rename($new_name) {
     if ($this->storage->rename($this->name, $new_name)) {
@@ -352,6 +391,9 @@ public function sortByKey(array &$data) {
 
   /**
    * Deletes the configuration object.
+   *
+   * @return Drupal\Core\Config\Config
+   *   The configuration object.
    */
   public function delete() {
     // @todo Consider to remove the pruning of data for Config::delete().
@@ -365,6 +407,9 @@ public function delete() {
 
   /**
    * Retrieve the storage used to load and save this configuration object.
+   *
+   * @return Drupal\Core\Config\StorageInterface
+   *   The configuration storage object.
    */
   public function getStorage() {
     return $this->storage;