Merge pull request #7348 from hasnainvirk/doc_fix

LoRaWAN: Correcting doxygen

Author: 0xc0170

features/lorawan/LoRaWANBase.h

@@ -203,15 +203,9 @@ class LoRaWANBase {
      *                          MSG_CONFIRMED_FLAG = 0x02
      *                          MSG_MULTICAST_FLAG = 0x04
      *                          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
      *                          LORAWAN_STATUS_WOULD_BLOCK if another TX is
@@ -240,14 +234,11 @@ class LoRaWANBase {
      *                          MSG_MULTICAST_FLAG = 0x04,
      *                          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.
+     *                          All flags can be used in conjunction with
+     *                          one another depending on the intended use case or reception
+     *                          expectation.
      *
-     *                          MSG_CONFIRMED_FLAG and MSG_UNCONFIRMED_FLAG are
+     *                          e.g., MSG_CONFIRMED_FLAG and MSG_UNCONFIRMED_FLAG are
      *                          not mutually exclusive, i.e., the user can subscribe to
      *                          receive both CONFIRMED AND UNCONFIRMED messages at
      *                          the same time.

features/lorawan/LoRaWANInterface.h

@@ -301,14 +301,9 @@ class LoRaWANInterface: public LoRaWANBase {
      *                          MSG_CONFIRMED_FLAG = 0x02
      *                          MSG_MULTICAST_FLAG = 0x04
      *                          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
@@ -338,14 +333,11 @@ class LoRaWANInterface: public LoRaWANBase {
      *                          MSG_MULTICAST_FLAG = 0x04,
      *                          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.
+     *                          All flags can be used in conjunction with
+     *                          one another depending on the intended use case or reception
+     *                          expectation.
      *
-     *                          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
+     *                          e.g., MSG_CONFIRMED_FLAG and MSG_UNCONFIRMED_FLAG are
      *                          not mutually exclusive, i.e., the user can subscribe to
      *                          receive both CONFIRMED AND UNCONFIRMED messages at
      *                          the same time.