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

misc: mic: scif: scif_nm: Supply various kerneldoc fix-ups

Includes; missing descriptions for function args, the promotion
of obvious kerneldoc headers and the mis-formatting of existing
argument descriptions.

Fixes the following W=1 kernel build warnings:

drivers/misc/mic/scif/scif_nm.c:19: warning: Function parameter or member 'node' not described in 'scif_invalidate_ep'
drivers/misc/mic/scif/scif_nm.c:173: warning: Function parameter or member 'node_id' not described in 'scif_disconnect_node'

Signed-off-by: Lee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20200701083118.45744-23-lee.jones@linaro.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Lee Jones and committed by
Greg Kroah-Hartman
9afe1839 5ab3f590

+9 -8
+9 -8
drivers/misc/mic/scif/scif_nm.c
··· 14 14 /** 15 15 * scif_invalidate_ep() - Set state for all connected endpoints 16 16 * to disconnected and wake up all send/recv waitqueues 17 + * 18 + * @node: Node to invalidate 17 19 */ 18 20 static void scif_invalidate_ep(int node) 19 21 { ··· 101 99 } 102 100 } 103 101 104 - /* 105 - * scif_cleanup_scifdev 106 - * 102 + /** 103 + * scif_cleanup_scifdev - Uninitialize SCIF data structures for remote 104 + * SCIF device. 107 105 * @dev: Remote SCIF device. 108 - * Uninitialize SCIF data structures for remote SCIF device. 109 106 */ 110 107 void scif_cleanup_scifdev(struct scif_dev *dev) 111 108 { ··· 137 136 scif_cleanup_qp(dev); 138 137 } 139 138 140 - /* 141 - * scif_remove_node: 139 + /** 140 + * scif_remove_node 142 141 * 143 142 * @node: Node to remove 144 143 */ ··· 163 162 } 164 163 165 164 /** 166 - * scif_node_disconnect: 165 + * scif_node_disconnect 167 166 * 168 - * @node_id[in]: source node id. 167 + * @node_id: source node id [in] 169 168 * @mgmt_initiated: Disconnection initiated from the mgmt node 170 169 * 171 170 * Disconnect a node from the scif network.