A lot of plugins in core have a copy/pasted constructor documentation that should be tailored to the specific plugin.

See all instances of Constructs a Drupal\Component\Plugin\PluginBase object. current in core:

By running this commannd in drupal root folder
grep -rn 'Constructs a Drupal\\Component\\Plugin\\PluginBase object' core

core/modules/aggregator/src/Plugin/views/argument/Fid.php:   * Constructs a Drupal\Component\Plugin\PluginBase object.
core/modules/aggregator/src/Plugin/views/argument/Iid.php:   * Constructs a Drupal\Component\Plugin\PluginBase object.
core/modules/ckeditor/src/Plugin/Editor/CKEditor.php:   * Constructs a Drupal\Component\Plugin\PluginBase object.
core/modules/comment/src/Plugin/views/argument/UserUid.php:   * Constructs a Drupal\Component\Plugin\PluginBase object.
core/modules/comment/src/Plugin/views/field/NodeNewComments.php:   * Constructs a Drupal\Component\Plugin\PluginBase object.
core/modules/node/src/Plugin/views/argument/Vid.php:   * Constructs a Drupal\Component\Plugin\PluginBase object.
core/modules/user/src/Plugin/views/argument/Uid.php:   * Constructs a Drupal\Component\Plugin\PluginBase object.
core/modules/user/src/Plugin/views/field/Permissions.php:   * Constructs a Drupal\Component\Plugin\PluginBase object.
core/modules/user/src/Plugin/views/field/Roles.php:   * Constructs a Drupal\Component\Plugin\PluginBase object.

I don't think they need anything fancy, just maybe replaced with the actual plugin object being constructed.

CommentFileSizeAuthor
#7 interdiff-4-7.txt6.29 KBmsankhala
#7 fix-plugin-constructors-doc-2985147-7.patch6.11 KBmsankhala
#4 2985147-4.patch5.64 KBeli-on-drupal
#2 2985147.patch5.92 KBeli-on-drupal
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

neclimdul created an issue. See original summary.

eli-on-drupal’s picture

eli-on-drupal CreditAttribution: eli-on-drupal at Mindgrub Technologies commented
Status: Active » Needs review
FileSize
2985147.patch5.92 KB

Here is a patch with the changes.

Status: Needs review » Needs work

The last submitted patch, 2: 2985147.patch, failed testing. View results

eli-on-drupal’s picture

eli-on-drupal CreditAttribution: eli-on-drupal at Mindgrub Technologies commented
Status: Needs work » Needs review
FileSize
2985147-4.patch5.64 KB

Whoops, I misconfigured my repo there. This one should be fixed.

neclimdul’s picture

neclimdul
He/Him
CreditAttribution: neclimdul at APQC commented
Status: Needs review » Needs work

Thanks! The namespaces look off though.

  1. +++ b/core/modules/aggregator/src/Plugin/views/argument/Fid.php
