From 1a11380bf45be83d66493819f3a6e8c9868869be Mon Sep 17 00:00:00 2001 From: David Marchand Date: Fri, 9 Oct 2020 09:15:54 +0200 Subject: [PATCH] eal: fix doxygen for EAL cleanup 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 Acked-by: Thomas Monjalon --- lib/librte_eal/include/rte_eal.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/lib/librte_eal/include/rte_eal.h b/lib/librte_eal/include/rte_eal.h index ddcf6a2e7a..e3c2ef185e 100644 --- a/lib/librte_eal/include/rte_eal.h +++ b/lib/librte_eal/include/rte_eal.h @@ -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); -- 2.20.1