[1/3] slimbus: fix kerneldoc comments

Message ID 20190620081129.4721-2-srinivas.kandagatla@linaro.org
State New
Headers show
Series
  • drivers: slimbus: patches for 5.3
Related show

Commit Message

Srinivas Kandagatla June 20, 2019, 8:11 a.m.
From: Jonathan Corbet <corbet@lwn.net>


The kerneldoc comments in drivers/slimbus/stream.c were not properly
formatted, leading to a distinctly unsatisfying "no structured comments
found" warning in the docs build.  Sprinkle some asterisks around so that
the comments will be properly recognized.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>

Signed-off-by: Srinivas Kandagatla <srinivas.kandagatla@linaro.org>

---
 drivers/slimbus/stream.c | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

-- 
2.21.0

Comments

Greg KH June 20, 2019, 8:46 a.m. | #1
On Thu, Jun 20, 2019 at 09:11:27AM +0100, Srinivas Kandagatla wrote:
> From: Jonathan Corbet <corbet@lwn.net>

> 

> The kerneldoc comments in drivers/slimbus/stream.c were not properly

> formatted, leading to a distinctly unsatisfying "no structured comments

> found" warning in the docs build.  Sprinkle some asterisks around so that

> the comments will be properly recognized.

> 

> Signed-off-by: Jonathan Corbet <corbet@lwn.net>

> Signed-off-by: Srinivas Kandagatla <srinivas.kandagatla@linaro.org>

> ---

>  drivers/slimbus/stream.c | 12 ++++++------

>  1 file changed, 6 insertions(+), 6 deletions(-)


Turns out this was already in my tree :)

Also, when sending out patches, be sure to cc: the authors, no need to
suppress that in git send-email.

thanks,

greg k-h
Srinivas Kandagatla June 20, 2019, 8:47 a.m. | #2
On 20/06/2019 09:46, Greg KH wrote:
> On Thu, Jun 20, 2019 at 09:11:27AM +0100, Srinivas Kandagatla wrote:

>> From: Jonathan Corbet <corbet@lwn.net>

>>

>> The kerneldoc comments in drivers/slimbus/stream.c were not properly

>> formatted, leading to a distinctly unsatisfying "no structured comments

>> found" warning in the docs build.  Sprinkle some asterisks around so that

>> the comments will be properly recognized.

>>

>> Signed-off-by: Jonathan Corbet <corbet@lwn.net>

>> Signed-off-by: Srinivas Kandagatla <srinivas.kandagatla@linaro.org>

>> ---

>>   drivers/slimbus/stream.c | 12 ++++++------

>>   1 file changed, 6 insertions(+), 6 deletions(-)

> 

> Turns out this was already in my tree :)

>

Ah, I should have rebased it on top of char-misc!


> Also, when sending out patches, be sure to cc: the authors, no need to

> suppress that in git send-email.

> 

Sure, I will keep that in mind!

thanks,
srini
> thanks,

> 

> greg k-h

>

Patch

diff --git a/drivers/slimbus/stream.c b/drivers/slimbus/stream.c
index 2fa05324ed07..75f87b3d8b95 100644
--- a/drivers/slimbus/stream.c
+++ b/drivers/slimbus/stream.c
@@ -84,7 +84,7 @@  static const int slim_presence_rate_table[] = {
 	512000,
 };
 
-/*
+/**
  * slim_stream_allocate() - Allocate a new SLIMbus Stream
  * @dev:Slim device to be associated with
  * @name: name of the stream
@@ -189,7 +189,7 @@  static int slim_get_prate_code(int rate)
 	return -EINVAL;
 }
 
-/*
+/**
  * slim_stream_prepare() - Prepare a SLIMbus Stream
  *
  * @rt: instance of slim stream runtime to configure
@@ -336,7 +336,7 @@  static int slim_activate_channel(struct slim_stream_runtime *stream,
 	return slim_do_transfer(sdev->ctrl, &txn);
 }
 
-/*
+/**
  * slim_stream_enable() - Enable a prepared SLIMbus Stream
  *
  * @stream: instance of slim stream runtime to enable
@@ -389,7 +389,7 @@  int slim_stream_enable(struct slim_stream_runtime *stream)
 }
 EXPORT_SYMBOL_GPL(slim_stream_enable);
 
-/*
+/**
  * slim_stream_disable() - Disable a SLIMbus Stream
  *
  * @stream: instance of slim stream runtime to disable
@@ -423,7 +423,7 @@  int slim_stream_disable(struct slim_stream_runtime *stream)
 }
 EXPORT_SYMBOL_GPL(slim_stream_disable);
 
-/*
+/**
  * slim_stream_unprepare() - Un-prepare a SLIMbus Stream
  *
  * @stream: instance of slim stream runtime to unprepare
@@ -449,7 +449,7 @@  int slim_stream_unprepare(struct slim_stream_runtime *stream)
 }
 EXPORT_SYMBOL_GPL(slim_stream_unprepare);
 
-/*
+/**
  * slim_stream_free() - Free a SLIMbus Stream
  *
  * @stream: instance of slim stream runtime to free