Merge pull request #1 from g-oikonomou/contrib/fix-stm-doxy-warnings

Remove doxygen explicit links to non-existing symbols
This commit is contained in:
Benoît Thébaudeau 2015-06-20 17:24:34 +02:00
commit 67120676d4
2 changed files with 17 additions and 17 deletions

View File

@ -363,9 +363,9 @@ DEFINE_ERROR(MAC_INDIRECT_TIMEOUT, 0x42)
/** /**
* @brief The Simulated EEPROM is telling the application that there * @brief The Simulated EEPROM is telling the application that there
* is at least one flash page to be erased. The GREEN status means the * is at least one flash page to be erased. The GREEN status means the
* current page has not filled above the ::ERASE_CRITICAL_THRESHOLD. * current page has not filled above the ERASE_CRITICAL_THRESHOLD.
* *
* The application should call the function ::halSimEepromErasePage() when it can * The application should call the function halSimEepromErasePage() when it can
* to erase a page. * to erase a page.
*/ */
#define ST_SIM_EEPROM_ERASE_PAGE_GREEN(0x43) #define ST_SIM_EEPROM_ERASE_PAGE_GREEN(0x43)
@ -378,10 +378,10 @@ DEFINE_ERROR(SIM_EEPROM_ERASE_PAGE_GREEN, 0x43)
/** /**
* @brief The Simulated EEPROM is telling the application that there * @brief The Simulated EEPROM is telling the application that there
* is at least one flash page to be erased. The RED status means the * is at least one flash page to be erased. The RED status means the
* current page has filled above the ::ERASE_CRITICAL_THRESHOLD. * current page has filled above the ERASE_CRITICAL_THRESHOLD.
* *
* Due to the shrinking availablity of write space, there is a danger of * Due to the shrinking availablity of write space, there is a danger of
* data loss. The application must call the function ::halSimEepromErasePage() * data loss. The application must call the function halSimEepromErasePage()
* as soon as possible to erase a page. * as soon as possible to erase a page.
*/ */
#define ST_SIM_EEPROM_ERASE_PAGE_RED(0x44) #define ST_SIM_EEPROM_ERASE_PAGE_RED(0x44)
@ -394,9 +394,9 @@ DEFINE_ERROR(SIM_EEPROM_ERASE_PAGE_RED, 0x44)
/** /**
* @brief The Simulated EEPROM has run out of room to write any new data * @brief The Simulated EEPROM has run out of room to write any new data
* and the data trying to be set has been lost. This error code is the * and the data trying to be set has been lost. This error code is the
* result of ignoring the ::SIM_EEPROM_ERASE_PAGE_RED error code. * result of ignoring the ::ST_SIM_EEPROM_ERASE_PAGE_RED error code.
* *
* The application must call the function ::halSimEepromErasePage() to make room for * The application must call the function halSimEepromErasePage() to make room for
* any further calls to set a token. * any further calls to set a token.
*/ */
#define ST_SIM_EEPROM_FULL(0x45) #define ST_SIM_EEPROM_FULL(0x45)
@ -440,8 +440,8 @@ DEFINE_ERROR(SIM_EEPROM_INIT_2_FAILED, 0x49)
/** /**
* @brief Attempt 3 to initialize the Simulated EEPROM has failed. * @brief Attempt 3 to initialize the Simulated EEPROM has failed.
* *
* This failure means one or both of the tokens ::TOKEN_MFG_NVDATA_VERSION or * This failure means one or both of the tokens TOKEN_MFG_NVDATA_VERSION or
* ::TOKEN_STACK_NVDATA_VERSION were incorrect and the token system failed to * TOKEN_STACK_NVDATA_VERSION were incorrect and the token system failed to
* properly reload default tokens and reset the Simulated EEPROM. * properly reload default tokens and reset the Simulated EEPROM.
*/ */
#define ST_SIM_EEPROM_INIT_3_FAILED(0x4A) #define ST_SIM_EEPROM_INIT_3_FAILED(0x4A)
@ -626,7 +626,7 @@ DEFINE_ERROR(COST_NOT_KNOWN, 0x71)
#ifdef DOXYGEN_SHOULD_SKIP_THIS #ifdef DOXYGEN_SHOULD_SKIP_THIS
/** /**
* @brief The maximum number of in-flight messages (i.e. * @brief The maximum number of in-flight messages (i.e.
* ::ST_APS_UNICAST_MESSAGE_COUNT) has been reached. * ST_APS_UNICAST_MESSAGE_COUNT) has been reached.
*/ */
#define ST_MAX_MESSAGE_LIMIT_REACHED(0x72) #define ST_MAX_MESSAGE_LIMIT_REACHED(0x72)
#else #else
@ -820,7 +820,7 @@ DEFINE_ERROR(PHY_ACK_RECEIVED, 0x8F)
/** /**
* @name Return Codes Passed to stStackStatusHandler() * @name Return Codes Passed to stStackStatusHandler()
* See also ::stStackStatusHandler(). * See also stStackStatusHandler().
* *
* @{ * @{
*/ */
@ -882,7 +882,7 @@ DEFINE_ERROR(CANNOT_JOIN_AS_ROUTER, 0x98)
#ifdef DOXYGEN_SHOULD_SKIP_THIS #ifdef DOXYGEN_SHOULD_SKIP_THIS
/** @brief The local node ID has changed. The application can obtain the new /** @brief The local node ID has changed. The application can obtain the new
* node ID by calling ::stGetNodeId(). * node ID by calling stGetNodeId().
*/ */
#define ST_NODE_ID_CHANGED(0x99) #define ST_NODE_ID_CHANGED(0x99)
#else #else
@ -892,7 +892,7 @@ DEFINE_ERROR(NODE_ID_CHANGED, 0x99)
#ifdef DOXYGEN_SHOULD_SKIP_THIS #ifdef DOXYGEN_SHOULD_SKIP_THIS
/** @brief The local PAN ID has changed. The application can obtain the new PAN /** @brief The local PAN ID has changed. The application can obtain the new PAN
* ID by calling ::stGetPanId(). * ID by calling stGetPanId().
*/ */
#define ST_PAN_ID_CHANGED(0x9A) #define ST_PAN_ID_CHANGED(0x9A)
#else #else
@ -920,7 +920,7 @@ DEFINE_ERROR(NO_BEACONS, 0xAB)
#ifdef DOXYGEN_SHOULD_SKIP_THIS #ifdef DOXYGEN_SHOULD_SKIP_THIS
/** @brief An attempt was made to join a Secured Network using a pre-configured /** @brief An attempt was made to join a Secured Network using a pre-configured
* key, but the Trust Center sent back a Network Key in-the-clear when * key, but the Trust Center sent back a Network Key in-the-clear when
* an encrypted Network Key was required. (::ST_REQUIRE_ENCRYPTED_KEY). * an encrypted Network Key was required. (ST_REQUIRE_ENCRYPTED_KEY).
*/ */
#define ST_RECEIVED_KEY_IN_THE_CLEAR(0xAC) #define ST_RECEIVED_KEY_IN_THE_CLEAR(0xAC)
#else #else
@ -940,7 +940,7 @@ DEFINE_ERROR(NO_NETWORK_KEY_RECEIVED, 0xAD)
#ifdef DOXYGEN_SHOULD_SKIP_THIS #ifdef DOXYGEN_SHOULD_SKIP_THIS
/** @brief After a device joined a Secured Network, a Link Key was requested /** @brief After a device joined a Secured Network, a Link Key was requested
* (::ST_GET_LINK_KEY_WHEN_JOINING) but no response was ever received. * (ST_GET_LINK_KEY_WHEN_JOINING) but no response was ever received.
*/ */
#define ST_NO_LINK_KEY_RECEIVED(0xAE) #define ST_NO_LINK_KEY_RECEIVED(0xAE)
#else #else
@ -978,7 +978,7 @@ DEFINE_ERROR(KEY_INVALID, 0xB2)
#ifdef DOXYGEN_SHOULD_SKIP_THIS #ifdef DOXYGEN_SHOULD_SKIP_THIS
/** /**
* @brief The chosen security level (the value of ::ST_SECURITY_LEVEL) * @brief The chosen security level (the value of ST_SECURITY_LEVEL)
* is not supported by the stack. * is not supported by the stack.
*/ */
#define ST_INVALID_SECURITY_LEVEL(0x95) #define ST_INVALID_SECURITY_LEVEL(0x95)
@ -1011,7 +1011,7 @@ DEFINE_ERROR(INVALID_SECURITY_LEVEL, 0x95)
#ifdef DOXYGEN_SHOULD_SKIP_THIS #ifdef DOXYGEN_SHOULD_SKIP_THIS
/** @brief There was an attempt to form or join a network with security /** @brief There was an attempt to form or join a network with security
* without calling ::stSetInitialSecurityState() first. * without calling stSetInitialSecurityState() first.
*/ */
#define ST_SECURITY_STATE_NOT_SET(0xA8) #define ST_SECURITY_STATE_NOT_SET(0xA8)
#else #else

View File

@ -1 +1 @@
154 134