Add links to documentation in all migrate process plugins

Validated all links are added in all the files except

MenuLinkParent.php
Extract.php
latten.php
Iterator.php
Route.php
StaticMap.php

Do we have specific reason for not adding the documentation links for these.

I see, the documentation is added for all except MenuLinkParent and Route so it should be RTBC .

Do we need to add documentation for MenuLinkParent and Route?

Do we need to add documentation for MenuLinkParent and Route?

Yes, I think so. I've yet to delve into menus and routing, so not the best task for me to do.

Should this use @link instead of @see?

Looking at the standards I think it should. https://www.drupal.org/coding-standards/docs#link

Hi All,

I have re patched using the 2682461-document_migrate_process_plugins.patch, it will support for drupal 8.x.2-dev version

Still needs to use @link as per #8

As per Comment #8 patched is rewritten.
@benjy thanks

Looking at the docs we need something like See also @link http://example.com Process xyz docs, @endlink

Might be worth having a documentation maintainer chip in here on the best way to structure this.

@benjy thanks, changes updated in new patch

Not sure why adding documentation caused a failure. So, retesting.

Test passed, setting back to RTBC.

Testing again

Passed again, so RTBC.

(Saving credit.)

Nice work gathering the links to these docs and formatting them for our API docblocks.

In the longer term, I wonder if the documentation for the process plugins should maybe in the codebase itself, rather than maintaining it in the handbook, since it is specific 1-1 documentation rather than any overall documentation. Could someone create a followup documentation issue to discuss that?

In the meanwhile though, this is a definite improvement that will make it easier to find the needed documentation when developing for Migrate. I do think we need to give the link text more context, though, for accessibility reasons among other things. Just having a link that says "Process plugin: foo" when you are already on a page about "Process plugin: foo" is kind of confusing. I'd suggest text like:
@link https://www.drupal.org/node/12345 Online handbook documentation for foo process plugins @endlink

(Fixing credit again.)

Addressing #25.

1. Follow up issue created, #2776179: [meta] Add process plugin documentation to the codebase
2. Modified @links with the suggested text, and included more plugins.

Uploading the patch would help.

Good stuff.

Committed 0ce97fb and pushed to 8.3.x, 8.2.x, and 8.1.x. Thanks!

Fixed the following coding standards error on commit:

FILE: ...r/core/modules/migrate/src/Plugin/migrate/process/DedupeBase.php
----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 21 | ERROR | [x] Additional blank lines found at end of doc comment
----------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------

diff --git a/core/modules/migrate/src/Plugin/migrate/process/DedupeBase.php b/core/modules/migrate/src/Plugin/migrate/process/DedupeBase.php
index c11be62..adaf720 100644
--- a/core/modules/migrate/src/Plugin/migrate/process/DedupeBase.php
+++ b/core/modules/migrate/src/Plugin/migrate/process/DedupeBase.php
@@ -17,7 +17,6 @@
  * and incremented until a unique value is created.
  *
  * @link https://www.drupal.org/node/2345929 Online handbook documentation for dedupebase process plugin @endlink
- *
  */
 abstract class DedupeBase extends ProcessPluginBase {