[PATCH V2] drm/edid: kernel-doc minimal cleanup

[Paul Menzel]

Am Freitag, den 01.03.2013, 08:00 -0600 schrieb Nishanth Menon:
> Some basic cleanups for kernel-doc errors or missing documentation
> parameters.

Nishanth, thanks for doing that!

> Warnings generated by ./scripts/kernel-doc drivers/gpu/drm/drm_edid.c >Kerr
> 
> Warning(drivers/gpu/drm/drm_edid.c:997): No description found for parameter 'adapter'
> Warning(drivers/gpu/drm/drm_edid.c:997): No description found for parameter 'buf'
> Warning(drivers/gpu/drm/drm_edid.c:997): No description found for parameter 'block'
> Warning(drivers/gpu/drm/drm_edid.c:997): No description found for parameter 'len'
> Warning(drivers/gpu/drm/drm_edid.c:1138): No description found for parameter 'adapter'
> Warning(drivers/gpu/drm/drm_edid.c:1467): No description found for parameter 'connector'
> Warning(drivers/gpu/drm/drm_edid.c:1467): No description found for parameter 'edid'
> Warning(drivers/gpu/drm/drm_edid.c:1467): No description found for parameter 'revision'
> Warning(drivers/gpu/drm/drm_edid.c:1467): Excess function parameter 'timing_level' description in 'drm_mode_std'
> Warning(drivers/gpu/drm/drm_edid.c:2010): No description found for parameter 'connector'
> Warning(drivers/gpu/drm/drm_edid.c:2072): No description found for parameter 'connector'
> Warning(drivers/gpu/drm/drm_edid.c:2237): No description found for parameter 'edid'
> Warning(drivers/gpu/drm/drm_edid.c:2616): No description found for parameter 'edid'
> Warning(drivers/gpu/drm/drm_edid.c:2658): No description found for parameter 'edid'
> 
> Cc: David Airlie <airlied at linux.ie>
> Cc: Dave Airlie <airlied at redhat.com>
> Cc: Adam Jackson <ajax at redhat.com>
> Cc: Rodrigo Vivi <rodrigo.vivi at intel.com>
> Cc: Ville Syrjälä <ville.syrjala at linux.intel.com>
> Cc: dri-devel at lists.freedesktop.org
> 
> Signed-off-by: Nishanth Menon <nm at ti.com>
> ---
> 
> V2: review comments incorporated
> 
> V1: http://marc.info/?t=136214115900005&r=1&w=2
> 
> It does seem the drm_edid.c could do with more documentation cleanup,
> but I have stayed with the bare minimum.
> the above error is based off:
> master de1a226 Merge tag 'writeback-fixes' of git://git.kernel.org/pub/scm/linux/kernel/git/wfg/linux
> from: git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6.git
> 
> defconfig used: omap2plus_defconfig
> 
> Disclaimer: I am no drm expert, and I tried to use my best judgement about what
> the meaning of the parameters might be, hope it helps.
> 
>  drivers/gpu/drm/drm_edid.c |   31 +++++++++++++++++++------------
>  1 file changed, 19 insertions(+), 12 deletions(-)
> 
> diff --git a/drivers/gpu/drm/drm_edid.c b/drivers/gpu/drm/drm_edid.c
> index c194f4e..bd864b5 100644
> --- a/drivers/gpu/drm/drm_edid.c
> +++ b/drivers/gpu/drm/drm_edid.c
> @@ -982,14 +982,14 @@ EXPORT_SYMBOL(drm_edid_is_valid);
>  
>  #define DDC_SEGMENT_ADDR 0x30
>  /**
> - * Get EDID information via I2C.
> - *
> - * \param adapter : i2c device adaptor
> - * \param buf     : EDID data buffer to be filled
> - * \param len     : EDID data buffer length
> - * \return 0 on success or -1 on failure.
> + * drm_do_probe_ddc_edid() - Get EDID information via I2C.

Some already existing entries do not use »()« behind the function name
in the comment. Not sure what the correct way is though.

[…]


Thanks,

Paul
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 198 bytes
Desc: This is a digitally signed message part
URL: <http://lists.freedesktop.org/archives/dri-devel/attachments/20130302/f141492a/attachment-0001.pgp>