lkml.org 
[lkml]   [2017]   [Jul]   [17]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH] fs: jbd2: transaction: Add kernel-doc parameter descriptions
On Mon 26-06-17 10:20:22, sayli karnik wrote:
> Add function parameters in kernel-doc comments to fix warnings in the
> Sphinx build:
> transaction.c:511: warning: No description found for parameter 'type'
> transaction.c:511: warning: No description found for parameter 'line_no'
>
> Signed-off-by: sayli karnik <karniksayli1995@gmail.com>

I'd suggest to have more useful description like below:

> + * @type: type of handle

the reason why transaction handle was started - one of EXT4_TH_ defines

> + * @line_no: line number of handle

the line from which the function was called (used for debug output)

Honza
--
Jan Kara <jack@suse.com>
SUSE Labs, CR

\
 
 \ /
  Last update: 2017-07-17 11:21    [W:0.151 / U:29.648 seconds]
©2003-2017 Jasper Spaans. hosted at Digital OceanAdvertise on this site