Re: [PATCH] staging: sm750fb: format description of parameters the to kernel doc format

On 10/16/19 6:29 PM, gbittencourt wrote:

Hi Randy,

On 10/16/19 10:25 PM, Randy Dunlap wrote:

quoted

Hi,

On 10/16/19 6:18 PM, Gabriela Bittencourt wrote:

quoted

Cluster comments that describes parameters of functions and create one
single comment before the function in kernel doc format.

Good plan.

How did you test this patch?

I haven't test it. How can I do it?

Hm. There used to be a comment in a (now deleted) document named
Documentation/kernel-doc-nano-HOWTO.txt about how to test kernel-doc.

I took that comment and made a script from it.
I'll attach the script.  It's easy to use, but it is made to test only
one function or struct or union or enum at a time.

You need to have a script named 'kernel-doc' in your PATH or you can
specify where the script is located by using
$ KERNDOC=path/to/scripts/kernel-doc kdoc_function _parameters_

Its usage is:
  kdoc_function filename funcname [text|man|html|docbook|xml]

where funcname can be a function, struct, union, or enum name.
The output format can be any of those listed, but the default is "text".

Let me know if you have any questions or problems.

quoted

quoted

Signed-off-by: Gabriela Bittencourt <redacted>
---
  drivers/staging/sm750fb/sm750_accel.c | 65 +++++++++++++++------------
  1 file changed, 37 insertions(+), 28 deletions(-)

-- 
~Randy