Skip to content

Commit c8bb0df

Browse files
author
Daniel Jäckle
committed
Update comments for the doxygen documentation
1 parent 0e938d4 commit c8bb0df

File tree

1 file changed

+13
-21
lines changed

1 file changed

+13
-21
lines changed

src/mac/LoRaMac.h

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -130,19 +130,19 @@ typedef enum eDeviceClass
130130
/*!
131131
* LoRaWAN device class A
132132
*
133-
* LoRaWAN Specification V1.0.2, chapter 3ff
133+
* LoRaWAN Specification V1.0.2, chapter 3
134134
*/
135135
CLASS_A,
136136
/*!
137137
* LoRaWAN device class B
138138
*
139-
* LoRaWAN Specification V1.0.2, chapter 8ff
139+
* LoRaWAN Specification V1.0.2, chapter 8
140140
*/
141141
CLASS_B,
142142
/*!
143143
* LoRaWAN device class C
144144
*
145-
* LoRaWAN Specification V1.0.2, chapter 17ff
145+
* LoRaWAN Specification V1.0.2, chapter 17
146146
*/
147147
CLASS_C,
148148
}DeviceClass_t;
@@ -164,17 +164,17 @@ typedef union uDrRange
164164
/*!
165165
* Minimum data rate
166166
*
167-
* EU868 - [DR_0, DR_1, DR_2, DR_3, DR_4, DR_5, DR_6, DR_7]
167+
* LoRaWAN Regional Parameters V1.0.2rB
168168
*
169-
* US915 - [DR_0, DR_1, DR_2, DR_3, DR_4]
169+
* The allowed ranges are region specific. Please refer to \ref DR_0 to \ref DR_15 for details.
170170
*/
171171
int8_t Min : 4;
172172
/*!
173173
* Maximum data rate
174174
*
175-
* EU868 - [DR_0, DR_1, DR_2, DR_3, DR_4, DR_5, DR_6, DR_7]
175+
* LoRaWAN Regional Parameters V1.0.2rB
176176
*
177-
* US915 - [DR_0, DR_1, DR_2, DR_3, DR_4]
177+
* The allowed ranges are region specific. Please refer to \ref DR_0 to \ref DR_15 for details.
178178
*/
179179
int8_t Max : 4;
180180
}Fields;
@@ -242,9 +242,9 @@ typedef struct sRx2ChannelParams
242242
/*!
243243
* Data rate
244244
*
245-
* EU868 - [DR_0, DR_1, DR_2, DR_3, DR_4, DR_5, DR_6, DR_7]
245+
* LoRaWAN Regional Parameters V1.0.2rB
246246
*
247-
* US915 - [DR_8, DR_9, DR_10, DR_11, DR_12, DR_13]
247+
* The allowed ranges are region specific. Please refer to \ref DR_0 to \ref DR_15 for details.
248248
*/
249249
uint8_t Datarate;
250250
}Rx2ChannelParams_t;
@@ -1764,18 +1764,10 @@ LoRaMacStatus_t LoRaMacQueryTxPossible( uint8_t size, LoRaMacTxInfo_t* txInfo );
17641764
* \brief LoRaMAC channel add service
17651765
*
17661766
* \details Adds a new channel to the channel list and activates the id in
1767-
* the channel mask. For the US915 band, all channels are enabled
1768-
* by default. Please note that this functionality is not available
1769-
* on all regions.
1770-
*
1771-
* \param [IN] id - Id of the channel. Possible values are:
1772-
*
1773-
* 0-15 for EU868
1774-
* 0-15 for CN779
1775-
* 0-15 for EU433
1776-
* 0-15 for AS923
1777-
* 0-15 for KR920
1778-
* 0-15 for IN865
1767+
* the channel mask. Please note that this functionality is not available
1768+
* on all regions. Information about allowed ranges are available at the LoRaWAN Regional Parameters V1.0.2rB
1769+
*
1770+
* \param [IN] id - Id of the channel.
17791771
*
17801772
* \param [IN] params - Channel parameters to set.
17811773
*

0 commit comments

Comments
 (0)