Re: [PATCH v9 04/22] drm/edid: Convert cea_sad helper struct to kernelDoc

[AngeloGioacchino Del Regno <angelogioacchino.delregno@xxxxxxxxxxxxx>]

Il 28/03/22 00:39, Guillaume Ranquet ha scritto:
> Signed-off-by: Guillaume Ranquet <granquet@xxxxxxxxxxxx>
> ---
>   include/drm/drm_edid.h | 11 ++++++++---
>   1 file changed, 8 insertions(+), 3 deletions(-)
>
> diff --git a/include/drm/drm_edid.h b/include/drm/drm_edid.h
> index 144c495b99c4..5d4d840b9904 100644
> --- a/include/drm/drm_edid.h
> +++ b/include/drm/drm_edid.h
> @@ -359,12 +359,17 @@ struct edid {
>   
>   #define EDID_PRODUCT_ID(e) ((e)->prod_code[0] | ((e)->prod_code[1] << 8))
>   
> -/* Short Audio Descriptor */

Hello Guillaume,

> +/* struct cea_sad - Short Audio Descriptor.
> +	@format: See HDMI_AUDIO_CODING_TYPE_*.
> +	@channels: max number of channels - 1.
> +	@freq: See CEA_SAD_FREQ_*.
> +	@byte2: meaning depends on format.
> +*/

I appreciate the effort, but this is not valid kerneldoc.

Please refer to https://docs.kernel.org/doc-guide/kernel-doc.html

Regards,
Angelo