deac/osd-contiki
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Doxygen Fix

Browse source 
this minor fixation to avoid Doxygen bug, which appears when doing this in the documented code:
/**
* \exception \c text
*/
void foo();
This commit is contained in:
Mohamed Seliem 2016-09-22 22:30:54 +02:00 committed by GitHub
parent 6aa5890e73
commit 150b97879d
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
platform/zoul/remote-reva/power-mgmt.h
View file

@ -152,29 +152,29 @@ typedef enum {
* @{ * @{
*/ */
/** \brief Initializes the Power Management driver /** \brief Initializes the Power Management driver
* \return \c PM_SUCCESS if initialized, else \c PM_ERROR * \return PM_SUCCESS if initialized, else PM_ERROR
*/ */
int8_t pm_init(void); int8_t pm_init(void);
/* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */
/** \brief Enable the shutdown mode, periodically driven by the Nano Timer /** \brief Enable the shutdown mode, periodically driven by the Nano Timer
* \return \c PM_SUCCESS if successful, else \c PM_ERROR * \return PM_SUCCESS if successful, else PM_ERROR
*/ */
int8_t pm_enable_timer(void); int8_t pm_enable_timer(void);
/* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */
/** \brief Disable the Nano Timer /** \brief Disable the Nano Timer
* \return \c PM_SUCCESS if successful, else \c PM_ERROR * \return PM_SUCCESS if successful, else PM_ERROR
*/ */
int8_t pm_disable_timer(void); int8_t pm_disable_timer(void);
/* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */
/** \brief Get the current state of the power management module /** \brief Get the current state of the power management module
* \param state Pointer to a variable to save the state * \param state Pointer to a variable to save the state
* \return \c PM_SUCCESS if successful, else \c PM_ERROR * \return PM_SUCCESS if successful, else PM_ERROR
*/ */
int8_t pm_get_state(uint8_t *state); int8_t pm_get_state(uint8_t *state);
/* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */
/** \brief Get the firmware version of the power management module /** \brief Get the firmware version of the power management module
* \param state Pointer to a variable to save the state * \param state Pointer to a variable to save the state
* \return \c PM_SUCCESS if successful, else \c PM_ERROR * \return PM_SUCCESS if successful, else PM_ERROR
*/ */
int8_t pm_get_firmware_version(uint8_t *state); int8_t pm_get_firmware_version(uint8_t *state);
/* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */