Re: [PATCH] staging: iio: frequency: remove incorrect kernel-doc markings in dds.h

[Jonathan Cameron <jic23@kernel.org>]

On Sun, 12 Jul 2026 22:30:04 +0000
Babanpreet Singh <bbnpreetsingh@gmail.com> wrote:

> The 13 comment blocks in dds.h noting which sysfs attribute each
> convenience macro creates are opened with the kernel-doc /** marker,
> but they are not kernel-doc: there is no identifier to document.
> Running kernel-doc on the file emits 103 warnings:
> 
>   $ scripts/kernel-doc -none drivers/staging/iio/frequency/dds.h
>   Warning: drivers/staging/iio/frequency/dds.h:10 Cannot find
>   identifier on line:
>    * /sys/bus/iio/devices/.../out_altvoltageX_frequencyY
> 
> The header is not scanned during normal builds (build-time kernel-doc
> checks cover .c files), so the warnings only show up when kernel-doc
> is invoked on the file directly.
> 
> The comments have carried the /** marker since the file was introduced
> in commit 4851d97d87c8 ("Staging: IIO: dds.h convenience macros"). The
> attributes themselves are already documented in
> drivers/staging/iio/Documentation/sysfs-bus-iio-dds, so demote the
> comments to plain /* style rather than converting them into kernel-doc
> for the macros. No functional change.
> 
> Assisted-by: Claude:claude-sonnet-5
> Signed-off-by: Babanpreet Singh <bbnpreetsingh@gmail.com>
Applied.

Thanks,

Jonathan