From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by dpdk.space (Postfix) with ESMTP id ACD43A0096 for ; Fri, 10 May 2019 18:40:14 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 4CD943977; Fri, 10 May 2019 18:40:13 +0200 (CEST) Received: from mga18.intel.com (mga18.intel.com [134.134.136.126]) by dpdk.org (Postfix) with ESMTP id 2AFFA2C18 for ; Fri, 10 May 2019 18:40:10 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by orsmga106.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 10 May 2019 09:40:09 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.60,454,1549958400"; d="scan'208";a="170379548" Received: from txasoft-yocto.an.intel.com ([10.123.72.192]) by fmsmga002.fm.intel.com with ESMTP; 10 May 2019 09:40:09 -0700 From: Erik Gabriel Carrillo To: rsanford@akamai.com, thomas@monjalon.net Cc: dev@dpdk.org Date: Fri, 10 May 2019 11:38:36 -0500 Message-Id: <1557506316-31699-1-git-send-email-erik.g.carrillo@intel.com> X-Mailer: git-send-email 1.7.10 Subject: [dpdk-dev] [PATCH] doc: fix doxygen documentation for timer API X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Content-Type: text/plain; charset="UTF-8" Message-ID: <20190510163836.xMjy5Rcfr56skm8JBTdFQCYiOyKOskU5RQZ3mfqYN5E@z> 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 --- lib/librte_timer/rte_timer.h | 54 ++++++++++++-------------------------------- 1 file changed, 14 insertions(+), 40 deletions(-) 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 -- 2.6.4