doc: fix doxygen syntax of some comments

[dpdk.git] / lib / librte_eal / common / include / rte_memzone.h

diff --git a/lib/librte_eal/common/include/rte_memzone.h b/lib/librte_eal/common/include/rte_memzone.h
index 38e5f5b..53f4232 100644 (file)
--- a/lib/librte_eal/common/include/rte_memzone.h
+++ b/lib/librte_eal/common/include/rte_memzone.h
@@ -92,7 +92,7 @@ struct rte_memzone {
        int32_t socket_id;                /**< NUMA socket ID. */
 
        uint32_t flags;                   /**< Characteristics of this memzone. */
-       uint32_t memseg_id;             /** <store the memzone is from which memseg. */
+       uint32_t memseg_id;               /**< Memseg it belongs. */
 } __attribute__((__packed__));
 
 /**
@@ -258,10 +258,12 @@ const struct rte_memzone *rte_memzone_reserve_bounded(const char *name,
 /**
  * Free a memzone.
  *
+ * Note: an IVSHMEM zone cannot be freed.
+ *
  * @param mz
  *   A pointer to the memzone
  * @return
- *  -EINVAL - invalid parameter
+ *  -EINVAL - invalid parameter, IVSHMEM memzone.
  *  0 - success
  */
 int rte_memzone_free(const struct rte_memzone *mz);