Skip to content

Commit f952ec6

Browse files
committed
Exclude unwanted symbols from documentation
1 parent d3848b0 commit f952ec6

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

src/Arduino_LowPowerPortentaH7.h

+14-4
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,14 @@ enum class LowPowerReturnCode
6868
/**
6969
* @brief The LowPowerStandbyType class represents different types of standby modes for low power operation.
7070
*
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.
7375
*/
7476
class LowPowerStandbyType {
7577
public:
78+
/// @cond DEV
7679
/**
7780
* @brief A class representing the condition that waits until a pin changes its state.
7881
*
@@ -81,6 +84,7 @@ class LowPowerStandbyType {
8184
*/
8285
class UntilPinActivityClass {
8386
};
87+
/// @endcond
8488

8589
/**
8690
* @brief Represents a wakeup option which waits until a pin activity occurs.
@@ -89,6 +93,7 @@ class LowPowerStandbyType {
8993
*/
9094
static const UntilPinActivityClass untilPinActivity;
9195

96+
/// @cond DEV
9297
/**
9398
* @brief A class representing a time elapsed condition.
9499
*
@@ -97,6 +102,7 @@ class LowPowerStandbyType {
97102
*/
98103
class UntilTimeElapsedClass {
99104
};
105+
/// @endcond
100106

101107
/**
102108
* @brief Represents a wakeup option which waits until a specified time has elapsed.
@@ -105,12 +111,14 @@ class LowPowerStandbyType {
105111

106112
private:
107113

114+
/// @cond DEV
108115
/**
109116
* @brief Represents a wakeup option which waits until either
110117
* a pin activity occurs or a specified time has elapsed.
111118
*/
112119
class UntilEitherClass {
113120
};
121+
/// @endcond
114122

115123
friend LowPowerStandbyType::UntilEitherClass operator|(
116124
const LowPowerStandbyType::UntilPinActivityClass& untilPinActivity,
@@ -226,6 +234,8 @@ class LowPowerPortentaH7 {
226234
}
227235

228236
public:
237+
238+
/// @cond DEV
229239
/**
230240
* Returns the singleton instance of the LowPowerPortentaH7 class.
231241
* Due to the way the low power modes are configured, only one instance
@@ -238,7 +248,6 @@ class LowPowerPortentaH7 {
238248
return instance;
239249
}
240250

241-
/// @cond DEV
242251
LowPowerPortentaH7(const LowPowerPortentaH7&) = delete;
243252
LowPowerPortentaH7(LowPowerPortentaH7&&) = delete;
244253

@@ -315,7 +324,8 @@ class LowPowerPortentaH7 {
315324

316325
/**
317326
* @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.
319329
* @param args The delay before waking up again
320330
* @return A constant from the LowPowerReturnCode enum.
321331
*/

0 commit comments

Comments
 (0)