Skip to content

PwmOut.h: Documentation improvements only #8412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 19, 2018
Merged

PwmOut.h: Documentation improvements only #8412

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions drivers/PwmOut.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ namespace mbed {
*
* Example
* @code
* // Fade a led on.
* // Gradually change the intensity of the LED.
* #include "mbed.h"
*
* PwmOut led(LED1);
Expand Down Expand Up @@ -118,8 +118,8 @@ class PwmOut {
core_util_critical_section_exit();
}

/** Set the PWM period, specified in milli-seconds (int), keeping the duty cycle the same.
* @param ms Change the period of a PWM signal in milli-seconds without modifying the duty cycle
/** Set the PWM period, specified in milliseconds (int), keeping the duty cycle the same.
* @param ms Change the period of a PWM signal in milliseconds without modifying the duty cycle
*/
void period_ms(int ms)
{
Expand All @@ -128,8 +128,8 @@ class PwmOut {
core_util_critical_section_exit();
}

/** Set the PWM period, specified in micro-seconds (int), keeping the duty cycle the same.
* @param us Change the period of a PWM signal in micro-seconds without modifying the duty cycle
/** Set the PWM period, specified in microseconds (int), keeping the duty cycle the same.
* @param us Change the period of a PWM signal in microseconds without modifying the duty cycle
*/
void period_us(int us)
{
Expand All @@ -148,8 +148,8 @@ class PwmOut {
core_util_critical_section_exit();
}

/** Set the PWM pulsewidth, specified in milli-seconds (int), keeping the period the same.
* @param ms Change the pulse width of a PWM signal specified in milli-seconds
/** Set the PWM pulsewidth, specified in milliseconds (int), keeping the period the same.
* @param ms Change the pulse width of a PWM signal specified in milliseconds
*/
void pulsewidth_ms(int ms)
{
Expand All @@ -158,8 +158,8 @@ class PwmOut {
core_util_critical_section_exit();
}

/** Set the PWM pulsewidth, specified in micro-seconds (int), keeping the period the same.
* @param us Change the pulse width of a PWM signal specified in micro-seconds
/** Set the PWM pulsewidth, specified in microseconds (int), keeping the period the same.
* @param us Change the pulse width of a PWM signal specified in microseconds
*/
void pulsewidth_us(int us)
{
Expand Down Expand Up @@ -197,6 +197,7 @@ class PwmOut {
return read();
}

#if !(DOXYGEN_ONLY)
protected:
/** Lock deep sleep only if it is not yet locked */
void lock_deep_sleep()
Expand All @@ -219,6 +220,7 @@ class PwmOut {
pwmout_t _pwm;
bool _deep_sleep_locked;
};
#endif

} // namespace mbed

Expand Down