Re: [patch 1/1] TOUCHSCREEN: S3C24XX touchscreen driver from Arnaud Patard.

[Pavel Machek <pavel@ucw.cz>]

Hi!

> >>> +/* Per-touchscreen data. */
> >>> +
> >>> +/**
> >>> + * struct s3c2410ts - driver touchscreen state.
> >>> + * @client: The ADC client we registered with the core driver.
> >>> + * @dev: The device we are bound to.
> >>> + * @input: The input device we registered with the input subsystem.
> >>> + * @clock: The clock for the adc.
> >>> + * @io: Pointer to the IO base.
> >>> + * @xp: The accumulated X position data.
> >>> + * @yp: The accumulated Y position data.
> >>> + * @irq_tc: The interrupt number for pen up/down interrupt
> >>> + * @count: The number of samples collected.
> >>> + * @shift: The log2 of the maximum count to read in one go.
> >>> + */
> >>
> >> These sructures are driver-internal and so don't need to be kernel-doc-ed.
> >> Same goes for the driver-private functions.
> >
> > I like having the documentation, and I would much prefer to leave it
> > in as useful.
> 
> Ah, I wasn't requiesting to remove the documentation, I was just saying
> that since these data structures and fucntions are driver-provate they
> don't need to use kernel-doc style.

Well.. consistent style of documentation is nice, be it driver-private
or public stuff.

-- 
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html