Update the doc block comment at AdvancedEmailWebformValidatorHandler for "validateEmail" method

Created on 18 January 2023, about 2 years ago

Problem/Motivation

Inside of class

AdvancedEmailWebformValidatorHandler

there is a method called "validateEmail" and the doc block can be improved following the recommendations. For example "Missing parameter comment" and about If there is no return value for a function, there must not be a @return tag.

Steps to reproduce

Run code sniffers to get the results of:

FILE: advanced_email_validation/src/Plugin/WebformHandler/AdvancedEmailWebformValidatorHandler.php
-------------------------------------------------------------------------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 2 LINES
-------------------------------------------------------------------------------------------------------------------------------------
 233 | ERROR | Missing parameter comment
 235 | ERROR | If there is no return value for a function, there must not be a @return tag.
 235 | ERROR | Description for the @return value is missing
-------------------------------------------------------------------------------------------------------------------------------------

Time: 292ms; Memory: 10MB

Proposed resolution

Update this adding the description in the doc block and adjust the return tag

Remaining tasks

User interface changes

API changes

Data model changes

🐛 Bug report
Status

Fixed

Version

1.0

Component

Code

Created by

🇧🇷Brazil renatog Campinas

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Production build 0.71.5 2024