linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	Jonathan Cameron <jic23@kernel.org>,
	Hartmut Knaack <knaack.h@gmx.de>,
	Lars-Peter Clausen <lars@metafoo.de>,
	Peter Meerwald-Stadler <pmeerw@pmeerw.net>,
	linux-iio@vger.kernel.org
Subject: [PATCH 15/18] iio: iio.h: use nested struct support on kernel-doc markup
Date: Mon,  7 May 2018 06:35:51 -0300	[thread overview]
Message-ID: <1a31240699b1b6ee089b5b36889ab27ae14ad94e.1525684985.git.mchehab+samsung@kernel.org> (raw)
In-Reply-To: <cover.1525684985.git.mchehab+samsung@kernel.org>
In-Reply-To: <cover.1525684985.git.mchehab+samsung@kernel.org>

Solve those Sphinx warnings:

    ./include/linux/iio/iio.h:270: warning: Function parameter or member 'scan_type.sign' not described in 'iio_chan_spec'
    ./include/linux/iio/iio.h:270: warning: Function parameter or member 'scan_type.realbits' not described in 'iio_chan_spec'
    ./include/linux/iio/iio.h:270: warning: Function parameter or member 'scan_type.storagebits' not described in 'iio_chan_spec'
    ./include/linux/iio/iio.h:270: warning: Function parameter or member 'scan_type.shift' not described in 'iio_chan_spec'
    ./include/linux/iio/iio.h:270: warning: Function parameter or member 'scan_type.repeat' not described in 'iio_chan_spec'
    ./include/linux/iio/iio.h:270: warning: Function parameter or member 'scan_type.endianness' not described in 'iio_chan_spec'

    ./include/linux/iio/iio.h:191: WARNING: Unexpected indentation.
    ./include/linux/iio/iio.h:192: WARNING: Block quote ends without a blank line; unexpected unindent.
    ./include/linux/iio/iio.h:198: WARNING: Definition list ends without a blank line; unexpected unindent.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 include/linux/iio/iio.h | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

