lkml.org 
[lkml]   [2020]   [Jul]   [1]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH 2/5] soundwire: stream: add helper to startup/shutdown streams
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

\
 
 \ /
  Last update: 2020-07-01 07:40    [W:0.056 / U:1.004 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site