Skip to content

Commit a6a2852

Browse files
committed
Documentation improvements only
- Prevent protected attributes from appearing on docs site. - Standardize units of time (microsecond, millisecond). - Improve example description.
1 parent c356f1f commit a6a2852

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

drivers/PwmOut.h

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ namespace mbed {
3232
*
3333
* Example
3434
* @code
35-
* // Fade a led on.
35+
* // Gradually change the intensity of the LED.
3636
* #include "mbed.h"
3737
*
3838
* PwmOut led(LED1);
@@ -118,8 +118,8 @@ class PwmOut {
118118
core_util_critical_section_exit();
119119
}
120120

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
123123
*/
124124
void period_ms(int ms)
125125
{
@@ -128,8 +128,8 @@ class PwmOut {
128128
core_util_critical_section_exit();
129129
}
130130

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
133133
*/
134134
void period_us(int us)
135135
{
@@ -148,8 +148,8 @@ class PwmOut {
148148
core_util_critical_section_exit();
149149
}
150150

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
153153
*/
154154
void pulsewidth_ms(int ms)
155155
{
@@ -158,8 +158,8 @@ class PwmOut {
158158
core_util_critical_section_exit();
159159
}
160160

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
163163
*/
164164
void pulsewidth_us(int us)
165165
{
@@ -197,6 +197,7 @@ class PwmOut {
197197
return read();
198198
}
199199

200+
#if !(DOXYGEN_ONLY)
200201
protected:
201202
/** Lock deep sleep only if it is not yet locked */
202203
void lock_deep_sleep()
@@ -219,6 +220,7 @@ class PwmOut {
219220
pwmout_t _pwm;
220221
bool _deep_sleep_locked;
221222
};
223+
#endif
222224

223225
} // namespace mbed
224226

0 commit comments

Comments
 (0)