ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Correcting doxygen 

Use of MSG_FLAGS was updated in previous PRs but the doc was not updated
accordingly.
pull/7348/head
Hasnain Virk 2018-06-27 15:23:52 +03:00
parent 65abff9ce8
commit ce1e210e4a
2 changed files with 12 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
features/lorawan/LoRaWANBase.h
View File

@ -203,15 +203,9 @@ public:
* MSG_CONFIRMED_FLAG = 0x02 * MSG_CONFIRMED_FLAG = 0x02
* MSG_MULTICAST_FLAG = 0x04 * MSG_MULTICAST_FLAG = 0x04
* MSG_PROPRIETARY_FLAG = 0x08 * MSG_PROPRIETARY_FLAG = 0x08
* MSG_MULTICAST_FLAG and MSG_PROPRIETARY_FLAG can be
* used in conjunction with MSG_UNCONFIRMED_FLAG and
* MSG_CONFIRMED_FLAG depending on the intended use.
*
* MSG_PROPRIETARY_FLAG|MSG_CONFIRMED_FLAG mask will set
* a confirmed message flag for a proprietary message.
* MSG_CONFIRMED_FLAG and MSG_UNCONFIRMED_FLAG are
* mutually exclusive.
* *
* All flags are mutually exclusive and MSG_MULTICAST_FLAG
* cannot be set.
* *
* @return The number of bytes sent, or * @return The number of bytes sent, or
* LORAWAN_STATUS_WOULD_BLOCK if another TX is * LORAWAN_STATUS_WOULD_BLOCK if another TX is
@ -240,14 +234,11 @@ public:
* MSG_MULTICAST_FLAG = 0x04, * MSG_MULTICAST_FLAG = 0x04,
* MSG_PROPRIETARY_FLAG = 0x08 * MSG_PROPRIETARY_FLAG = 0x08
* *
* MSG_MULTICAST_FLAG and MSG_PROPRIETARY_FLAG can be * All flags can be used in conjunction with
* used in conjunction with MSG_UNCONFIRMED_FLAG and * each other depending on the intended use case or reception
* MSG_CONFIRMED_FLAG depending on the intended use. * expectation.
* *
* MSG_PROPRIETARY_FLAG|MSG_CONFIRMED_FLAG mask will set * e.g., MSG_CONFIRMED_FLAG and MSG_UNCONFIRMED_FLAG are
* a confirmed message flag for a proprietary message.
*
* MSG_CONFIRMED_FLAG and MSG_UNCONFIRMED_FLAG are
* not mutually exclusive, i.e., the user can subscribe to * not mutually exclusive, i.e., the user can subscribe to
* receive both CONFIRMED AND UNCONFIRMED messages at * receive both CONFIRMED AND UNCONFIRMED messages at
* the same time. * the same time.

20
features/lorawan/LoRaWANInterface.h
View File

@ -301,14 +301,9 @@ public:
* MSG_CONFIRMED_FLAG = 0x02 * MSG_CONFIRMED_FLAG = 0x02
* MSG_MULTICAST_FLAG = 0x04 * MSG_MULTICAST_FLAG = 0x04
* MSG_PROPRIETARY_FLAG = 0x08 * MSG_PROPRIETARY_FLAG = 0x08
* MSG_MULTICAST_FLAG and MSG_PROPRIETARY_FLAG can be
* used in conjunction with MSG_UNCONFIRMED_FLAG and
* MSG_CONFIRMED_FLAG depending on the intended use.
* *
* MSG_PROPRIETARY_FLAG|MSG_CONFIRMED_FLAG mask will set * All flags are mutually exclusive and MSG_MULTICAST_FLAG
* a confirmed message flag for a proprietary message. * cannot be set.
* MSG_CONFIRMED_FLAG and MSG_UNCONFIRMED_FLAG are
* mutually exclusive.
* *
* *
* @return The number of bytes sent, or * @return The number of bytes sent, or
@ -338,14 +333,11 @@ public:
* MSG_MULTICAST_FLAG = 0x04, * MSG_MULTICAST_FLAG = 0x04,
* MSG_PROPRIETARY_FLAG = 0x08 * MSG_PROPRIETARY_FLAG = 0x08
* *
* MSG_MULTICAST_FLAG and MSG_PROPRIETARY_FLAG can be * All flags can be used in conjunction with
* used in conjunction with MSG_UNCONFIRMED_FLAG and * each other depending on the intended use case or reception
* MSG_CONFIRMED_FLAG depending on the intended use. * expectation.
* *
* MSG_PROPRIETARY_FLAG|MSG_CONFIRMED_FLAG mask will set * e.g., MSG_CONFIRMED_FLAG and MSG_UNCONFIRMED_FLAG are
* a confirmed message flag for a proprietary message.
*
* MSG_CONFIRMED_FLAG and MSG_UNCONFIRMED_FLAG are
* not mutually exclusive, i.e., the user can subscribe to * not mutually exclusive, i.e., the user can subscribe to
* receive both CONFIRMED AND UNCONFIRMED messages at * receive both CONFIRMED AND UNCONFIRMED messages at
* the same time. * the same time.