From: Hannes Reinecke <hare@suse.de>
Date: Wed, 2 Feb 2022 07:23:49 +0000 (+0100)
Subject: fabrics.c: fixup kernel-doc comments
X-Git-Tag: v1.0-rc3~18^2~3
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=3068bd77168850c47a9e8ce6f14bfaf8ae6a53fa;p=users%2Fsagi%2Flibnvme.git

fabrics.c: fixup kernel-doc comments

To keep sphinx happy.

Signed-off-by: Hannes Reinecke <hare@suse.de>
---

diff --git a/src/nvme/fabrics.c b/src/nvme/fabrics.c
index c9f987a0..d8f4be25 100644
--- a/src/nvme/fabrics.c
+++ b/src/nvme/fabrics.c
@@ -316,8 +316,10 @@ free_tmp:
 
 /**
  * inet_pton_with_scope - convert an IPv4/IPv6 to socket address
+ * @r: nvme_root_t object
  * @af: address family, AF_INET, AF_INET6 or AF_UNSPEC for either
  * @src: the start of the address string
+ * @trsvcid: transport service identifier
  * @addr: output socket address
  *
  * Return 0 on success, errno otherwise.
@@ -842,15 +844,17 @@ static int uuid_from_dmi_entries(char *system_uuid)
 	return strlen(system_uuid) ? 0 : -ENXIO;
 }
 
+#define PATH_DMI_PROD_UUID  "/sys/class/dmi/id/product_uuid"
+
 /**
- * @brief Get system UUID from /sys/class/dmi/id/product_uuid and fix
- *        endianess.
+ * uuid_from_product_uuid() - Get system UUID from product_uuid
+ * @system_uuid: Where to save the system UUID.
  *
- * @param system_uuid - Where to save the system UUID.
+ * Get system UUID from /sys/class/dmi/id/product_uuid and fix
+ * endianess.
  *
- * @return 0 on success, -ENXIO otherwise.
+ * Return: 0 on success, -ENXIO otherwise.
  */
-#define PATH_DMI_PROD_UUID  "/sys/class/dmi/id/product_uuid"
 static int uuid_from_product_uuid(char *system_uuid)
 {
 	FILE *stream = NULL;
@@ -890,12 +894,17 @@ static int uuid_from_product_uuid(char *system_uuid)
 }
 
 /**
- * @brief The system UUID can be read from two different locations:
+ * uuid_from_dmi() - read system UUID
+ * @system_uuid: buffer for the UUID
+ *
+ * The system UUID can be read from two different locations:
  *
  *     1) /sys/class/dmi/id/product_uuid
  *     2) /sys/firmware/dmi/entries
  *
  * Note that the second location is not present on Debian-based systems.
+ *
+ * Return: 0 on success, negative errno otherwise.
  */
 static int uuid_from_dmi(char *system_uuid)
 {