Issue #3368603: Fix the PHP_CodeSniffer issues reported by GitLab CI

Closes #3368603

includes/display_fields.field_ui.inc

@@ -11,7 +11,7 @@
 use Drupal\display_fields\DisplayFields;
 
 /**
- * Adds the Display fields to the form field_ui_display.
+ * Adds the display fields to the field_ui_display form.
  */
 function _display_fields_form_field_ui_display(&$form, FormStateInterface $form_state) {
   _display_fields_form_field_ui_create_vertical_tabs($form);
@@ -20,8 +20,7 @@ function _display_fields_form_field_ui_display(&$form, FormStateInterface $form_
 }
 
 /**
- * Add The fields row form, retrieving the $form from the DisplayFields Field
- * plugin.
+ * Adds The field row form, retrieving the $form from the DisplayFields plugin.
  */
 function _display_fields_form_field_ui_display_fields_add_fields_row(&$form, FormStateInterface $form_state) {
   $entity_type = $form['#entity_type'];
@@ -34,7 +33,6 @@ function _display_fields_form_field_ui_display_fields_add_fields_row(&$form, For
     return;
   }
 
-  // And an header for the delete button cell
   $form['fields']['#header'][] = ' ';
 
   $display_fields_settings = display_fields_get_entity_view_settings($entity_type, $bundle, $view_mode);
@@ -50,12 +48,10 @@ function _display_fields_form_field_ui_display_fields_add_fields_row(&$form, For
 }
 
 /**
- * Submit handler for the DisplayFields rows.
- *
- * @param array $form
- * @param \Drupal\Core\Form\FormStateInterface $form_state
+ * Submission handler for the DisplayFields rows.
  *
  * @throws \Drupal\Core\Entity\EntityStorageException
+ *   An error occurred when saving the display settings.
  */
 function _display_fields_form_field_ui_display_fields_fields_row_submit(array &$form, FormStateInterface $form_state) {
   $form_values = $form_state->getValues();
@@ -72,9 +68,7 @@ function _display_fields_form_field_ui_display_fields_fields_row_submit(array &$
       $display_fields_settings->removeComponent($field_name);
     }
     else {
-      // Get plugin settings. They lie either directly in submitted form
-      // values (if the whole form was submitted while some plugin settings
-      // were being edited), or have been persisted in $form_state.
+      // Get the plugin settings.
       $plugin_settings = $form_state->get('plugin_settings');
       $settings = $values['settings_edit_form']['settings'] ?? ($plugin_settings["display_fields_$field_name"]['settings'] ?? []);
 
@@ -287,8 +281,7 @@ function _display_fields_field_machine_name_exists($value, $element, $form_state
 }
 
 /**
- * Ajax callback for the display fields vertical tab UI (creation of
- * DisplayFields).
+ * Ajax callback for the display fields vertical tab UI.
  */
 function _display_fields_form_field_ui_create_display_fields_callback($form, FormStateInterface $form_state) {
   return $form['display_fields']['create'];
@@ -296,6 +289,9 @@ function _display_fields_form_field_ui_create_display_fields_callback($form, For
 
 /**
  * Create or merge vertical tabs.
+ *
+ * @param array &$form
+ *   The form to which vertical tabs are added.
  */
 function _display_fields_form_field_ui_create_vertical_tabs(&$form) {
   // Add additional settings vertical tab.