Add or correct the documentation comments used for files/classes/functions/methods

Created on 24 June 2023, over 1 year ago
Updated 3 November 2023, about 1 year ago

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.

📌 Task
Status

Needs review

Version

1.1

Component

Code

Created by

Live updates comments and jobs are added and updated live.
  • Needs reroll

    The patch will have to be re-rolled with new suggestions/changes described in the comments in the issue.

Sign in to follow issues

Comments & Activities

  • Issue created by @sonam_sharma
  • Status changed to Needs work over 1 year ago
  • 🇮🇹Italy apaderno Brescia, 🇮🇹
    +/**
    + * @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.

  • Assigned to anchal_gupta
  • Issue was unassigned.
  • Status changed to Needs review over 1 year ago
  • 🇮🇳India anchal_gupta

    I have uploaded the patch. Please review

  • Status changed to Needs work over 1 year ago
  • 🇮🇹Italy apaderno Brescia, 🇮🇹

    It is Hook implementations for the Stripe Pay module.

  • Status changed to Needs review over 1 year ago
  • 🇮🇳India anchal_gupta

    I have uploaded the patch. Please review

  • Status changed to Needs work over 1 year ago
  • 🇮🇹Italy apaderno Brescia, 🇮🇹

    See my previous comment.

  • 🇮🇹Italy apaderno Brescia, 🇮🇹

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

  • 🇮🇹Italy apaderno Brescia, 🇮🇹

    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.

  • 🇮🇹Italy apaderno Brescia, 🇮🇹
  • 🇮🇹Italy apaderno Brescia, 🇮🇹
  • Status changed to Needs review about 1 year ago
  • 🇮🇳India subhashuyadav Mumbai

    Updated patch with the above mentioned changes.

Production build 0.71.5 2024