On Wed, 2007-09-19 at 15:07 -0700, Randy Dunlap wrote:
>
> They aren't quite in kernel-doc format. Holler if you need help
> with that, or see examples, or
> Documentation/kernel-doc-nano-HOWTO.txt.
Should we do comments for every single function argument, or is it OK to
leave them out for the obvious ones?
init_file() gets really boring:
> + * init_file - initialize a 'struct file'
> + * @file: the already allocated 'struct file' to initialized
> + * @mnt: the vfsmount on which the file resides
> + * @dentry: the dentry for the file
> + * @mode: the file's mode
> + * @fop: the file's operations
Seems like a waste of space to me, but I'd be happy to do them if that's
the convention.
-- Dave
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
[Index of Archives]
[Kernel Newbies]
[Netfilter]
[Bugtraq]
[Photo]
[Stuff]
[Gimp]
[Yosemite News]
[MIPS Linux]
[ARM Linux]
[Linux Security]
[Linux RAID]
[Video 4 Linux]
[Linux for the blind]
[Linux Resources]
