Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

befs: add kernel-doc formatting for befs_bt_read_super()

fs/befs/TODO mentions some comments needing conversion to Kernel-Doc
formatting. This patch changes the comment describing befs_bt_read_super().

Signed-off-by: Tommy Nguyen <remyabel@gmail.com>
Signed-off-by: Luis de Bethencourt <luisbg@kernel.org>

authored by

Tommy Nguyen and committed by
Luis de Bethencourt
799ce1db 6f7da290

+6 -9
+6 -9
fs/befs/btree.c
··· 120 120 const void *key2, int keylen2); 121 121 122 122 /** 123 - * befs_bt_read_super - read in btree superblock convert to cpu byteorder 124 - * @sb: Filesystem superblock 125 - * @ds: Datastream to read from 126 - * @sup: Buffer in which to place the btree superblock 123 + * befs_bt_read_super() - read in btree superblock convert to cpu byteorder 124 + * @sb: Filesystem superblock 125 + * @ds: Datastream to read from 126 + * @sup: Buffer in which to place the btree superblock 127 127 * 128 128 * Calls befs_read_datastream to read in the btree superblock and 129 129 * makes sure it is in cpu byteorder, byteswapping if necessary. 130 - * 131 - * On success, returns BEFS_OK and *@sup contains the btree superblock, 132 - * in cpu byte order. 133 - * 134 - * On failure, BEFS_ERR is returned. 130 + * Return: BEFS_OK on success and if *@sup contains the btree superblock in cpu 131 + * byte order. Otherwise return BEFS_ERR on error. 135 132 */ 136 133 static int 137 134 befs_bt_read_super(struct super_block *sb, const befs_data_stream *ds,