diff mbox series

doc: fix doxygen documentation for timer API

Message ID 1557506316-31699-1-git-send-email-erik.g.carrillo@intel.com (mailing list archive)
State Accepted, archived
Headers
Series doc: fix doxygen documentation for timer API |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/intel-Performance-Testing success Performance Testing PASS
ci/mellanox-Performance-Testing success Performance Testing PASS

Commit Message

Carrillo, Erik G May 10, 2019, 4:38 p.m. UTC 
  Now that some of the symbols in the timer lib are versioned, the
Doxygen documentation that is generated is incorrect.  Group all
versioned symbols, listing the generic name first, and remove comments
for older versions of symbols.

Signed-off-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>
---
 lib/librte_timer/rte_timer.h | 54 ++++++++++++--------------------------------
 1 file changed, 14 insertions(+), 40 deletions(-)

Comments

Thomas Monjalon May 13, 2019, 3:25 p.m. UTC | #1 
10/05/2019 18:38, Erik Gabriel Carrillo:
> Now that some of the symbols in the timer lib are versioned, the
> Doxygen documentation that is generated is incorrect.  Group all
> versioned symbols, listing the generic name first, and remove comments
> for older versions of symbols.
> 
> Signed-off-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>

Applied, thanks
diff mbox series

Patch

diff --git a/lib/librte_timer/rte_timer.h b/lib/librte_timer/rte_timer.h
index b502f8c..2196934 100644
--- a/lib/librte_timer/rte_timer.h
+++ b/lib/librte_timer/rte_timer.h
@@ -169,14 +169,6 @@  int __rte_experimental rte_timer_data_dealloc(uint32_t id);
  *
  * Initializes internal variables (list, locks and so on) for the RTE
  * timer library.
- */
-void rte_timer_subsystem_init_v20(void);
-
-/**
- * Initialize the timer library.
- *
- * Initializes internal variables (list, locks and so on) for the RTE
- * timer library.
  *
  * @return
  *   - 0: Success
@@ -185,8 +177,9 @@  void rte_timer_subsystem_init_v20(void);
  *   - -ENOMEM: Unable to allocate memory needed to initialize timer
  *      subsystem
  */
-int rte_timer_subsystem_init_v1905(void);
 int rte_timer_subsystem_init(void);
+int rte_timer_subsystem_init_v1905(void);
+void rte_timer_subsystem_init_v20(void);
 
 /**
  * @warning
@@ -250,15 +243,15 @@  void rte_timer_init(struct rte_timer *tim);
  *   - 0: Success; the timer is scheduled.
  *   - (-1): Timer is in the RUNNING or CONFIG state.
  */
-int rte_timer_reset_v20(struct rte_timer *tim, uint64_t ticks,
-			enum rte_timer_type type, unsigned int tim_lcore,
-			rte_timer_cb_t fct, void *arg);
-int rte_timer_reset_v1905(struct rte_timer *tim, uint64_t ticks,
-			  enum rte_timer_type type, unsigned int tim_lcore,
-			  rte_timer_cb_t fct, void *arg);
 int rte_timer_reset(struct rte_timer *tim, uint64_t ticks,
 		    enum rte_timer_type type, unsigned tim_lcore,
 		    rte_timer_cb_t fct, void *arg);
+int rte_timer_reset_v1905(struct rte_timer *tim, uint64_t ticks,
+			  enum rte_timer_type type, unsigned int tim_lcore,
+			  rte_timer_cb_t fct, void *arg);
+int rte_timer_reset_v20(struct rte_timer *tim, uint64_t ticks,
+			enum rte_timer_type type, unsigned int tim_lcore,
+			rte_timer_cb_t fct, void *arg);
 
 
 /**
@@ -315,9 +308,9 @@  rte_timer_reset_sync(struct rte_timer *tim, uint64_t ticks,
  *   - 0: Success; the timer is stopped.
  *   - (-1): The timer is in the RUNNING or CONFIG state.
  */
-int rte_timer_stop_v20(struct rte_timer *tim);
-int rte_timer_stop_v1905(struct rte_timer *tim);
 int rte_timer_stop(struct rte_timer *tim);
+int rte_timer_stop_v1905(struct rte_timer *tim);
+int rte_timer_stop_v20(struct rte_timer *tim);
 
 /**
  * Loop until rte_timer_stop() succeeds.
@@ -355,34 +348,14 @@  int rte_timer_pending(struct rte_timer *tim);
  * The precision of the timer depends on the call frequency of this
  * function. However, the more often the function is called, the more
  * CPU resources it will use.
- */
-void rte_timer_manage_v20(void);
-
-/**
- * Manage the timer list and execute callback functions.
- *
- * This function must be called periodically from EAL lcores
- * main_loop(). It browses the list of pending timers and runs all
- * timers that are expired.
- *
- * The precision of the timer depends on the call frequency of this
- * function. However, the more often the function is called, the more
- * CPU resources it will use.
  *
  * @return
  *   - 0: Success
  *   - -EINVAL: timer subsystem not yet initialized
  */
-int rte_timer_manage_v1905(void);
 int rte_timer_manage(void);
-
-/**
- * Dump statistics about timers.
- *
- * @param f
- *   A pointer to a file for output
- */
-void rte_timer_dump_stats_v20(FILE *f);
+int rte_timer_manage_v1905(void);
+void rte_timer_manage_v20(void);
 
 /**
  * Dump statistics about timers.
@@ -393,8 +366,9 @@  void rte_timer_dump_stats_v20(FILE *f);
  *   - 0: Success
  *   - -EINVAL: timer subsystem not yet initialized
  */
-int rte_timer_dump_stats_v1905(FILE *f);
 int rte_timer_dump_stats(FILE *f);
+int rte_timer_dump_stats_v1905(FILE *f);
+void rte_timer_dump_stats_v20(FILE *f);
 
 /**
  * @warning