From b6a3c63309bfe01615919bb50cb66c6da7382e38 Mon Sep 17 00:00:00 2001
From: Alex Pott <alex.a.pott@googlemail.com>
Date: Thu, 19 May 2022 09:34:14 +0100
Subject: [PATCH] Issue #3268746 by quietone, xjm: Fix missing newlines for
'Drupal.Commenting.DocComment.ShortSingleLine'
---
composer/Composer.php | 1 +
core/includes/form.inc | 1 +
core/lib/Drupal/Core/Link.php | 2 ++
core/lib/Drupal/Core/TypedData/Annotation/DataType.php | 3 +++
.../tests/src/Functional/Datetime/DrupalDateTimeTest.php | 1 +
core/modules/views/src/ManyToOneHelper.php | 1 +
core/modules/views/src/Plugin/views/HandlerBase.php | 4 ++++
core/modules/views/src/Plugin/views/display/Attachment.php | 1 +
core/modules/views/src/Plugin/views/display/Block.php | 1 +
core/modules/views/src/Plugin/views/field/FieldPluginBase.php | 2 ++
core/modules/views/src/Plugin/views/field/PrerenderList.php | 1 +
.../views/src/Plugin/views/filter/FilterPluginBase.php | 3 +++
core/modules/views/src/Plugin/views/query/Sql.php | 1 +
core/modules/views/src/Plugin/views/row/Fields.php | 1 +
core/modules/views/src/Plugin/views/row/RowPluginBase.php | 1 +
core/tests/Drupal/KernelTests/Core/Database/FetchTest.php | 1 +
.../Drupal/Tests/Component/Datetime/DateTimePlusTest.php | 1 +
17 files changed, 26 insertions(+)
diff --git a/composer/Composer.php b/composer/Composer.php
index 7f83591934cd..d3a87090bfde 100644
--- a/composer/Composer.php
+++ b/composer/Composer.php
@@ -85,6 +85,7 @@ protected static function setTemplateProjectStability(string $root, string $vers
/**
* Ensure that the minimum required version of Composer is running.
+ *
* Throw an exception if Composer is too old.
*/
public static function ensureComposerVersion(): void {
diff --git a/core/includes/form.inc b/core/includes/form.inc
index 9cd5f91daa0b..5959b598e8ed 100644
--- a/core/includes/form.inc
+++ b/core/includes/form.inc
@@ -397,6 +397,7 @@ function template_preprocess_textarea(&$variables) {
/**
* Returns HTML for a form element.
+ *
* Prepares variables for form element templates.
*
* Default template: form-element.html.twig.
diff --git a/core/lib/Drupal/Core/Link.php b/core/lib/Drupal/Core/Link.php
index 91718a687c93..d382ef6cd828 100644
--- a/core/lib/Drupal/Core/Link.php
+++ b/core/lib/Drupal/Core/Link.php
@@ -19,10 +19,12 @@ class Link implements RenderableInterface {
/**
* The link text for the anchor tag as a translated string or render array.
+ *
* Strings will be sanitized automatically. If you need to output HTML in
* the link text, use a render array or an already sanitized string such as
* the output of \Drupal\Component\Utility\Xss::filter() or
* \Drupal\Component\Render\FormattableMarkup.
+ *
* @var string|array|\Drupal\Component\Render\MarkupInterface
*/
protected $text;
diff --git a/core/lib/Drupal/Core/TypedData/Annotation/DataType.php b/core/lib/Drupal/Core/TypedData/Annotation/DataType.php
index 83444a9d087e..a524a446f446 100644
--- a/core/lib/Drupal/Core/TypedData/Annotation/DataType.php
+++ b/core/lib/Drupal/Core/TypedData/Annotation/DataType.php
@@ -60,6 +60,7 @@ class DataType extends Plugin {
/**
* The definition class to use for defining data of this type.
+ *
* Must implement the \Drupal\Core\TypedData\DataDefinitionInterface.
*
* @var string
@@ -68,6 +69,7 @@ class DataType extends Plugin {
/**
* The typed data class used for wrapping multiple data items of the type.
+ *
* Must implement the \Drupal\Core\TypedData\ListInterface.
*
* @var string
@@ -76,6 +78,7 @@ class DataType extends Plugin {
/**
* The definition class to use for defining a list of items of this type.
+ *
* Must implement the \Drupal\Core\TypedData\ListDataDefinitionInterface.
*
* @var string
diff --git a/core/modules/system/tests/src/Functional/Datetime/DrupalDateTimeTest.php b/core/modules/system/tests/src/Functional/Datetime/DrupalDateTimeTest.php
index 86baa0265284..d2120571a239 100644
--- a/core/modules/system/tests/src/Functional/Datetime/DrupalDateTimeTest.php
+++ b/core/modules/system/tests/src/Functional/Datetime/DrupalDateTimeTest.php
@@ -47,6 +47,7 @@ public function testSystemTimezone() {
/**
* Tests that DrupalDateTime can detect the right timezone to use.
+ *
* Test with a variety of less commonly used timezone names to
* help ensure that the system timezone will be different than the
* stated timezones.
diff --git a/core/modules/views/src/ManyToOneHelper.php b/core/modules/views/src/ManyToOneHelper.php
index ad659a3626a6..6d47212a895d 100644
--- a/core/modules/views/src/ManyToOneHelper.php
+++ b/core/modules/views/src/ManyToOneHelper.php
@@ -151,6 +151,7 @@ public function summaryJoin() {
/**
* Override ensureMyTable so we can control how this joins in.
+ *
* The operator actually has influence over joining.
*/
public function ensureMyTable() {
diff --git a/core/modules/views/src/Plugin/views/HandlerBase.php b/core/modules/views/src/Plugin/views/HandlerBase.php
index 311c98550fca..582e77f57dea 100644
--- a/core/modules/views/src/Plugin/views/HandlerBase.php
+++ b/core/modules/views/src/Plugin/views/HandlerBase.php
@@ -350,6 +350,7 @@ public function buildGroupByForm(&$form, FormStateInterface $form_state) {
/**
* Perform any necessary changes to the form values prior to storage.
+ *
* There is no need for this function to actually store the data.
*/
public function submitGroupByForm(&$form, FormStateInterface $form_state) {
@@ -381,6 +382,7 @@ public function validateExtraOptionsForm($form, FormStateInterface $form_state)
/**
* Perform any necessary changes to the form values prior to storage.
+ *
* There is no need for this function to actually store the data.
*/
public function submitExtraOptionsForm($form, FormStateInterface $form_state) {}
@@ -430,6 +432,7 @@ public function validateExposeForm($form, FormStateInterface $form_state) {}
/**
* Perform any necessary changes to the form exposes prior to storage.
+ *
* There is no need for this function to actually store the data.
*/
public function submitExposeForm($form, FormStateInterface $form_state) {}
@@ -566,6 +569,7 @@ public function isAGroup() {
/**
* Define if the exposed input has to be submitted multiple times.
+ *
* This is TRUE when exposed filters grouped are using checkboxes as
* widgets.
*/
diff --git a/core/modules/views/src/Plugin/views/display/Attachment.php b/core/modules/views/src/Plugin/views/display/Attachment.php
index 7dbbb2f88600..288696d217bf 100644
--- a/core/modules/views/src/Plugin/views/display/Attachment.php
+++ b/core/modules/views/src/Plugin/views/display/Attachment.php
@@ -212,6 +212,7 @@ public function buildOptionsForm(&$form, FormStateInterface $form_state) {
/**
* Perform any necessary changes to the form values prior to storage.
+ *
* There is no need for this function to actually store the data.
*/
public function submitOptionsForm(&$form, FormStateInterface $form_state) {
diff --git a/core/modules/views/src/Plugin/views/display/Block.php b/core/modules/views/src/Plugin/views/display/Block.php
index 306ee20560e4..00bdf1a10b84 100644
--- a/core/modules/views/src/Plugin/views/display/Block.php
+++ b/core/modules/views/src/Plugin/views/display/Block.php
@@ -251,6 +251,7 @@ public function buildOptionsForm(&$form, FormStateInterface $form_state) {
/**
* Perform any necessary changes to the form values prior to storage.
+ *
* There is no need for this function to actually store the data.
*/
public function submitOptionsForm(&$form, FormStateInterface $form_state) {
diff --git a/core/modules/views/src/Plugin/views/field/FieldPluginBase.php b/core/modules/views/src/Plugin/views/field/FieldPluginBase.php
index 0fe56cbc65e8..98351f05ce33 100644
--- a/core/modules/views/src/Plugin/views/field/FieldPluginBase.php
+++ b/core/modules/views/src/Plugin/views/field/FieldPluginBase.php
@@ -53,12 +53,14 @@ abstract class FieldPluginBase extends HandlerBase implements FieldHandlerInterf
/**
* Indicator of the renderText() method for rendering a single item.
+ *
* (If no render_item() is present).
*/
const RENDER_TEXT_PHASE_SINGLE_ITEM = 0;
/**
* Indicator of the renderText() method for rendering the whole element.
+ *
* (if no render_item() method is available).
*/
const RENDER_TEXT_PHASE_COMPLETELY = 1;
diff --git a/core/modules/views/src/Plugin/views/field/PrerenderList.php b/core/modules/views/src/Plugin/views/field/PrerenderList.php
index 4ed091f810d5..06f9a21356e0 100644
--- a/core/modules/views/src/Plugin/views/field/PrerenderList.php
+++ b/core/modules/views/src/Plugin/views/field/PrerenderList.php
@@ -19,6 +19,7 @@ abstract class PrerenderList extends FieldPluginBase implements MultiItemsFieldH
/**
* Stores all items which are used to render the items.
+ *
* It should be keyed first by the id of the base table, for example nid.
* The second key is the id of the thing which is displayed multiple times
* per row, for example the tid.
diff --git a/core/modules/views/src/Plugin/views/filter/FilterPluginBase.php b/core/modules/views/src/Plugin/views/filter/FilterPluginBase.php
index 3e5370beebde..b048d8e281f3 100644
--- a/core/modules/views/src/Plugin/views/filter/FilterPluginBase.php
+++ b/core/modules/views/src/Plugin/views/filter/FilterPluginBase.php
@@ -185,6 +185,7 @@ public function canExpose() {
/**
* Determine if a filter can be converted into a group.
+ *
* Only exposed filters with operators available can be converted into groups.
*/
protected function canBuildGroup() {
@@ -200,6 +201,7 @@ public function isAGroup() {
/**
* Provide the basic form which calls through to subforms.
+ *
* If overridden, it is best to call through to the parent,
* or to at least make sure all of the functions in this form
* are called.
@@ -1435,6 +1437,7 @@ public function multipleExposedInput() {
/**
* If set to remember exposed input in the session, store it there.
+ *
* This function is similar to storeExposedInput but modified to
* work properly when the filter is a group.
*/
diff --git a/core/modules/views/src/Plugin/views/query/Sql.php b/core/modules/views/src/Plugin/views/query/Sql.php
index 3c584ba9761d..40de924609ac 100644
--- a/core/modules/views/src/Plugin/views/query/Sql.php
+++ b/core/modules/views/src/Plugin/views/query/Sql.php
@@ -973,6 +973,7 @@ public function addWhereExpression($group, $snippet, $args = []) {
/**
* Add a complex HAVING clause to the query.
+ *
* The caller is responsible for ensuring that all fields are fully qualified
* (TABLE.FIELD) and that the table and an appropriate GROUP BY already exist in the query.
* Internally the dbtng method "having" is used.
diff --git a/core/modules/views/src/Plugin/views/row/Fields.php b/core/modules/views/src/Plugin/views/row/Fields.php
index 20b4229506e0..647ddce89fc6 100644
--- a/core/modules/views/src/Plugin/views/row/Fields.php
+++ b/core/modules/views/src/Plugin/views/row/Fields.php
@@ -94,6 +94,7 @@ public function buildOptionsForm(&$form, FormStateInterface $form_state) {
/**
* Perform any necessary changes to the form values prior to storage.
+ *
* There is no need for this function to actually store the data.
*/
public function submitOptionsForm(&$form, FormStateInterface $form_state) {
diff --git a/core/modules/views/src/Plugin/views/row/RowPluginBase.php b/core/modules/views/src/Plugin/views/row/RowPluginBase.php
index e3d2c5893389..0a3e091aca17 100644
--- a/core/modules/views/src/Plugin/views/row/RowPluginBase.php
+++ b/core/modules/views/src/Plugin/views/row/RowPluginBase.php
@@ -126,6 +126,7 @@ public function validateOptionsForm(&$form, FormStateInterface $form_state) {}
/**
* Perform any necessary changes to the form values prior to storage.
+ *
* There is no need for this function to actually store the data.
*/
public function submitOptionsForm(&$form, FormStateInterface $form_state) {}
diff --git a/core/tests/Drupal/KernelTests/Core/Database/FetchTest.php b/core/tests/Drupal/KernelTests/Core/Database/FetchTest.php
index c692fa56f54a..f98a08908465 100644
--- a/core/tests/Drupal/KernelTests/Core/Database/FetchTest.php
+++ b/core/tests/Drupal/KernelTests/Core/Database/FetchTest.php
@@ -99,6 +99,7 @@ public function testQueryFetchObjectClass() {
/**
* Confirms that we can fetch a record into a new instance of a custom class.
+ *
* The name of the class is determined from a value of the first column.
*
* @see \Drupal\Tests\system\Functional\Database\FakeRecord
diff --git a/core/tests/Drupal/Tests/Component/Datetime/DateTimePlusTest.php b/core/tests/Drupal/Tests/Component/Datetime/DateTimePlusTest.php
index 95120187bf7d..0366c06b7bc0 100644
--- a/core/tests/Drupal/Tests/Component/Datetime/DateTimePlusTest.php
+++ b/core/tests/Drupal/Tests/Component/Datetime/DateTimePlusTest.php
@@ -270,6 +270,7 @@ public function testInvalidDates($input, $timezone, $format, $message, $class) {
/**
* Tests that DrupalDateTime can detect the right timezone to use.
+ *
* When specified or not.
*
* @param mixed $input
--
GitLab