From: Michal Jastrzebski Date: Wed, 17 Jun 2015 14:37:02 +0000 (+0200) Subject: doc: fix doxygen warnings in QoS API X-Git-Tag: spdx-start~9054 X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=14456f59e9f7605d695cad8a61c5753dcb078696;p=dpdk.git doc: fix doxygen warnings in QoS API This patch fix doxygen warnings when generating documentation for qos_meter and qos_sched. Signed-off-by: Michal Jastrzebski Acked-by: Cristian Dumitrescu --- diff --git a/lib/librte_meter/rte_meter.h b/lib/librte_meter/rte_meter.h index 92728a5b56..2cd8d814bd 100644 --- a/lib/librte_meter/rte_meter.h +++ b/lib/librte_meter/rte_meter.h @@ -123,7 +123,7 @@ rte_meter_trtcm_config(struct rte_meter_trtcm *m, * Handle to srTCM instance * @param time * Current CPU time stamp (measured in CPU cycles) - * @param pkt_length + * @param pkt_len * Length of the current IP packet (measured in bytes) * @return * Color assigned to the current IP packet @@ -140,7 +140,7 @@ rte_meter_srtcm_color_blind_check(struct rte_meter_srtcm *m, * Handle to srTCM instance * @param time * Current CPU time stamp (measured in CPU cycles) - * @param pkt_length + * @param pkt_len * Length of the current IP packet (measured in bytes) * @param pkt_color * Input color of the current IP packet @@ -160,7 +160,7 @@ rte_meter_srtcm_color_aware_check(struct rte_meter_srtcm *m, * Handle to trTCM instance * @param time * Current CPU time stamp (measured in CPU cycles) - * @param pkt_length + * @param pkt_len * Length of the current IP packet (measured in bytes) * @return * Color assigned to the current IP packet @@ -177,7 +177,7 @@ rte_meter_trtcm_color_blind_check(struct rte_meter_trtcm *m, * Handle to trTCM instance * @param time * Current CPU time stamp (measured in CPU cycles) - * @param pkt_length + * @param pkt_len * Length of the current IP packet (measured in bytes) * @param pkt_color * Input color of the current IP packet diff --git a/lib/librte_sched/rte_bitmap.h b/lib/librte_sched/rte_bitmap.h index 95f3c0d3a8..216a344a0a 100644 --- a/lib/librte_sched/rte_bitmap.h +++ b/lib/librte_sched/rte_bitmap.h @@ -228,14 +228,14 @@ rte_bitmap_get_memory_footprint(uint32_t n_bits) { /** * Bitmap initialization * - * @param bmp - * Handle to bitmap instance - * @param array2 - * Base address of pre-allocated array2 + * @param mem_size + * Minimum expected size of bitmap. + * @param mem + * Base address of array1 and array2. * @param n_bits * Number of pre-allocated bits in array2. Must be non-zero and multiple of 512. * @return - * 0 upon success, error code otherwise + * Handle to bitmap instance. */ static inline struct rte_bitmap * rte_bitmap_init(uint32_t n_bits, uint8_t *mem, uint32_t mem_size) diff --git a/lib/librte_sched/rte_red.h b/lib/librte_sched/rte_red.h index 0d8412ff3c..78af4e7a99 100644 --- a/lib/librte_sched/rte_red.h +++ b/lib/librte_sched/rte_red.h @@ -119,7 +119,7 @@ struct rte_red { /** * @brief Initialises run-time data * - * @param [in,out] data pointer to RED runtime data + * @param red [in,out] data pointer to RED runtime data * * @return Operation status * @retval 0 success @@ -131,12 +131,12 @@ rte_red_rt_data_init(struct rte_red *red); /** * @brief Configures a single RED configuration parameter structure. * - * @param [in,out] config pointer to a RED configuration parameter structure - * @param [in] wq_log2 log2 of the filter weight, valid range is: + * @param red_cfg [in,out] config pointer to a RED configuration parameter structure + * @param wq_log2 [in] log2 of the filter weight, valid range is: * RTE_RED_WQ_LOG2_MIN <= wq_log2 <= RTE_RED_WQ_LOG2_MAX - * @param [in] min_th queue minimum threshold in number of packets - * @param [in] max_th queue maximum threshold in number of packets - * @param [in] maxp_inv inverse maximum mark probability + * @param min_th [in] queue minimum threshold in number of packets + * @param max_th [in] queue maximum threshold in number of packets + * @param maxp_inv [in] inverse maximum mark probability * * @return Operation status * @retval 0 success @@ -170,8 +170,8 @@ rte_fast_rand(void) * @brief calculate factor to scale average queue size when queue * becomes empty * - * @param [in] wq_log2, where EWMA filter weight wq = 1/(2 ^ wq_log2) - * @param [in] m exponent in the computed value (1 - wq) ^ m + * @param wq_log2 [in] where EWMA filter weight wq = 1/(2 ^ wq_log2) + * @param m [in] exponent in the computed value (1 - wq) ^ m * * @return computed value * @retval ((1 - wq) ^ m) scaled in fixed-point format @@ -230,9 +230,9 @@ __rte_red_calc_qempty_factor(uint8_t wq_log2, uint16_t m) * * Note: packet is never dropped in this particular case. * - * @param [in] config pointer to a RED configuration parameter structure - * @param [in,out] data pointer to RED runtime data - * @param [in] time current time stamp + * @param red_cfg [in] config pointer to a RED configuration parameter structure + * @param red [in,out] data pointer to RED runtime data + * @param time [in] current time stamp * * @return Operation status * @retval 0 enqueue the packet @@ -310,8 +310,8 @@ rte_red_enqueue_empty(const struct rte_red_config *red_cfg, * @brief make a decision to drop or enqueue a packet based on mark probability * criteria * - * @param [in] config pointer to structure defining RED parameters - * @param [in,out] data pointer to RED runtime data + * @param red_cfg [in] config pointer to structure defining RED parameters + * @param red [in,out] data pointer to RED runtime data * * @return operation status * @retval 0 enqueue the packet @@ -347,9 +347,9 @@ __rte_red_drop(const struct rte_red_config *red_cfg, struct rte_red *red) /** * @brief Decides if new packet should be enqeued or dropped in queue non-empty case * - * @param [in] config pointer to a RED configuration parameter structure - * @param [in,out] data pointer to RED runtime data - * @param [in] q current queue size (measured in packets) + * @param red_cfg [in] config pointer to a RED configuration parameter structure + * @param red [in,out] data pointer to RED runtime data + * @param q [in] current queue size (measured in packets) * * @return Operation status * @retval 0 enqueue the packet @@ -408,10 +408,10 @@ rte_red_enqueue_nonempty(const struct rte_red_config *red_cfg, * Based on new queue average and RED configuration parameters * gives verdict whether to enqueue or drop the packet. * - * @param [in] config pointer to a RED configuration parameter structure - * @param [in,out] data pointer to RED runtime data - * @param [in] q updated queue size in packets - * @param [in] time current time stamp + * @param red_cfg [in] config pointer to a RED configuration parameter structure + * @param red [in,out] data pointer to RED runtime data + * @param q [in] updated queue size in packets + * @param time [in] current time stamp * * @return Operation status * @retval 0 enqueue the packet @@ -437,8 +437,8 @@ rte_red_enqueue(const struct rte_red_config *red_cfg, /** * @brief Callback to records time that queue became empty * - * @param [in,out] data pointer to RED runtime data - * @param [in] time current time stamp + * @param red [in,out] data pointer to RED runtime data + * @param time [in] current time stamp */ static inline void rte_red_mark_queue_empty(struct rte_red *red, const uint64_t time) diff --git a/lib/librte_sched/rte_sched.h b/lib/librte_sched/rte_sched.h index e6bba22eed..729f8c8a0d 100644 --- a/lib/librte_sched/rte_sched.h +++ b/lib/librte_sched/rte_sched.h @@ -347,6 +347,8 @@ rte_sched_queue_read_stats(struct rte_sched_port *port, * Traffic class ID within pipe (0 .. 3) * @param queue * Queue ID within pipe traffic class (0 .. 3) + * @param color + * Packet color set */ static inline void rte_sched_port_pkt_write(struct rte_mbuf *pkt,