summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorwebchick2015-08-31 16:16:47 (GMT)
committerwebchick2015-08-31 16:16:47 (GMT)
commitb1d31da930a75c99ed655bbc2f342ee488471ae1 (patch)
treea52319dfe00556c3e30a007ac458c260da264db0
parenta937892097c52fb013c97038a8dcc54d4d3f6630 (diff)
Issue #2525436 by eiriksm, nod_: JSDoc filter module
-rw-r--r--core/modules/filter/filter.admin.js8
-rw-r--r--core/modules/filter/filter.filter_html.admin.js5
-rw-r--r--core/modules/filter/filter.js3
3 files changed, 14 insertions, 2 deletions
diff --git a/core/modules/filter/filter.admin.js b/core/modules/filter/filter.admin.js
index e14634c..3af5624 100644
--- a/core/modules/filter/filter.admin.js
+++ b/core/modules/filter/filter.admin.js
@@ -8,8 +8,12 @@
"use strict";
/**
+ * Displays and updates the status of filters on the admin page.
*
* @type {Drupal~behavior}
+ *
+ * @prop {Drupal~behaviorAttach} attach
+ * Attaches behaviors to the filter admin view.
*/
Drupal.behaviors.filterStatus = {
attach: function (context, settings) {
@@ -22,8 +26,8 @@
var $filterSettings = $context.find('#' + $checkbox.attr('id').replace(/-status$/, '-settings'));
var filterSettingsTab = $filterSettings.data('verticalTab');
- // Bind click handler to this checkbox to conditionally show and hide the
- // filter's tableDrag row and vertical tab pane.
+ // Bind click handler to this checkbox to conditionally show and hide
+ // the filter's tableDrag row and vertical tab pane.
$checkbox.on('click.filterUpdate', function () {
if ($checkbox.is(':checked')) {
$row.show();
diff --git a/core/modules/filter/filter.filter_html.admin.js b/core/modules/filter/filter.filter_html.admin.js
index 1a20cfa..75a9824 100644
--- a/core/modules/filter/filter.filter_html.admin.js
+++ b/core/modules/filter/filter.filter_html.admin.js
@@ -19,6 +19,7 @@
/**
* @return {Array}
+ * An array of filter rules.
*/
getRules: function () {
var currentValue = $('#edit-filters-filter-html-settings-allowed-html').val();
@@ -45,10 +46,14 @@
}
/**
+ * Displays and updates what HTML tags are allowed to use in a filter.
*
* @type {Drupal~behavior}
*
* @todo Remove everything but 'attach' and 'detach' and make a proper object.
+ *
+ * @prop {Drupal~behaviorAttach} attach
+ * Attaches behavior for updating allowed HTML tags.
*/
Drupal.behaviors.filterFilterHtmlUpdating = {
diff --git a/core/modules/filter/filter.js b/core/modules/filter/filter.js
index 58b595f..cdb0795 100644
--- a/core/modules/filter/filter.js
+++ b/core/modules/filter/filter.js
@@ -11,6 +11,9 @@
* Displays the guidelines of the selected text format automatically.
*
* @type {Drupal~behavior}
+ *
+ * @prop {Drupal~behaviorAttach} attach
+ * Attaches behavior for updating filter guidelines.
*/
Drupal.behaviors.filterGuidelines = {
attach: function (context) {