From: Babanpreet Singh <bbnpreetsingh@gmail.com>
To: Jonathan Cameron <jic23@kernel.org>
Cc: "David Lechner" <dlechner@baylibre.com>,
"Nuno Sá" <nuno.sa@analog.com>,
"Andy Shevchenko" <andy@kernel.org>,
"Greg Kroah-Hartman" <gregkh@linuxfoundation.org>,
linux-iio@vger.kernel.org, linux-staging@lists.linux.dev,
linux-kernel@vger.kernel.org,
"Babanpreet Singh" <bbnpreetsingh@gmail.com>
Subject: [PATCH] staging: iio: frequency: remove incorrect kernel-doc markings in dds.h
Date: Sun, 12 Jul 2026 22:30:04 +0000 [thread overview]
Message-ID: <20260712223004.7-1-bbnpreetsingh@gmail.com> (raw)
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>
---
drivers/staging/iio/frequency/dds.h | 26 +++++++++++++-------------
1 file changed, 13 insertions(+), 13 deletions(-)
diff --git a/drivers/staging/iio/frequency/dds.h b/drivers/staging/iio/frequency/dds.h
index b2ca8bb971e8..d5f0139b79f0 100644
--- a/drivers/staging/iio/frequency/dds.h
+++ b/drivers/staging/iio/frequency/dds.h
@@ -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
*/
base-commit: 2e2f2de7532cbbc2269de8be20ec709606c6e79b
--
2.43.0
next reply other threads:[~2026-07-12 22:30 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-07-12 22:30 Babanpreet Singh [this message]
2026-07-13 0:35 ` [PATCH] staging: iio: frequency: remove incorrect kernel-doc markings in dds.h Jonathan Cameron
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260712223004.7-1-bbnpreetsingh@gmail.com \
--to=bbnpreetsingh@gmail.com \
--cc=andy@kernel.org \
--cc=dlechner@baylibre.com \
--cc=gregkh@linuxfoundation.org \
--cc=jic23@kernel.org \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-staging@lists.linux.dev \
--cc=nuno.sa@analog.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.