The documentation comment for the .module file is missing. Furthermore, there are other documentation comments that are incomplete or need to be fixed. For example:
/**
* Get currency codes available on the stripe
*/
function stripe_currency_codes()
It does not describe the return value. The verb used in the description needs to be declined on the third person singular. The period at the end of the description is missing.
/**
* Price format
*/
function stripe_price_formats($currency_code, $currency_sign)
It does not describe the parameters nor the return value.
/**
* Log messages on the system
* @param $log_type type of the error message
* @param $message message body
* @return
*/
function log_stripe_pay_messages($log_type, $message)
The documentation comment is not correctly formatted. The verb used in the description needs to be declined on the third person singular.
/**
* Plugin implementation of the 'stripe_payment' field type.
*
* @FieldType(
* id = "stripe_payment",
* label = @Translation("Stripe Payment"),
* category = @Translation("Stripe Payment"),
* default_widget = "stripe_payment_default_widget",
* default_formatter = "stripe_payment_default_formatter"
* )
*/
class StripePaymentFieldItem extends FieldItemBase implements FieldItemInterface {
The documentation comment is not correctly formatted.
Comments
Comment #2
sonam_sharma commentedComment #3
avpadernoThe usual description is Hook implementations for the [module name] module. where [module name] is the module name shown in the .info.yml file.
Comment #4
anchal_gupta commentedComment #5
anchal_gupta commentedI have uploaded the patch. Please review
Comment #6
avpadernoIt is Hook implementations for the Stripe Pay module.
Comment #7
anchal_gupta commentedI have uploaded the patch. Please review
Comment #8
avpadernoSee my previous comment.
Comment #9
avpadernoActually, let us rescope this issue. There are many documentation comments that need to be fixed.
Comment #10
avpadernoThe documentation comment for the .module file is missing. Furthermore, there are other documentation comments that are incomplete or need to be fixed. For example:
It does not describe the return value. The verb used in the description needs to be declined on the third person singular.
It does not describe the parameters nor the return value.
The documentation comment is not correctly formatted. The verb used in the description needs to be declined on the third person singular.
The documentation comment is not correctly formatted.
Comment #11
avpadernoComment #12
avpadernoComment #13
subhashuyadav commentedUpdated patch with the above mentioned changes.
Comment #14
sujan shrestha commentedThank you for the feedback, and I apologize for the delayed response. I’ve reviewed the feedback and the patch, and I’ve made the necessary changes to the documentation comments for the files, classes, functions, and methods. The issues have now been fixed.