Issue #2845491 by Jo Fitzgerald, quietone, phenaproxima, ultimike: Add...

Issue #2845491 by Jo Fitzgerald, quietone, phenaproxima, ultimike: Add documentation to UrlEncode process plugin

core/modules/migrate/src/Plugin/migrate/process/UrlEncode.php

@@ -9,10 +9,21 @@
 use GuzzleHttp\Psr7\Uri;
 
 /**
- * Apply urlencoding to a URI.
+ * URL-encodes the input value.
  *
- * This is needed when the URI is to be opened by a later migration stage, and
- * the source URI value is not already encoded.
+ * Example:
+ *
+ * @code
+ * process:
+ *   new_url:
+ *     plugin: urlencode
+ *     source: 'http://example.com/a url with spaces.html'
+ * @endcode
+ *
+ * This will convert the source URL 'http://example.com/a url with spaces.html'
+ * into 'http://example.com/a%20url%20with%20spaces.html'.
+ *
+ * @see \Drupal\migrate\Plugin\MigrateProcessInterface
  *
  * @MigrateProcessPlugin(
  *   id = "urlencode"