@@ -68,11 +68,14 @@ enum class LowPowerReturnCode
68
68
/* *
69
69
* @brief The LowPowerStandbyType class represents different types of standby modes for low power operation.
70
70
*
71
- * This class provides options for standby modes: waiting until pin activity or until a specified time has elapsed.
72
- * It also allows to combine the two options.
71
+ * This class provides options for the following standby modes: waiting until pin activity
72
+ * or until a specified time has elapsed, or both.
73
+ * Those are represented by LowPowerStandbyType::untilPinActivity and LowPowerStandbyType::untilTimeElapsed.
74
+ * To combine the two options use the | operator.
73
75
*/
74
76
class LowPowerStandbyType {
75
77
public:
78
+ // / @cond DEV
76
79
/* *
77
80
* @brief A class representing the condition that waits until a pin changes its state.
78
81
*
@@ -81,6 +84,7 @@ class LowPowerStandbyType {
81
84
*/
82
85
class UntilPinActivityClass {
83
86
};
87
+ // / @endcond
84
88
85
89
/* *
86
90
* @brief Represents a wakeup option which waits until a pin activity occurs.
@@ -89,6 +93,7 @@ class LowPowerStandbyType {
89
93
*/
90
94
static const UntilPinActivityClass untilPinActivity;
91
95
96
+ // / @cond DEV
92
97
/* *
93
98
* @brief A class representing a time elapsed condition.
94
99
*
@@ -97,6 +102,7 @@ class LowPowerStandbyType {
97
102
*/
98
103
class UntilTimeElapsedClass {
99
104
};
105
+ // / @endcond
100
106
101
107
/* *
102
108
* @brief Represents a wakeup option which waits until a specified time has elapsed.
@@ -105,12 +111,14 @@ class LowPowerStandbyType {
105
111
106
112
private:
107
113
114
+ // / @cond DEV
108
115
/* *
109
116
* @brief Represents a wakeup option which waits until either
110
117
* a pin activity occurs or a specified time has elapsed.
111
118
*/
112
119
class UntilEitherClass {
113
120
};
121
+ // / @endcond
114
122
115
123
friend LowPowerStandbyType::UntilEitherClass operator |(
116
124
const LowPowerStandbyType::UntilPinActivityClass& untilPinActivity,
@@ -226,6 +234,8 @@ class LowPowerPortentaH7 {
226
234
}
227
235
228
236
public:
237
+
238
+ // / @cond DEV
229
239
/* *
230
240
* Returns the singleton instance of the LowPowerPortentaH7 class.
231
241
* Due to the way the low power modes are configured, only one instance
@@ -238,7 +248,6 @@ class LowPowerPortentaH7 {
238
248
return instance;
239
249
}
240
250
241
- // / @cond DEV
242
251
LowPowerPortentaH7 (const LowPowerPortentaH7&) = delete ;
243
252
LowPowerPortentaH7 (LowPowerPortentaH7&&) = delete ;
244
253
@@ -315,7 +324,8 @@ class LowPowerPortentaH7 {
315
324
316
325
/* *
317
326
* @brief Make the M7 core enter Standby Mode.
318
- * @param standbyType One or a combination of LowPowerStandbyType::untilPinActivity and LowPowerStandbyType::untilTimeElapsed.
327
+ * @param standbyType One or a combination of LowPowerStandbyType::untilPinActivity
328
+ * and LowPowerStandbyType::untilTimeElapsed. The combination is done with the | operator.
319
329
* @param args The delay before waking up again
320
330
* @return A constant from the LowPowerReturnCode enum.
321
331
*/
0 commit comments