Re: [PATCH 2/5] soundwire: stream: add helper to startup/shutdown streams

From: Vinod Koul
Date: Wed Jul 01 2020 - 01:39:22 EST


On 30-06-20, 11:58, Pierre-Louis Bossart wrote:
> > > +int sdw_startup_stream(void *sdw_substream)
> >
> > Can we have kernel doc style Documentation for exported APIs?
>
> yes, that's a miss indeed.
>
> Though if we follow the existing examples it's not going to be very
> informative, e.g.

Yeah but...
>
> /**
> * sdw_disable_stream() - Disable SoundWire stream
> *
> * @stream: Soundwire stream
> *
> * Documentation/driver-api/soundwire/stream.rst explains this API in detail

it would help to have this pointer. I plan to include the kernel-doc
comments in Documentation for sdw so it would great to have these in
place

--
~Vinod