github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-09-23 22:14:03 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

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 Stats Download Patch File Download Diff File Expand all files Collapse all files

26
drivers/staging/iio/frequency/dds.h
View File

@ -7,7 +7,7 @@
#ifndef IIO_DDS_H_
#define IIO_DDS_H_
/**
/*
* /sys/bus/iio/devices/.../out_altvoltageX_frequencyY
*/
@ -15,14 +15,14 @@
IIO_DEVICE_ATTR(out_altvoltage##_channel##_frequency##_num, \
_mode, _show, _store, _addr)
/**
/*
* /sys/bus/iio/devices/.../out_altvoltageX_frequencyY_scale
*/
#define IIO_CONST_ATTR_FREQ_SCALE(_channel, _string) \
IIO_CONST_ATTR(out_altvoltage##_channel##_frequency_scale, _string)
/**
/*
* /sys/bus/iio/devices/.../out_altvoltageX_frequencysymbol
*/
@ -30,7 +30,7 @@
IIO_DEVICE_ATTR(out_altvoltage##_channel##_frequencysymbol, \
_mode, _show, _store, _addr)
/**
/*
* /sys/bus/iio/devices/.../out_altvoltageX_phaseY
*/
@ -38,14 +38,14 @@
IIO_DEVICE_ATTR(out_altvoltage##_channel##_phase##_num, \
_mode, _show, _store, _addr)
/**
/*
* /sys/bus/iio/devices/.../out_altvoltageX_phaseY_scale
*/
#define IIO_CONST_ATTR_PHASE_SCALE(_channel, _string) \
IIO_CONST_ATTR(out_altvoltage##_channel##_phase_scale, _string)
/**
/*
* /sys/bus/iio/devices/.../out_altvoltageX_phasesymbol
*/
@ -53,7 +53,7 @@
IIO_DEVICE_ATTR(out_altvoltage##_channel##_phasesymbol, \
_mode, _show, _store, _addr)
/**
/*
* /sys/bus/iio/devices/.../out_altvoltageX_pincontrol_en
*/
@ -61,7 +61,7 @@
IIO_DEVICE_ATTR(out_altvoltage##_channel##_pincontrol_en, \
_mode, _show, _store, _addr)
/**
/*
* /sys/bus/iio/devices/.../out_altvoltageX_pincontrol_frequency_en
*/
@ -69,7 +69,7 @@
IIO_DEVICE_ATTR(out_altvoltage##_channel##_pincontrol_frequency_en,\
_mode, _show, _store, _addr)
/**
/*
* /sys/bus/iio/devices/.../out_altvoltageX_pincontrol_phase_en
*/
@ -77,7 +77,7 @@
IIO_DEVICE_ATTR(out_altvoltage##_channel##_pincontrol_phase_en, \
_mode, _show, _store, _addr)
/**
/*
* /sys/bus/iio/devices/.../out_altvoltageX_out_enable
*/
@ -85,7 +85,7 @@
IIO_DEVICE_ATTR(out_altvoltage##_channel##_out_enable, \
_mode, _show, _store, _addr)
/**
/*
* /sys/bus/iio/devices/.../out_altvoltageX_outY_enable
*/
@ -94,7 +94,7 @@
IIO_DEVICE_ATTR(out_altvoltage##_channel##_out##_output##_enable,\
_mode, _show, _store, _addr)
/**
/*
* /sys/bus/iio/devices/.../out_altvoltageX_outY_wavetype
*/
@ -102,7 +102,7 @@
IIO_DEVICE_ATTR(out_altvoltage##_channel##_out##_output##_wavetype,\
_mode, NULL, _store, _addr)
/**
/*
* /sys/bus/iio/devices/.../out_altvoltageX_outY_wavetype_available
*/