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

Nishanth Menon nm at ti.com
Wed Mar 6 06:16:31 PST 2013


On 10:27-20130304, Nishanth Menon wrote:
> On 18:09-20130302, Paul Menzel wrote:
> > Am Freitag, den 01.03.2013, 08:00 -0600 schrieb Nishanth Menon:
> > > Some basic cleanups for kernel-doc errors or missing documentation
> > > parameters.
[..]
> > > 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.
> I followed the format as in:
> http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/kernel-doc-nano-HOWTO.txt#n55
just a ping to confirm if there are any further changes required?
-- 
Regards,
Nishanth Menon


More information about the dri-devel mailing list