Problem/Motivation
API page: https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Entity%21...
The docblock is incomplete: missing description, missing param and return.
There are several other methods that are similarly lacking in documentation.
In order to fix core coding standards in a maintainable way, all our coding standards issues should be done on a per-rule basis across all of core, rather than fixing standards in individual modules or files. We should also separate fixes where we need to write new documentation from fixes where we need to correct existing standards. This all should be done as part of #2571965: [meta] Fix coding standards in core. A good place to start is the child issues of #2572645: [plan] Fix 'Drupal.Commenting.FunctionComment' coding standard.
For background information on why we usually will not commit coding standards fixes that aren't scoped in that way, see the core issue scope guidelines, especially the note about coding standards cleanups. That document also includes numerous suggestions for scoping issues including documentation coding standards cleanups.
Proposed resolution
Scope this to just the add new documentation.
Remaining tasks
User interface changes
No
API changes
No
Data model changes
No
Original Summary:
API page: https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Entity%21...
The docblock is incomplete: missing description, missing param and return.
There are several other methods that are similarly lacking in documentation. So, the scope of this issue is:
a) Make sure all methods on QueryInterface have first-line docs. Currently missing this:
- range()
- sort()
- accessCheck()
b) Make sure all methods on queryInterface have documentation lines with their param/return declarations (except @return $this, which has no documentation line). In addition to the methods in (a), methods needing work for this are:
- andConditionGroup
- orConditionGroup
- notExists (the @return should be @return $this)
- exists (the @return should be @return $this)
- condition (the @return should be @return $this)
- getEntityTypeId