Re: [PATCH] fs: jbd2: transaction: Add kernel-doc parameter descriptions
From: Jan Kara
Date: Mon Jul 17 2017 - 05:20:47 EST
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@xxxxxxxxx>
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@xxxxxxxx>
SUSE Labs, CR