eal: fix doxygen for EAL cleanup
authorDavid Marchand <david.marchand@redhat.com>
Fri, 9 Oct 2020 07:15:54 +0000 (09:15 +0200)
committerDavid Marchand <david.marchand@redhat.com>
Mon, 12 Oct 2020 12:19:05 +0000 (14:19 +0200)
Align rte_eal_cleanup return codes description to the rest of dpdk.

Fixes: aec9c13c5257 ("eal: add function to release internal resources")
Cc: stable@dpdk.org
Signed-off-by: David Marchand <david.marchand@redhat.com>
Acked-by: Thomas Monjalon <thomas@monjalon.net>
lib/librte_eal/include/rte_eal.h

index ddcf6a2..e3c2ef1 100644 (file)
@@ -130,8 +130,9 @@ int rte_eal_init(int argc, char **argv);
  * be made. It is expected that common usage of this function is to call it
  * just before terminating the process.
  *
- * @return 0 Successfully released all internal EAL resources
- * @return -EFAULT There was an error in releasing all resources.
+ * @return
+ *  - 0 Successfully released all internal EAL resources.
+ *  - -EFAULT There was an error in releasing all resources.
  */
 int rte_eal_cleanup(void);