]> www.infradead.org Git - users/sagi/libnvme.git/commitdiff
doc: Workaround kenrel-doc code scanner
authorDaniel Wagner <dwagner@suse.de>
Mon, 27 Jun 2022 06:19:47 +0000 (08:19 +0200)
committerDaniel Wagner <dwagner@suse.de>
Mon, 27 Jun 2022 06:19:47 +0000 (08:19 +0200)
The kernel-doc scanner trips over a void function. It will complain
with 'contents before sections'. To help out, explicitly move the
state machine into the next state which avoids the warning.

Signed-off-by: Daniel Wagner <dwagner@suse.de>
src/nvme/mi.h

index 2b1cdcfa9b87c2d90534662c7cf7d31c2080d0cf..1b348a8aea7b8d07bcc6bee46c044cad14ad3617 100644 (file)
@@ -363,8 +363,8 @@ void nvme_mi_close(nvme_mi_ep_t ep);
 /**
  * nvme_mi_scan_mctp - look for MCTP-connected NVMe-MI endpoints.
  *
- * This function queries the system mctp daemon ("mctpd") over dbus, to find
- * MCTP endpoints that report support for NVMe-MI over MCTP.
+ * Description: This function queries the system mctp daemon ("mctpd") over
+ * dbus, to find MCTP endpoints that report support for NVMe-MI over MCTP.
  *
  * This requires libvnme-mi to be compiled with D-Bus support; if not, this
  * will return NULL.