staging: iio: frequency: remove incorrect kernel-doc markings in dds.h

Browse source

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 4851d97d87 ("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>
Signed-off-by: Jonathan Cameron <jonathan.cameron@oss.qualcomm.com>

...

This commit is contained in:

Babanpreet Singh 2026-07-12 22:30:04 +00:00 • committed by Jonathan Cameron

parent deb9d74056

commit 036d96ceec

1 changed files with 13 additions and 13 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download patch file Download diff file Expand all files Collapse all files

26

drivers/staging/iio/frequency/dds.h

View file