Issue #3200735 by Matroskeen, quietone: Add documentation for user, profile and roles source plugins

core/modules/config_translation/src/Plugin/migrate/source/d6/ProfileFieldTranslation.php

@@ -5,7 +5,11 @@ namespace Drupal\config_translation\Plugin\migrate\source\d6;
 use Drupal\user\Plugin\migrate\source\ProfileField;
 
 /**
- * Gets i18n strings profile field source from database.
+ * Drupal 6 i18n strings profile field 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_profile_field_translation",

core/modules/user/src/Plugin/migrate/source/ProfileField.php

@@ -9,6 +9,10 @@ use Drupal\migrate\Row;
 /**
  * Profile field 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 = "profile_field",
  *   source_module = "profile"

core/modules/user/src/Plugin/migrate/source/UserPictureInstance.php

@@ -6,7 +6,11 @@ use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
 use Drupal\migrate\Plugin\migrate\source\DummyQueryTrait;
 
 /**
- * User picture field instance source.
+ * User picture field instance 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
  *
  * @todo Support default picture?
  *

core/modules/user/src/Plugin/migrate/source/d6/ProfileFieldOptionTranslation.php

@@ -5,7 +5,11 @@ namespace Drupal\user\Plugin\migrate\source\d6;
 use Drupal\user\Plugin\migrate\source\ProfileField;
 
 /**
- * Gets field option label translations.
+ * Drupal 6 i18n profile field option labels 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_profile_field_option_translation",

core/modules/user/src/Plugin/migrate/source/d6/ProfileFieldValues.php

@@ -6,7 +6,11 @@ use Drupal\migrate\Row;
 use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
 
 /**
- * Drupal 6 profile fields values source.
+ * Drupal 6 profile fields values 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_profile_field_values",

core/modules/user/src/Plugin/migrate/source/d6/Role.php

@@ -8,6 +8,10 @@ use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
 /**
  * Drupal 6 role 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_user_role",
  *   source_module = "user"

core/modules/user/src/Plugin/migrate/source/d6/User.php

@@ -8,6 +8,10 @@ use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
 /**
  * Drupal 6 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 = "d6_user",
  *   source_module = "user"

core/modules/user/src/Plugin/migrate/source/d6/UserPicture.php

@@ -7,6 +7,10 @@ use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
 /**
  * Drupal 6 user picture 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
+ *
  * @todo Support default picture?
  *
  * @MigrateSource(

core/modules/user/src/Plugin/migrate/source/d6/UserPictureFile.php

@@ -8,6 +8,14 @@ use Drupal\migrate\Row;
 /**
  * Drupal 6 user picture source from database.
  *
+ * Available configuration keys:
+ * - site_path: (optional) The path to the site directory relative to Drupal
+ *   root. Defaults to 'sites/default'.
+ *
+ * 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 = "d6_user_picture_file",
  *   source_module = "user"

core/modules/user/src/Plugin/migrate/source/d7/Role.php

@@ -8,6 +8,10 @@ use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase;
 /**
  * Drupal 7 role 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_user_role",
  *   source_module = "user"

core/modules/user/src/Plugin/migrate/source/d7/User.php

@@ -8,6 +8,10 @@ use Drupal\migrate_drupal\Plugin\migrate\source\d7\FieldableEntity;
 /**
  * Drupal 7 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_user",
  *   source_module = "user"

core/modules/user/src/Plugin/migrate/source/d7/UserEntityTranslation.php

@@ -8,6 +8,10 @@ use Drupal\migrate_drupal\Plugin\migrate\source\d7\FieldableEntity;
 /**
  * Provides Drupal 7 user entity translations 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_user_entity_translation",
  *   source_module = "entity_translation"