From 6513bac659dbcce233d91a0b864eedd064e5ff0a Mon Sep 17 00:00:00 2001 From: Alex Pott Date: Thu, 29 Oct 2015 14:14:02 +0000 Subject: [PATCH] Issue #2601610 by krknth: Fix comment standards for filter module --- core/modules/filter/src/Controller/FilterController.php | 5 +++-- core/modules/filter/src/Element/ProcessedText.php | 4 ++++ core/modules/filter/src/Tests/FilterUnitTest.php | 6 ++++-- 3 files changed, 11 insertions(+), 4 deletions(-) diff --git a/core/modules/filter/src/Controller/FilterController.php b/core/modules/filter/src/Controller/FilterController.php index a921cb0c83c..680867efba7 100644 --- a/core/modules/filter/src/Controller/FilterController.php +++ b/core/modules/filter/src/Controller/FilterController.php @@ -17,8 +17,9 @@ class FilterController { /** * Displays a page with long filter tips. * - * @param \Drupal\filter\FilterFormatInterface|null $format - * A filter format, or NULL to show tips for all formats. Defaults to NULL. + * @param \Drupal\filter\FilterFormatInterface|null $filter_format + * (optional) A filter format, or NULL to show tips for all formats. + * Defaults to NULL. * * @return array * A renderable array. diff --git a/core/modules/filter/src/Element/ProcessedText.php b/core/modules/filter/src/Element/ProcessedText.php index fc7e52b932a..344d6de90c5 100644 --- a/core/modules/filter/src/Element/ProcessedText.php +++ b/core/modules/filter/src/Element/ProcessedText.php @@ -138,7 +138,11 @@ class ProcessedText extends RenderElement { /** * Wraps a logger channel. * + * @param string $channel + * The name of the channel. + * * @return \Psr\Log\LoggerInterface + * The logger for this channel. */ protected static function logger($channel) { return \Drupal::logger($channel); diff --git a/core/modules/filter/src/Tests/FilterUnitTest.php b/core/modules/filter/src/Tests/FilterUnitTest.php index a407ebf343f..54a738dd027 100644 --- a/core/modules/filter/src/Tests/FilterUnitTest.php +++ b/core/modules/filter/src/Tests/FilterUnitTest.php @@ -1135,7 +1135,8 @@ body {color:red} * (optional) Message to display if failed. Defaults to an empty string. * @param $group * (optional) The group this message belongs to. Defaults to 'Other'. - * @return + * + * @return bool * TRUE on pass, FALSE on fail. */ function assertNormalized($haystack, $needle, $message = '', $group = 'Other') { @@ -1159,7 +1160,8 @@ body {color:red} * (optional) Message to display if failed. Defaults to an empty string. * @param $group * (optional) The group this message belongs to. Defaults to 'Other'. - * @return + * + * @return bool * TRUE on pass, FALSE on fail. */ function assertNoNormalized($haystack, $needle, $message = '', $group = 'Other') {