Commit 2d915cb4 authored by jhodgdon's avatar jhodgdon

Issue #2290255 by Wim Leers, er.pushpinderrana, amitgoyal: Make developer info...

Issue #2290255 by Wim Leers, er.pushpinderrana, amitgoyal: Make developer info for CKEditor plugins more discoverable
parent 2458d9ec
......@@ -12,6 +12,15 @@
/**
* 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 {
......
......@@ -25,10 +25,13 @@
*
* NOTE: the Drupal plugin ID should correspond to the CKEditor plugin name.
*
* @see CKEditorPluginInterface
* @see CKEditorPluginButtonsInterface
* @see CKEditorPluginContextualInterface
* @see CKEditorPluginConfigurableInterface
* @see \Drupal\ckeditor\CKEditorPluginInterface
* @see \Drupal\ckeditor\CKEditorPluginButtonsInterface
* @see \Drupal\ckeditor\CKEditorPluginContextualInterface
* @see \Drupal\ckeditor\CKEditorPluginConfigurableInterface
* @see \Drupal\ckeditor\CKEditorPluginManager
* @see \Drupal\ckeditor\Annotation\CKEditorPlugin
* @see plugin_api
*/
abstract class CKEditorPluginBase extends PluginBase implements CKEditorPluginInterface, CKEditorPluginButtonsInterface {
......
......@@ -20,8 +20,13 @@
* 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 CKEditorPluginConfigurableInterface
* @see \Drupal\ckeditor\CKEditorPluginInterface
* @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 {
......
......@@ -16,9 +16,13 @@
* then be automatically passed on to the corresponding CKEditor instance via
* CKEditorPluginInterface::getConfig().
*
* @see CKEditorPluginInterface
* @see CKEditorPluginButtonsInterface
* @see CKEditorPluginContextualInterface
* @see \Drupal\ckeditor\CKEditorPluginInterface
* @see \Drupal\ckeditor\CKEditorPluginButtonsInterface
* @see \Drupal\ckeditor\CKEditorPluginContextualInterface
* @see \Drupal\ckeditor\CKEditorPluginBase
* @see \Drupal\ckeditor\CKEditorPluginManager
* @see \Drupal\ckeditor\Annotation\CKEditorPlugin
* @see plugin_api
*/
interface CKEditorPluginConfigurableInterface extends CKEditorPluginInterface {
......
......@@ -20,7 +20,13 @@
* 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 {
......
......@@ -25,9 +25,13 @@
* Finally, if your plugin must be configurable, you can also implement the
* CKEditorPluginConfigurableInterface interface.
*
* @see CKEditorPluginButtonsInterface
* @see CKEditorPluginContextualInterface
* @see CKEditorPluginConfigurableInterface
* @see \Drupal\ckeditor\CKEditorPluginButtonsInterface
* @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 CKEditorPluginInterface extends PluginInspectionInterface {
......
......@@ -14,7 +14,15 @@
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 {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment