Uwe Kleine-König <u.kleine-koenig@xxxxxxxxxxxx> writes: > Add Return and (where interesting) Context sections, fix some formatting > and drop documenting the internal function __pwm_apply(). > > Signed-off-by: Uwe Kleine-König <u.kleine-koenig@xxxxxxxxxxxx> > --- > Hello Jonathan, > > while looking into the warning that Stephen reported in > https://lore.kernel.org/linux-next/20250417162700.728e14e5@xxxxxxxxxxxxxxxx, > I found a few more issues fixed here. > > I intend to merge this via my pwm tree, but getting a confirmation (or critic) > from someone who knows kernel-doc better than me would be great. Seems generally fine, but ... > Best regards > Uwe > > drivers/pwm/core.c | 30 ++++++++++++++++++++++-------- > include/linux/pwm.h | 8 +++++--- > 2 files changed, 27 insertions(+), 11 deletions(-) > > diff --git a/drivers/pwm/core.c b/drivers/pwm/core.c > index 079964961bd8..447077776bce 100644 > --- a/drivers/pwm/core.c > +++ b/drivers/pwm/core.c > @@ -222,8 +222,10 @@ static int __pwm_write_waveform(struct pwm_chip *chip, struct pwm_device *pwm, c > * Note however that the world doesn't stop turning when you call it, so when > * doing > * > - * pwm_round_waveform_might_sleep(mypwm, &wf); > - * pwm_set_waveform_might_sleep(mypwm, &wf, true); > + * .. code-block:: C > + * > + * pwm_round_waveform_might_sleep(mypwm, &wf); > + * pwm_set_waveform_might_sleep(mypwm, &wf, true); Here I would just use an ordinary literal block rather than embedding Sphinx directives into the comment like that: * Note however that the world doesn't stop turning when you call it, so when * doing:: * * pwm_round_waveform_might_sleep(mypwm, &wf); * pwm_set_waveform_might_sleep(mypwm, &wf, true); Thanks, jon
