Skip to content

Commit

Permalink
power: fix some doxygen comments
Browse files Browse the repository at this point in the history
[ upstream commit 58794bf ]

Fix following syntax error reported by doxygen 1.9.5 version.

lib/power/rte_power.h:169: error: rte_power_freq_up has
@param documentation sections but no arguments
(warning treated as error, aborting now)

Fixes: d7937e2 ("power: initial import")

Signed-off-by: Jerin Jacob <jerinj@marvell.com>
  • Loading branch information
jerinjacobk authored and kevintraynor committed Nov 23, 2022
1 parent 3ff1241 commit 5a4f6d1
Showing 1 changed file with 0 additions and 55 deletions.
55 changes: 0 additions & 55 deletions lib/power/rte_power.h
Expand Up @@ -171,100 +171,45 @@ typedef int (*rte_power_freq_change_t)(unsigned int lcore_id);
* Scale up the frequency of a specific lcore according to the available
* frequencies.
* Review each environments specific documentation for usage.
*
* @param lcore_id
* lcore id.
*
* @return
* - 1 on success with frequency changed.
* - 0 on success without frequency changed.
* - Negative on error.
*/
extern rte_power_freq_change_t rte_power_freq_up;

/**
* Scale down the frequency of a specific lcore according to the available
* frequencies.
* Review each environments specific documentation for usage.
*
* @param lcore_id
* lcore id.
*
* @return
* - 1 on success with frequency changed.
* - 0 on success without frequency changed.
* - Negative on error.
*/

extern rte_power_freq_change_t rte_power_freq_down;

/**
* Scale up the frequency of a specific lcore to the highest according to the
* available frequencies.
* Review each environments specific documentation for usage.
*
* @param lcore_id
* lcore id.
*
* @return
* - 1 on success with frequency changed.
* - 0 on success without frequency changed.
* - Negative on error.
*/
extern rte_power_freq_change_t rte_power_freq_max;

/**
* Scale down the frequency of a specific lcore to the lowest according to the
* available frequencies.
* Review each environments specific documentation for usage..
*
* @param lcore_id
* lcore id.
*
* @return
* - 1 on success with frequency changed.
* - 0 on success without frequency changed.
* - Negative on error.
*/
extern rte_power_freq_change_t rte_power_freq_min;

/**
* Query the Turbo Boost status of a specific lcore.
* Review each environments specific documentation for usage..
*
* @param lcore_id
* lcore id.
*
* @return
* - 1 Turbo Boost is enabled for this lcore.
* - 0 Turbo Boost is disabled for this lcore.
* - Negative on error.
*/
extern rte_power_freq_change_t rte_power_turbo_status;

/**
* Enable Turbo Boost for this lcore.
* Review each environments specific documentation for usage..
*
* @param lcore_id
* lcore id.
*
* @return
* - 0 on success.
* - Negative on error.
*/
extern rte_power_freq_change_t rte_power_freq_enable_turbo;

/**
* Disable Turbo Boost for this lcore.
* Review each environments specific documentation for usage..
*
* @param lcore_id
* lcore id.
*
* @return
* - 0 on success.
* - Negative on error.
*/
extern rte_power_freq_change_t rte_power_freq_disable_turbo;

Expand Down

0 comments on commit 5a4f6d1

Please sign in to comment.