Re: [PATCH] fs: jbd2: transaction: Add kernel-doc parameter descriptions

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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



[Index of Archives]     [Reiser Filesystem Development]     [Ceph FS]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite National Park]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Device Mapper]     [Linux Media]

  Powered by Linux