Issue #2617224 by Wim Leers: Move around/fix some documentation

core/modules/editor/src/Annotation/Editor.php

@@ -14,11 +14,43 @@
  *
  * Plugin Namespace: Plugin\Editor
  *
+ * Text editor plugin implementations need to define a plugin definition array
+ * through annotation. These definition arrays may be altered through
+ * hook_editor_info_alter(). The definition includes the following keys:
+ *
+ * - id: The unique, system-wide identifier of the text editor. Typically named
+ *   the same as the editor library.
+ * - label: The human-readable name of the text editor, translated.
+ * - supports_content_filtering: Whether the editor supports "allowed content
+ *   only" filtering.
+ * - supports_inline_editing: Whether the editor supports the inline editing
+ *   provided by the Edit module.
+ * - is_xss_safe: Whether this text editor is not vulnerable to XSS attacks.
+ * - supported_element_types: On which form element #types this text editor is
+ *   capable of working.
+ *
+ * A complete sample plugin definition should be defined as in this example:
+ *
+ * @code
+ * @Editor(
+ *   id = "myeditor",
+ *   label = @Translation("My Editor"),
+ *   supports_content_filtering = FALSE,
+ *   supports_inline_editing = FALSE,
+ *   is_xss_safe = FALSE,
+ *   supported_element_types = {
+ *     "textarea",
+ *     "textfield",
+ *   }
+ * )
+ * @endcode
+ *
  * For a working example, see \Drupal\ckeditor\Plugin\Editor\CKEditor
  *
  * @see \Drupal\editor\Plugin\EditorPluginInterface
  * @see \Drupal\editor\Plugin\EditorBase
  * @see \Drupal\editor\Plugin\EditorManager
+ * @see hook_editor_info_alter()
  * @see plugin_api
  *
  * @Annotation

core/modules/editor/src/EditorController.php

@@ -60,6 +60,9 @@ public function getUntransformedText(EntityInterface $entity, $field_name, $lang
    * @return \Symfony\Component\HttpFoundation\JsonResponse
    *   A JSON response containing the XSS-filtered value.
    *
+   * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
+   *   Thrown if no value to filter is specified.
+   *
    * @see editor_filter_xss()
    */
   public function filterXss(Request $request, FilterFormatInterface $filter_format) {

core/modules/editor/src/Plugin/EditorBase.php

@@ -17,30 +17,8 @@
  * This class provides default implementations of the EditorPluginInterface so
  * that classes extending this one do not need to implement every method.
  *
- * Plugins extending this class need to define a plugin definition array through
- * annotation. These definition arrays may be altered through
- * hook_editor_info_alter(). The definition includes the following keys:
- *
- * - id: The unique, system-wide identifier of the text editor. Typically named
- *   the same as the editor library.
- * - label: The human-readable name of the text editor, translated.
- * - supports_content_filtering: Whether the editor supports "allowed content
- *   only" filtering.
- * - supports_inline_editing: Whether the editor supports the inline editing
- *   provided by the Edit module.
- * - is_xss_safe: Whether this text editor is not vulnerable to XSS attacks.
- *
- * A complete sample plugin definition should be defined as in this example:
- *
- * @code
- * @Editor(
- *   id = "myeditor",
- *   label = @Translation("My Editor"),
- *   supports_content_filtering = FALSE,
- *   supports_inline_editing = FALSE,
- *   is_xss_safe = FALSE
- * )
- * @endcode
+ * Plugins extending this class need to specify an annotation containing the
+ * plugin definition so the plugin can be discovered.
  *
  * @see \Drupal\editor\Annotation\Editor
  * @see \Drupal\editor\Plugin\EditorPluginInterface