@@ -32,7 +32,7 @@ namespace mbed {
32
32
*
33
33
* Example
34
34
* @code
35
- * // Fade a led on .
35
+ * // Gradually change the intensity of the LED .
36
36
* #include "mbed.h"
37
37
*
38
38
* PwmOut led(LED1);
@@ -118,8 +118,8 @@ class PwmOut {
118
118
core_util_critical_section_exit ();
119
119
}
120
120
121
- /* * Set the PWM period, specified in milli-seconds (int), keeping the duty cycle the same.
122
- * @param ms Change the period of a PWM signal in milli-seconds without modifying the duty cycle
121
+ /* * Set the PWM period, specified in milliseconds (int), keeping the duty cycle the same.
122
+ * @param ms Change the period of a PWM signal in milliseconds without modifying the duty cycle
123
123
*/
124
124
void period_ms (int ms)
125
125
{
@@ -128,8 +128,8 @@ class PwmOut {
128
128
core_util_critical_section_exit ();
129
129
}
130
130
131
- /* * Set the PWM period, specified in micro-seconds (int), keeping the duty cycle the same.
132
- * @param us Change the period of a PWM signal in micro-seconds without modifying the duty cycle
131
+ /* * Set the PWM period, specified in microseconds (int), keeping the duty cycle the same.
132
+ * @param us Change the period of a PWM signal in microseconds without modifying the duty cycle
133
133
*/
134
134
void period_us (int us)
135
135
{
@@ -148,8 +148,8 @@ class PwmOut {
148
148
core_util_critical_section_exit ();
149
149
}
150
150
151
- /* * Set the PWM pulsewidth, specified in milli-seconds (int), keeping the period the same.
152
- * @param ms Change the pulse width of a PWM signal specified in milli-seconds
151
+ /* * Set the PWM pulsewidth, specified in milliseconds (int), keeping the period the same.
152
+ * @param ms Change the pulse width of a PWM signal specified in milliseconds
153
153
*/
154
154
void pulsewidth_ms (int ms)
155
155
{
@@ -158,8 +158,8 @@ class PwmOut {
158
158
core_util_critical_section_exit ();
159
159
}
160
160
161
- /* * Set the PWM pulsewidth, specified in micro-seconds (int), keeping the period the same.
162
- * @param us Change the pulse width of a PWM signal specified in micro-seconds
161
+ /* * Set the PWM pulsewidth, specified in microseconds (int), keeping the period the same.
162
+ * @param us Change the pulse width of a PWM signal specified in microseconds
163
163
*/
164
164
void pulsewidth_us (int us)
165
165
{
@@ -197,6 +197,7 @@ class PwmOut {
197
197
return read ();
198
198
}
199
199
200
+ #if !(DOXYGEN_ONLY)
200
201
protected:
201
202
/* * Lock deep sleep only if it is not yet locked */
202
203
void lock_deep_sleep ()
@@ -219,6 +220,7 @@ class PwmOut {
219
220
pwmout_t _pwm;
220
221
bool _deep_sleep_locked;
221
222
};
223
+ #endif
222
224
223
225
} // namespace mbed
224
226
0 commit comments