Re: [PATCH v5 3/3] platform/chrome: cros_ec_lpc_mec: Fix kernel-doc comment first line

[Nick Crews]

Thanks Enric, looks great.

On Fri, Jun 14, 2019 at 3:43 PM Enric Balletbo i Serra
<enric.balletbo@xxxxxxxxxxxxx> wrote:
>
> kernel-doc comments have a prescribed format. To be _particularly_ correct
> we should also capitalise the brief description and terminate it with a
> period.
>
> Signed-off-by: Enric Balletbo i Serra <enric.balletbo@xxxxxxxxxxxxx>
> ---
>
> Changes in v5:
> - Introduced this patch just to do some kernel-doc clean up.
>
> Changes in v4: None
> Changes in v3: None
> Changes in v2: None
>
>  drivers/platform/chrome/cros_ec_lpc_mec.c | 14 ++++++--------
>  1 file changed, 6 insertions(+), 8 deletions(-)
>
> diff --git a/drivers/platform/chrome/cros_ec_lpc_mec.c b/drivers/platform/chrome/cros_ec_lpc_mec.c
> index d8890bafb55d..9035b17e8c86 100644
> --- a/drivers/platform/chrome/cros_ec_lpc_mec.c
> +++ b/drivers/platform/chrome/cros_ec_lpc_mec.c
> @@ -17,12 +17,10 @@
>  static struct mutex io_mutex;
>  static u16 mec_emi_base, mec_emi_end;
>
> -/*
> - * cros_ec_lpc_mec_emi_write_address
> - *
> - * Initialize EMI read / write at a given address.
> +/**
> + * cros_ec_lpc_mec_emi_write_address() - Initialize EMI at a given address.
>   *
> - * @addr:        Starting read / write address
> + * @addr: Starting read / write address
>   * @access_type: Type of access, typically 32-bit auto-increment
>   */
>  static void cros_ec_lpc_mec_emi_write_address(u16 addr,
> @@ -61,15 +59,15 @@ int cros_ec_lpc_mec_in_range(unsigned int offset, unsigned int length)
>         return 0;
>  }
>
> -/*
> - * cros_ec_lpc_io_bytes_mec - Read / write bytes to MEC EMI port
> +/**
> + * cros_ec_lpc_io_bytes_mec() - Read / write bytes to MEC EMI port.
>   *
>   * @io_type: MEC_IO_READ or MEC_IO_WRITE, depending on request
>   * @offset:  Base read / write address
>   * @length:  Number of bytes to read / write
>   * @buf:     Destination / source buffer
>   *
> - * @return 8-bit checksum of all bytes read / written
> + * Return: 8-bit checksum of all bytes read / written
>   */
>  u8 cros_ec_lpc_io_bytes_mec(enum cros_ec_lpc_mec_io_type io_type,
>                             unsigned int offset, unsigned int length,

Reviewed-by: Nick Crews <ncrews@xxxxxxxxxxxx>

> --
> 2.20.1
>