nvme: mention TRID parsing function in struct docs

Change-Id: I9509155cd4400334e6a1b5c1fdff8546fe5266d5 Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2017-01-20 14:07:31 -07:00 · 2017-01-20 14:07:31 -07:00 · 76977232ca
commit 76977232ca
parent 53bf2d0f91
1 changed files with 3 additions and 0 deletions
--- a/include/spdk/nvme.h
+++ b/include/spdk/nvme.h
@ -134,6 +134,9 @@ enum spdk_nvme_transport_type {
 * NVMe transport identifier.
 *
 * This identifies a unique endpoint on an NVMe fabric.
+ *
+ * A string representation of a transport ID may be converted to this type using
+ * spdk_nvme_transport_id_parse().
 */
 struct spdk_nvme_transport_id {
 	/**