@@ -23,7 +23,7 @@ class Fid extends NumericArgument {
-   * Constructs a Drupal\Component\Plugin\PluginBase object.
+   * Constructs a Drupal\views\Plugin\views\argument\NumericArgument\Fid object.

+++ b/core/modules/aggregator/src/Plugin/views/argument/Iid.php
@@ -23,7 +23,7 @@ class Iid extends NumericArgument {
-   * Constructs a Drupal\Component\Plugin\PluginBase object.
+   * Constructs a Drupal\views\Plugin\views\argument\NumericArgument\Iid object.

    Drupal\aggregator 

  2. +++ b/core/modules/ckeditor/src/Plugin/Editor/CKEditor.php
@@ -58,7 +58,7 @@ class CKEditor extends EditorBase implements ContainerFactoryPluginInterface {
-   * Constructs a Drupal\Component\Plugin\PluginBase object.
+   * Constructs a Drupal\editor\Plugin\EditorBase\CKEditor object.

    Drupal\ckeditor 

  3. +++ b/core/modules/comment/src/Plugin/views/argument/UserUid.php
@@ -25,7 +25,7 @@ class UserUid extends ArgumentPluginBase {
-   * Constructs a Drupal\Component\Plugin\PluginBase object.
+   * Constructs a Drupal\views\Plugin\views\argument\ArgumentPluginBase\UserUid object.

+++ b/core/modules/comment/src/Plugin/views/field/NodeNewComments.php
@@ -36,7 +36,7 @@ public function usesGroupBy() {
-   * Constructs a Drupal\Component\Plugin\PluginBase object.
+   * Constructs a Drupal\views\Plugin\views\field\NumericField\NodeNewComments object.

    \Drupal\comment 

  4. +++ b/core/modules/node/src/Plugin/views/argument/Vid.php
@@ -29,7 +29,7 @@ class Vid extends NumericArgument {
-   * Constructs a Drupal\Component\Plugin\PluginBase object.
+   * Constructs a Drupal\views\Plugin\views\argument\NumericArgument\Vid object.

    Drupal\node 

  5. +++ b/core/modules/user/src/Plugin/views/argument/Uid.php
@@ -23,7 +23,7 @@ class Uid extends NumericArgument {
-   * Constructs a Drupal\Component\Plugin\PluginBase object.
+   * Constructs a Drupal\views\Plugin\views\argument\NumericArgument\Uid object.

+++ b/core/modules/user/src/Plugin/views/field/Permissions.php
@@ -33,7 +33,7 @@ class Permissions extends PrerenderList {
-   * Constructs a Drupal\Component\Plugin\PluginBase object.
+   * Constructs a Drupal\views\Plugin\views\field\PrerenderList\Permissions object.

+++ b/core/modules/user/src/Plugin/views/field/Roles.php
@@ -25,7 +25,7 @@ class Roles extends PrerenderList {
-   * Constructs a Drupal\Component\Plugin\PluginBase object.
+   * Constructs a Drupal\views\Plugin\views\field\PrerenderList\Roles object.

    Drupal\user

msankhala’s picture

msankhala CreditAttribution: msankhala as a volunteer and at Srijan | A Material+ Company commented

Also as per Drupal API documentation standards for classes and namespaces https://www.drupal.org/docs/develop/coding-standards/api-documentation-a...

If you use a namespace on a class anywhere in documentation, always make sure it is a fully-qualified namespace (beginning with a backslash).

msankhala’s picture

msankhala CreditAttribution: msankhala as a volunteer and at Srijan | A Material+ Company commented
FileSize
fix-plugin-constructors-doc-2985147-7.patch6.11 KB
interdiff-4-7.txt6.29 KB

Here is updated patch.

msankhala’s picture

msankhala CreditAttribution: msankhala as a volunteer and at Srijan | A Material+ Company commented
Status: Needs work » Needs review
msankhala’s picture

msankhala CreditAttribution: msankhala as a volunteer and at Srijan | A Material+ Company commented
Issue summary: View changes

Version: 8.6.x-dev » 8.7.x-dev

Drupal 8.6.0-alpha1 will be released the week of July 16, 2018, which means new developments and disruptive changes should now be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

neclimdul’s picture

neclimdul
He/Him
CreditAttribution: neclimdul at APQC commented
Status: Needs review » Reviewed & tested by the community

lgtm

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
CreditAttribution: alexpott at Acro Commerce, Thunder commented
alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
CreditAttribution: alexpott at Acro Commerce, Thunder commented
Status: Reviewed & tested by the community » Fixed

Committed and pushed 8c5075ad69 to 8.7.x and dbf7f873ea to 8.6.x. Thanks!

  • alexpott committed 8c5075a on 8.7.x 
    Issue #2985147 by eliclaggett, msankhala, neclimdul: Correct copy pasted...

  • alexpott committed dbf7f87 on 8.6.x 
    Issue #2985147 by eliclaggett, msankhala, neclimdul: Correct copy pasted...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.