summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlex Pott2016-01-05 10:42:40 (GMT)
committerAlex Pott2016-01-05 10:42:40 (GMT)
commit32c319a102f6df069f04dd09dda680fd82dfb030 (patch)
tree6b35c7da393ac79400f4119256b5b00727f1a752
parentbe80816a56c4091eaacab9b10ab52b2799406959 (diff)
Issue #2625512 by heykarthikwithu, Mac_Weber, Wim Leers: Add @param, @return in the code base for the editor module
-rw-r--r--core/modules/editor/editor.module3
-rw-r--r--core/modules/editor/src/Plugin/InPlaceEditor/Editor.php5
-rw-r--r--core/modules/editor/src/Tests/QuickEditIntegrationTest.php12
3 files changed, 19 insertions, 1 deletions
diff --git a/core/modules/editor/editor.module b/core/modules/editor/editor.module
index a2c3219..8468caa 100644
--- a/core/modules/editor/editor.module
+++ b/core/modules/editor/editor.module
@@ -238,6 +238,9 @@ function editor_form_filter_admin_format_submit($form, FormStateInterface $form_
/**
* Loads an individual configured text editor based on text format ID.
*
+ * @param int $format_id
+ * A text format ID.
+ *
* @return \Drupal\editor\Entity\Editor|null
* A text editor object, or NULL.
*/
diff --git a/core/modules/editor/src/Plugin/InPlaceEditor/Editor.php b/core/modules/editor/src/Plugin/InPlaceEditor/Editor.php
index d56cfff..32df2f5 100644
--- a/core/modules/editor/src/Plugin/InPlaceEditor/Editor.php
+++ b/core/modules/editor/src/Plugin/InPlaceEditor/Editor.php
@@ -59,6 +59,11 @@ class Editor extends PluginBase implements InPlaceEditorInterface {
/**
* Returns whether the text format has transformation filters.
+ *
+ * @param int $format_id
+ * A text format ID.
+ *
+ * @return bool
*/
protected function textFormatHasTransformationFilters($format_id) {
$format = entity_load('filter_format', $format_id);
diff --git a/core/modules/editor/src/Tests/QuickEditIntegrationTest.php b/core/modules/editor/src/Tests/QuickEditIntegrationTest.php
index f9e1625..188a38b 100644
--- a/core/modules/editor/src/Tests/QuickEditIntegrationTest.php
+++ b/core/modules/editor/src/Tests/QuickEditIntegrationTest.php
@@ -111,7 +111,17 @@ class QuickEditIntegrationTest extends QuickEditTestBase {
}
/**
- * Returns the in-place editor that Edit selects.
+ * Returns the in-place editor that quickedit selects.
+ *
+ * @param int $entity_id
+ * An entity ID.
+ * @param string $field_name
+ * A field name.
+ * @param string $view_mode
+ * A view mode.
+ *
+ * @return string
+ * Returns the selected in-place editor.
*/
protected function getSelectedEditor($entity_id, $field_name, $view_mode = 'default') {
$entity = entity_load('entity_test', $entity_id, TRUE);