Issue #2290255 by Wim Leers, er.pushpinderrana, amitgoyal: Make developer info for CKEditor plugins more discoverable

core/modules/ckeditor/src/Annotation/CKEditorPlugin.php

@@ -12,6 +12,15 @@ use Drupal\Component\Annotation\Plugin;
 /**
  * Defines a CKEditorPlugin annotation object.
  *
+ * Plugin Namespace: Plugin\CKEditorPlugin
+ *
+ * For a working example, see \Drupal\ckeditor\Plugin\CKEditorPlugin\DrupalImage
+ *
+ * @see \Drupal\ckeditor\CKEditorPluginInterface
+ * @see \Drupal\ckeditor\CKEditorPluginBase
+ * @see \Drupal\ckeditor\CKEditorPluginManager
+ * @see plugin_api
+ *
  * @Annotation
  */
 class CKEditorPlugin extends Plugin {

core/modules/ckeditor/src/CKEditorPluginBase.php

@@ -25,10 +25,13 @@ use Drupal\editor\Entity\Editor;
  *
  * NOTE: the Drupal plugin ID should correspond to the CKEditor plugin name.
  *
- * @see CKEditorPluginInterface
+ * @see \Drupal\ckeditor\CKEditorPluginInterface
- * @see CKEditorPluginButtonsInterface
+ * @see \Drupal\ckeditor\CKEditorPluginButtonsInterface
- * @see CKEditorPluginContextualInterface
+ * @see \Drupal\ckeditor\CKEditorPluginContextualInterface
- * @see CKEditorPluginConfigurableInterface
+ * @see \Drupal\ckeditor\CKEditorPluginConfigurableInterface
+ * @see \Drupal\ckeditor\CKEditorPluginManager
+ * @see \Drupal\ckeditor\Annotation\CKEditorPlugin
+ * @see plugin_api
  */
 abstract class CKEditorPluginBase extends PluginBase implements CKEditorPluginInterface, CKEditorPluginButtonsInterface {
 

core/modules/ckeditor/src/CKEditorPluginButtonsInterface.php

@@ -20,8 +20,13 @@ namespace Drupal\ckeditor;
  * added as well. The downside of conditionally adding buttons is that the user
  * cannot see these buttons in the toolbar builder UI.
  *
- * @see CKEditorPluginContextualInterface
+ * @see \Drupal\ckeditor\CKEditorPluginInterface
- * @see CKEditorPluginConfigurableInterface
+ * @see \Drupal\ckeditor\CKEditorPluginContextualInterface
+ * @see \Drupal\ckeditor\CKEditorPluginConfigurableInterface
+ * @see \Drupal\ckeditor\CKEditorPluginBase
+ * @see \Drupal\ckeditor\CKEditorPluginManager
+ * @see \Drupal\ckeditor\Annotation\CKEditorPlugin
+ * @see plugin_api
  */
 interface CKEditorPluginButtonsInterface extends CKEditorPluginInterface {
 

core/modules/ckeditor/src/CKEditorPluginConfigurableInterface.php

@@ -16,9 +16,13 @@ use Drupal\editor\Entity\Editor;
  * then be automatically passed on to the corresponding CKEditor instance via
  * CKEditorPluginInterface::getConfig().
  *
- * @see CKEditorPluginInterface
+ * @see \Drupal\ckeditor\CKEditorPluginInterface
- * @see CKEditorPluginButtonsInterface
+ * @see \Drupal\ckeditor\CKEditorPluginButtonsInterface
- * @see CKEditorPluginContextualInterface
+ * @see \Drupal\ckeditor\CKEditorPluginContextualInterface
+ * @see \Drupal\ckeditor\CKEditorPluginBase
+ * @see \Drupal\ckeditor\CKEditorPluginManager
+ * @see \Drupal\ckeditor\Annotation\CKEditorPlugin
+ * @see plugin_api
  */
 interface CKEditorPluginConfigurableInterface extends CKEditorPluginInterface {
 

core/modules/ckeditor/src/CKEditorPluginContextualInterface.php

@@ -20,7 +20,13 @@ use Drupal\editor\Entity\Editor;
  * the case where it must be enabled based on an explicit setting), then one
  * must also implement the CKEditorPluginConfigurableInterface interface.
  *
- * @see CKEditorPluginConfigurableInterface
+ * @see \Drupal\ckeditor\CKEditorPluginInterface
+ * @see \Drupal\ckeditor\CKEditorPluginButtonsInterface
+ * @see \Drupal\ckeditor\CKEditorPluginConfigurableInterface
+ * @see \Drupal\ckeditor\CKEditorPluginBase
+ * @see \Drupal\ckeditor\CKEditorPluginManager
+ * @see \Drupal\ckeditor\Annotation\CKEditorPlugin
+ * @see plugin_api
  */
 interface CKEditorPluginContextualInterface extends CKEditorPluginInterface {
 

core/modules/ckeditor/src/CKEditorPluginInterface.php

@@ -25,9 +25,13 @@ use Drupal\editor\Entity\Editor;
  * Finally, if your plugin must be configurable, you can also implement the
  * CKEditorPluginConfigurableInterface interface.
  *
- * @see CKEditorPluginButtonsInterface
+ * @see \Drupal\ckeditor\CKEditorPluginButtonsInterface
- * @see CKEditorPluginContextualInterface
+ * @see \Drupal\ckeditor\CKEditorPluginContextualInterface
- * @see CKEditorPluginConfigurableInterface
+ * @see \Drupal\ckeditor\CKEditorPluginConfigurableInterface
+ * @see \Drupal\ckeditor\CKEditorPluginBase
+ * @see \Drupal\ckeditor\CKEditorPluginManager
+ * @see \Drupal\ckeditor\Annotation\CKEditorPlugin
+ * @see plugin_api
  */
 interface CKEditorPluginInterface extends PluginInspectionInterface {
 

core/modules/ckeditor/src/CKEditorPluginManager.php

@@ -14,7 +14,15 @@ use Drupal\Core\Extension\ModuleHandlerInterface;
 use Drupal\editor\Entity\Editor;
 
 /**
- * CKEditor Plugin manager.
+ * Provides a CKEditor Plugin plugin manager.
+ *
+ * @see \Drupal\ckeditor\CKEditorPluginInterface
+ * @see \Drupal\ckeditor\CKEditorPluginButtonsInterface
+ * @see \Drupal\ckeditor\CKEditorPluginContextualInterface
+ * @see \Drupal\ckeditor\CKEditorPluginConfigurableInterface
+ * @see \Drupal\ckeditor\CKEditorPluginBase
+ * @see \Drupal\ckeditor\Annotation\CKEditorPlugin
+ * @see plugin_api
  */
 class CKEditorPluginManager extends DefaultPluginManager {