michaelh/zephyr
1
0
Fork 0
Code Releases Activity

drivers: pwm: fix doxygen docs

Browse source 
When referencing parameters, use @p and not @param.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2020-05-23 07:21:49 -04:00 • committed by Carles Cufí
commit 3e4cd1853e
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
include/drivers/pwm.h
View file

@ -60,9 +60,9 @@ __subsystem struct pwm_driver_api {
/**
* @brief Set the period and pulse width for a single PWM output.
*
* Passing 0 to the @param pulse will cause the pin to be driven to a constant
* Passing 0 to the @p pulse will cause the pin to be driven to a constant
* inactive level.
* Passing a @param pulse equal @param period will cause the pin to be driven
* Passing a @p pulse equal @p period will cause the pin to be driven
* to a constant active level.
*
* @param dev Pointer to the device structure for the driver instance.