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

sonam_sharma created an issue. See original summary.

sonam_sharma’s picture

StatusFileSize
new251 bytes
avpaderno’s picture

Title: missing file doc » Add the documentation comment for the module file
Issue summary: View changes
Status: Needs review » Needs work
+/**
+ * @file
+ * Module file.
+ */

The usual description is Hook implementations for the [module name] module. where [module name] is the module name shown in the .info.yml file.

anchal_gupta’s picture

Assigned: Unassigned » anchal_gupta
anchal_gupta’s picture

Assigned: anchal_gupta » Unassigned
Status: Needs work » Needs review
StatusFileSize
new273 bytes
new230 bytes

I have uploaded the patch. Please review

avpaderno’s picture

Category: Bug report » Task
Status: Needs review » Needs work

It is Hook implementations for the Stripe Pay module.

anchal_gupta’s picture

Status: Needs work » Needs review
StatusFileSize
new280 bytes

I have uploaded the patch. Please review

avpaderno’s picture

Status: Needs review » Needs work

See my previous comment.

avpaderno’s picture

Actually, let us rescope this issue. There are many documentation comments that need to be fixed.

avpaderno’s picture

Title: Add the documentation comment for the module file » Add or correct the documentation comments used for files/classes/functions/methods
Issue tags: +Needs reroll

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.

/**
 * 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.

avpaderno’s picture

Issue summary: View changes
avpaderno’s picture

Issue summary: View changes
subhashuyadav’s picture

Status: Needs work » Needs review
StatusFileSize
new19.26 KB

Updated patch with the above mentioned changes.

sujan shrestha’s picture

Version: 1.1.0 » 1.2.0
Status: Needs review » Fixed

Thank 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.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.