diff --git a/include/linux/iio/iio.h b/include/linux/iio/iio.h
index 11579fd4126e..a74cb177dc6f 100644
--- a/include/linux/iio/iio.h
+++ b/include/linux/iio/iio.h
@@ -183,18 +183,18 @@ struct iio_event_spec {
  * @address:		Driver specific identifier.
  * @scan_index:		Monotonic index to give ordering in scans when read
  *			from a buffer.
- * @scan_type:		sign:		's' or 'u' to specify signed or unsigned
- *			realbits:	Number of valid bits of data
- *			storagebits:	Realbits + padding
- *			shift:		Shift right by this before masking out
- *					realbits.
- *			repeat:		Number of times real/storage bits
- *					repeats. When the repeat element is
- *					more than 1, then the type element in
- *					sysfs will show a repeat value.
- *					Otherwise, the number of repetitions is
- *					omitted.
- *			endianness:	little or big endian
+ * @scan_type:		struct describing the scan type
+ * @scan_type.sign:		's' or 'u' to specify signed or unsigned
+ * @scan_type.realbits:		Number of valid bits of data
+ * @scan_type.storagebits:	Realbits + padding
+ * @scan_type.shift:		Shift right by this before masking out
+ *				realbits.
+ * @scan_type.repeat:		Number of times real/storage bits repeats.
+ *				When the repeat element is more than 1, then
+ *				the type element in sysfs will show a repeat
+ *				value. Otherwise, the number of repetitions
+ *				is omitted.
+ * @scan_type.endianness:	little or big endian
  * @info_mask_separate: What information is to be exported that is specific to
  *			this channel.
  * @info_mask_separate_available: What availability information is to be
-- 
2.17.0

  parent reply	other threads:[~2018-05-07  9:38 UTC|newest]

Thread overview: 87+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-05-07  9:35 [PATCH 00/18] Fix some build warnings/errors with Sphinx Mauro Carvalho Chehab
2018-05-07  9:35 ` [PATCH 01/18] docs: can.rst: fix a footnote reference Mauro Carvalho Chehab
2018-05-07 18:41   ` Oliver Hartkopp
2018-05-07  9:35 ` [PATCH 02/18] docs: fix location of request_firmware & friends Mauro Carvalho Chehab
2018-05-08  3:07   ` Greg Kroah-Hartman
2018-05-08 15:49   ` Luis R. Rodriguez
2018-05-09 12:26     ` Mauro Carvalho Chehab
2018-05-07  9:35 ` [PATCH 03/18] docs: */index.rst: Add newer documents to their respective index.rst Mauro Carvalho Chehab
2018-05-08  3:07   ` Greg Kroah-Hartman
2018-05-08 15:59   ` Jonathan Corbet
2018-05-07  9:35 ` [PATCH 04/18] docs: admin-guide: add bcache documentation Mauro Carvalho Chehab
2018-05-08 16:01   ` Jonathan Corbet
2018-05-07  9:35 ` [PATCH 05/18] docs: core-api: add cachetlb documentation Mauro Carvalho Chehab
2018-05-07 12:29   ` Andrea Parri
2018-05-08 14:40     ` Jani Nikula
2018-05-08 16:02       ` Andrea Parri
2018-05-08 16:28         ` Andrea Parri
2018-05-08 18:05       ` Mauro Carvalho Chehab
2018-05-08 18:28         ` Mauro Carvalho Chehab
2018-05-08 19:05           ` Andrea Parri
2018-05-08 16:04   ` Jonathan Corbet
2018-05-08 16:51     ` Andrea Parri
2018-05-07  9:35 ` [PATCH 06/18] docs: core-api: add cgroup-v2 documentation Mauro Carvalho Chehab
2018-05-08 15:51   ` Jonathan Corbet
2018-05-09 12:02     ` Mauro Carvalho Chehab
2018-05-07  9:35 ` [PATCH 07/18] docs: core-api: add circular-buffers documentation Mauro Carvalho Chehab
2018-05-07 12:31   ` Andrea Parri
2018-05-08 16:08   ` Jonathan Corbet
2018-05-07  9:35 ` [PATCH 08/18] docs: driver-api: add clk documentation Mauro Carvalho Chehab
2018-05-08  3:07   ` Greg Kroah-Hartman
2018-05-08 16:10   ` Jonathan Corbet
2018-05-07  9:35 ` [PATCH 09/18] net: mac80211.h: fix a bad comment line Mauro Carvalho Chehab
2018-05-07 12:37   ` Kalle Valo
2018-05-07 12:38     ` Johannes Berg
2018-05-09 12:04       ` Mauro Carvalho Chehab
2018-05-09 12:04         ` Johannes Berg
2018-05-07  9:35 ` [PATCH 10/18] rcu: rcupdate.h: get rid of Sphinx warnings at rcu_pointer_handoff() Mauro Carvalho Chehab
2018-05-07 14:23   ` Paul E. McKenney
2018-05-09 11:55     ` Mauro Carvalho Chehab
2018-05-14 19:40       ` Paul E. McKenney
2018-05-07  9:35 ` [PATCH 11/18] docs: crypto_engine.rst: Fix two parse warnings Mauro Carvalho Chehab
2018-05-07  9:35 ` [PATCH 12/18] time: timer.c: adjust a kernel-doc comment Mauro Carvalho Chehab
2018-05-13 14:00   ` [tip:timers/core] timers: Adjust " tip-bot for Mauro Carvalho Chehab
2018-05-07  9:35 ` [PATCH 13/18] wait: wait.h: Get rid of a kernel-doc/Sphinx warnings Mauro Carvalho Chehab
2018-05-09  8:41   ` Peter Zijlstra
2018-05-09 14:45     ` Jonathan Corbet
2018-05-09 15:20       ` Peter Zijlstra
2018-05-09 18:35         ` Jonathan Corbet
2018-05-09 18:50           ` Markus Heiser
2018-05-09 19:31           ` Peter Zijlstra
2018-05-10 12:23       ` Andrea Parri
2018-05-10 13:15         ` Jonathan Corbet
2018-05-10 16:52           ` Andrea Parri
2018-05-10 17:45             ` Mauro Carvalho Chehab
2018-05-10  8:38   ` Christoph Hellwig
2018-05-10  9:38     ` Mauro Carvalho Chehab
2018-05-10 12:20       ` Peter Zijlstra
2018-05-10 13:04         ` Mauro Carvalho Chehab
2018-05-10 13:30       ` Jonathan Corbet
2018-05-10 13:31         ` Jonathan Corbet
2018-05-10 14:21         ` Mauro Carvalho Chehab
2018-05-10 15:38           ` Jonathan Corbet
2018-05-10 16:42             ` Mauro Carvalho Chehab
2018-05-10 17:14               ` Mauro Carvalho Chehab
2018-05-11  7:06               ` Markus Heiser
2018-05-07  9:35 ` [PATCH 14/18] fbdev: modedb.c: fix a kernel-doc markup Mauro Carvalho Chehab
2018-05-15 10:22   ` Bartlomiej Zolnierkiewicz
2018-05-07  9:35 ` Mauro Carvalho Chehab [this message]
2018-05-07 17:08   ` [PATCH 15/18] iio: iio.h: use nested struct support on " Jonathan Cameron
2018-05-09 12:00     ` Mauro Carvalho Chehab
2018-05-07  9:35 ` [PATCH 16/18] mtd: rawnand.h: use nested union kernel-doc markups Mauro Carvalho Chehab
2018-05-07  9:46   ` Boris Brezillon
2018-05-07 11:32     ` Mauro Carvalho Chehab
2018-05-09 12:02       ` Boris Brezillon
2018-05-09 12:10       ` Mauro Carvalho Chehab
2018-05-09 12:22         ` Boris Brezillon
2018-05-09 13:28           ` Mauro Carvalho Chehab
2018-05-09 15:56   ` Boris Brezillon
2018-05-07  9:35 ` [PATCH 17/18] docs: uio-howto.rst: use a code block to solve a warning Mauro Carvalho Chehab
2018-05-08  3:07   ` Greg Kroah-Hartman
2018-05-07  9:35 ` [PATCH 18/18] w1: w1_io.c: fix a kernel-doc warning Mauro Carvalho Chehab
2018-05-08 11:03   ` Evgeniy Polyakov
2018-05-09 12:32     ` Mauro Carvalho Chehab
2018-05-09 13:11       ` Jonathan Corbet
2018-05-10 10:37         ` Evgeniy Polyakov
2018-05-08 16:13 ` [PATCH 00/18] Fix some build warnings/errors with Sphinx Jonathan Corbet
2018-05-08 17:36   ` Luis R. Rodriguez

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=1a31240699b1b6ee089b5b36889ab27ae14ad94e.1525684985.git.mchehab+samsung@kernel.org \
    --to=mchehab+samsung@kernel.org \
    --cc=corbet@lwn.net \
    --cc=jic23@kernel.org \
    --cc=knaack.h@gmx.de \
    --cc=lars@metafoo.de \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@infradead.org \
    --cc=pmeerw@pmeerw.net \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).