Issue #3199741 by Matroskeen, quietone: Add documentation for remaining source plugins

core/modules/action/src/Plugin/migrate/source/Action.php

@@ -6,7 +6,12 @@ use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
 use Drupal\migrate\Row;
 
 /**
- * Drupal action source from database.
+ * Drupal 6/7 action source from database.
+ *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
  *
  * @MigrateSource(
  *   id = "action",

core/modules/aggregator/src/Plugin/migrate/source/AggregatorFeed.php

@@ -5,7 +5,12 @@ namespace Drupal\aggregator\Plugin\migrate\source;
 use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
 
 /**
- * Drupal feed source from database.
+ * Drupal 6/7 feed source from database.
+ *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
  *
  * @MigrateSource(
  *   id = "aggregator_feed",

core/modules/aggregator/src/Plugin/migrate/source/AggregatorItem.php

@@ -5,7 +5,12 @@ namespace Drupal\aggregator\Plugin\migrate\source;
 use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
 
 /**
- * Drupal aggregator item source from database.
+ * Drupal 6/7 aggregator item source from database.
+ *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
  *
  * @MigrateSource(
  *   id = "aggregator_item",

core/modules/ban/src/Plugin/migrate/source/d7/BlockedIps.php

@@ -5,7 +5,12 @@ namespace Drupal\ban\Plugin\migrate\source\d7;
 use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
 
 /**
- * Drupal 7 blocked IPs from database.
+ * Drupal 7 blocked IPs source from database.
+ *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
  *
  * @MigrateSource(
  *   id = "d7_blocked_ips",

core/modules/book/src/Plugin/migrate/source/Book.php

@@ -5,7 +5,12 @@ namespace Drupal\book\Plugin\migrate\source;
 use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
 
 /**
- * Drupal 6 and 7 book source.
+ * Drupal 6/7 book source from database.
+ *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
  *
  * @MigrateSource(
  *   id = "book",

core/modules/color/src/Plugin/migrate/source/d7/Color.php

@@ -13,6 +13,11 @@ use Symfony\Component\DependencyInjection\ContainerInterface;
 /**
  * Drupal 7 color source from database.
  *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
+ *
  * @MigrateSource(
  *   id = "d7_color",
  *   source_module = "color"

core/modules/comment/src/Plugin/migrate/source/CommentType.php

@@ -7,7 +7,12 @@ use Drupal\migrate\Row;
 use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
 
 /**
- * Migration source for Drupal 6 and Drupal 7 comment types.
+ * Drupal 6/7 comment types source from database.
+ *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
  *
  * @MigrateSource(
  *   id = "comment_type",

core/modules/comment/src/Plugin/migrate/source/d6/Comment.php

@@ -8,6 +8,11 @@ use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
 /**
  * Drupal 6 comment source from database.
  *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
+ *
  * @MigrateSource(
  *   id = "d6_comment",
  *   source_module = "comment"

core/modules/comment/src/Plugin/migrate/source/d7/Comment.php

@@ -8,6 +8,11 @@ use Drupal\migrate_drupal\Plugin\migrate\source\d7\FieldableEntity;
 /**
  * Drupal 7 comment source from database.
  *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
+ *
  * @MigrateSource(
  *   id = "d7_comment",
  *   source_module = "comment"

core/modules/comment/src/Plugin/migrate/source/d7/CommentEntityTranslation.php

@@ -7,7 +7,12 @@ use Drupal\migrate\Row;
 use Drupal\migrate_drupal\Plugin\migrate\source\d7\FieldableEntity;
 
 /**
- * Provides Drupal 7 comment entity translation source plugin.
+ * Drupal 7 comment entity translation source plugin.
+ *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
  *
  * @MigrateSource(
  *   id = "d7_comment_entity_translation",

core/modules/contact/src/Plugin/migrate/source/ContactCategory.php

@@ -6,7 +6,12 @@ use Drupal\migrate\Row;
 use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
 
 /**
- * Contact category source from database.
+ * Drupal 6/7 contact category source from database.
+ *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
  *
  * @MigrateSource(
  *   id = "contact_category",

core/modules/contact/src/Plugin/migrate/source/ContactSettings.php

@@ -5,6 +5,13 @@ namespace Drupal\contact\Plugin\migrate\source;
 use Drupal\migrate_drupal\Plugin\migrate\source\Variable;
 
 /**
+ * Drupal 6/7 contact settings source from database.
+ *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
+ *
  * @MigrateSource(
  *   id = "contact_settings",
  *   source_module = "contact"

core/modules/content_translation/src/Plugin/migrate/source/d7/EntityTranslationSettings.php

@@ -5,7 +5,12 @@ namespace Drupal\content_translation\Plugin\migrate\source\d7;
 use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
 
 /**
- * Drupal 7 Entity Translation settings from variables.
+ * Drupal 7 Entity Translation settings (variables) from database.
+ *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
  *
  * @MigrateSource(
  *   id = "d7_entity_translation_settings",

core/modules/field/src/Plugin/migrate/source/d7/ViewMode.php

@@ -3,7 +3,12 @@
 namespace Drupal\field\Plugin\migrate\source\d7;
 
 /**
- * The view mode source class.
+ * Drupal 7 view mode source from database.
+ *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
  *
  * @MigrateSource(
  *   id = "d7_view_mode",

core/modules/filter/src/Plugin/migrate/source/d6/FilterFormat.php

@@ -8,6 +8,11 @@ use Drupal\migrate\Row;
 /**
  * Drupal 6 filter source from database.
  *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
+ *
  * @MigrateSource(
  *   id = "d6_filter_format",
  *   source_module = "filter"

core/modules/filter/src/Plugin/migrate/source/d7/FilterFormat.php

@@ -8,6 +8,11 @@ use Drupal\migrate\Row;
 /**
  * Drupal 7 filter source from database.
  *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
+ *
  * @MigrateSource(
  *   id = "d7_filter_format",
  *   source_module = "filter"

core/modules/image/src/Plugin/migrate/source/d6/ImageCachePreset.php

@@ -8,6 +8,11 @@ use Drupal\migrate\Row;
 /**
  * Drupal 6 imagecache presets source from database.
  *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
+ *
  * @MigrateSource(
  *   id = "d6_imagecache_presets",
  *   source_module = "imagecache"

core/modules/image/src/Plugin/migrate/source/d7/ImageStyles.php

@@ -6,7 +6,12 @@ use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
 use Drupal\migrate\Row;
 
 /**
- * Drupal image styles source from database.
+ * Drupal 7 image styles source from database.
+ *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
  *
  * @MigrateSource(
  *   id = "d7_image_styles",

core/modules/migrate_drupal/src/Plugin/migrate/source/EmptySource.php

@@ -13,6 +13,12 @@ use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
 /**
  * Source returning an empty row with Drupal specific config dependencies.
  *
+ * For more information and available configuration keys, refer to the parent
+ * classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\EmptySource
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
+ *
  * @MigrateSource(
  *   id = "md_empty",
  *   source_module = "system",

core/modules/path/src/Plugin/migrate/source/d6/UrlAlias.php

@@ -5,7 +5,12 @@ namespace Drupal\path\Plugin\migrate\source\d6;
 use Drupal\path\Plugin\migrate\source\UrlAliasBase;
 
 /**
- * URL aliases source from database.
+ * Drupal 6 URL aliases source from database.
+ *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
  *
  * @MigrateSource(
  *   id = "d6_url_alias",

core/modules/path/src/Plugin/migrate/source/d7/UrlAlias.php

@@ -5,7 +5,12 @@ namespace Drupal\path\Plugin\migrate\source\d7;
 use Drupal\path\Plugin\migrate\source\UrlAliasBase;
 
 /**
- * URL aliases source from database.
+ * Drupal 7 URL aliases source from database.
+ *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
  *
  * @MigrateSource(
  *   id = "d7_url_alias",

core/modules/rdf/src/Plugin/migrate/source/d7/RdfMapping.php

@@ -8,6 +8,11 @@ use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
 /**
  * Drupal 7 rdf source from database.
  *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
+ *
  * @MigrateSource(
  *   id = "d7_rdf_mapping",
  *   source_module = "rdf"

core/modules/search/src/Plugin/migrate/source/d6/SearchPage.php

@@ -5,7 +5,13 @@ namespace Drupal\search\Plugin\migrate\source\d6;
 use Drupal\migrate_drupal\Plugin\migrate\source\Variable;
 
 /**
- * Get node search rankings for core modules.
+ * Drupal 6 node search rankings for core modules source from database.
+ *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate_drupal\Plugin\migrate\source\Variable
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
  *
  * @MigrateSource(
  *   id = "d6_search_page",

core/modules/search/src/Plugin/migrate/source/d7/SearchPage.php

@@ -6,7 +6,13 @@ use Drupal\migrate\Row;
 use Drupal\migrate_drupal\Plugin\migrate\source\Variable;
 
 /**
- * Get search_active_modules and rankings for core modules.
+ * Drupal 7 search active core modules and rankings source from database.
+ *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate_drupal\Plugin\migrate\source\Variable
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
  *
  * @MigrateSource(
  *   id = "d7_search_page",

core/modules/shortcut/src/Plugin/migrate/source/d7/Shortcut.php

@@ -7,6 +7,11 @@ use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
 /**
  * Drupal 7 shortcut links source from database.
  *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
+ *
  * @MigrateSource(
  *   id = "d7_shortcut",
  *   source_module = "shortcut"

core/modules/shortcut/src/Plugin/migrate/source/d7/ShortcutSet.php

@@ -7,6 +7,11 @@ use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
 /**
  * Drupal 7 shortcut_set source from database.
  *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
+ *
  * @MigrateSource(
  *   id = "d7_shortcut_set",
  *   source_module = "shortcut"

core/modules/shortcut/src/Plugin/migrate/source/d7/ShortcutSetUsers.php

@@ -7,6 +7,11 @@ use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
 /**
  * Drupal 7 shortcut_set_users source from database.
  *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
+ *
  * @MigrateSource(
  *   id = "d7_shortcut_set_users",
  *   source_module = "shortcut"

core/modules/statistics/src/Plugin/migrate/source/NodeCounter.php

@@ -5,7 +5,12 @@ namespace Drupal\statistics\Plugin\migrate\source;
 use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
 
 /**
- * Node counter source from database.
+ * Drupal 6/7 node counter source from database.
+ *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
  *
  * @MigrateSource(
  *   id = "node_counter",

core/modules/system/src/Plugin/migrate/source/Extension.php

@@ -6,7 +6,28 @@ use Drupal\migrate\Row;
 use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
 
 /**
- * Gets system data for a legacy extension.
+ * Drupal 6/7 system data for a legacy extension source from database.
+ *
+ * Available configuration keys:
+ * - name: (optional) The extension name to filter items retrieved from the
+ *   source - can be a string or an array. If omitted, all extensions are
+ *   retrieved.
+ *
+ * Examples:
+ *
+ * @code
+ * source:
+ *   plugin: extension
+ *   name: node
+ * @endcode
+ *
+ * In this example the system data for node module is retrieved from the source
+ * database.
+ *
+ * For additional configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
  *
  * @MigrateSource(
  *   id = "extension",

core/modules/system/src/Plugin/migrate/source/Menu.php

@@ -5,7 +5,12 @@ namespace Drupal\system\Plugin\migrate\source;
 use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
 
 /**
- * Menu source from database.
+ * Drupal 6/7 menu source from database.
+ *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
  *
  * @MigrateSource(
  *   id = "menu",

core/modules/system/src/Plugin/migrate/source/d7/MenuTranslation.php

@@ -5,7 +5,12 @@ namespace Drupal\system\Plugin\migrate\source\d7;
 use Drupal\system\Plugin\migrate\source\Menu;
 
 /**
- * Menu translation source from database.
+ * Drupal 7 i18n menu translation source from database.
+ *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
  *
  * @MigrateSource(
  *   id = "d7_menu_translation",

core/modules/system/src/Plugin/migrate/source/d7/ThemeSettings.php

@@ -5,7 +5,13 @@ namespace Drupal\system\Plugin\migrate\source\d7;
 use Drupal\migrate_drupal\Plugin\migrate\source\VariableMultiRow;
 
 /**
- * Drupal 7 system source from database.
+ * Drupal 7 theme settings source from database.
+ *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate_drupal\Plugin\migrate\source\VariableMultiRow
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
  *
  * @MigrateSource(
  *   id = "d7_theme_settings",

core/modules/tracker/src/Plugin/migrate/source/d7/TrackerNode.php

@@ -7,6 +7,11 @@ use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
 /**
  * Drupal 7 tracker node source from database.
  *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
+ *
  * @MigrateSource(
  *   id = "d7_tracker_node",
  *   source_module = "tracker"

core/modules/tracker/src/Plugin/migrate/source/d7/TrackerUser.php

@@ -7,6 +7,11 @@ use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
 /**
  * Drupal 7 tracker user source from database.
  *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
+ *
  * @MigrateSource(
  *   id = "d7_tracker_user",
  *   source_module = "tracker"

core/modules/update/src/Plugin/migrate/source/UpdateSettings.php

@@ -5,7 +5,13 @@ namespace Drupal\update\Plugin\migrate\source;
 use Drupal\migrate_drupal\Plugin\migrate\source\Variable;
 
 /**
- * Update settings source plugin.
+ * Drupal 6/7 Update settings source from database.
+ *
+ * For available configuration keys, refer to the parent classes.
+ *
+ * @see \Drupal\migrate_drupal\Plugin\migrate\source\Variable
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
  *
  * @MigrateSource(
  *   id = "update_settings",