Remove description from @return $this

Problem/Motivation

1) Confirmed that the changes in #11 are for returning $this as noted in #6. Note that some core code adds a description for * @return $this and some do not.

-- @Kristen Pol ( #3115436: Use proper dependency injection and protect menu_block from changes to the SystemMenuBlock constructor → , #13.1)

When you do @return $this, do not provide a description like "The called object" -- just take that line out.

-- @jhodgdon a leader of the documentation team ( #2711739: Missing summary/param/return docs for several QueryInterface methods → , #18.3)

Proposed resolution

1. Remove them.
2. A coder sniffer is expected if necessary
3. Meanwhile there should have usages that should be changed to $this, suggested to do it in a separate issue

+++ b/core/lib/Drupal/Core/Entity/Query/QueryInterface.php
@@ -111,19 +111,28 @@ public function notExists($field, $langcode = NULL);
* @return \Drupal\Core\Entity\Query\QueryInterface
* The called object.
This should be changed to say:

@return $this

-- @jhodgdon (#2711739-#6.4)

Remaining tasks

Postponed on #3326851: Update about @return $this → and possibly #3326850: Warn if @return $this has description → .

This may help to find all the instances that need to be fixed.
grep -r -A1 '@return $this' core | grep -v return | grep -v -- -- | grep -v \*\/

Child issues

• #3326850: Warn if @return $this has description →
• #3326851: Update about @return $this →

• Update Coding standard documentation →
• Commit

User interface changes

API changes

Data model changes

Release notes snippet