From: "André Almeida" <andrealmeid@collabora.com>
To: linux-media@vger.kernel.org
Cc: mchehab@kernel.org, hverkuil@xs4all.nl,
helen.koike@collabora.com, kernel@collabora.com,
linux-kernel@vger.kernel.org,
"André Almeida" <andrealmeid@collabora.com>,
"Mauro Carvalho Chehab" <mchehab+samsung@kernel.org>
Subject: [PATCH 5/5] media: vimc.rst: add vimc-streamer source documentation
Date: Sun, 23 Jun 2019 13:40:24 -0300 [thread overview]
Message-ID: <20190623164024.9836-5-andrealmeid@collabora.com> (raw)
In-Reply-To: <20190623164024.9836-1-andrealmeid@collabora.com>
Since vimc-streamer.{c, h} are fully documented and conforming with the
kernel-doc syntax, add those files to vimc.rst
Signed-off-by: André Almeida <andrealmeid@collabora.com>
Suggested-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/media/v4l-drivers/vimc.rst | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/Documentation/media/v4l-drivers/vimc.rst b/Documentation/media/v4l-drivers/vimc.rst
index bece85867424..406417680db5 100644
--- a/Documentation/media/v4l-drivers/vimc.rst
+++ b/Documentation/media/v4l-drivers/vimc.rst
@@ -96,3 +96,14 @@ those arguments to each subdevice, not to the vimc module. For example::
Window size to calculate the mean. Note: the window size needs to be an
odd number, as the main pixel stays in the center of the window,
otherwise the next odd number is considered (the default value is 3).
+
+Source code documentation
+-------------------------
+
+vimc-streamer
+~~~~~~~~~~~~~
+
+.. kernel-doc:: drivers/media/platform/vimc/vimc-streamer.h
+ :internal:
+
+.. kernel-doc:: drivers/media/platform/vimc/vimc-streamer.c
--
2.22.0
prev parent reply other threads:[~2019-06-23 16:42 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-06-23 16:40 [PATCH 1/5] media: vimc: stream: remove obsolete function doc André Almeida
2019-06-23 16:40 ` [PATCH 2/5] media: vimc: stream: fix style of argument description André Almeida
2019-06-23 16:40 ` [PATCH 3/5] media: vimc: stream: format comments as kernel-doc André Almeida
2019-06-23 21:27 ` André Almeida
2019-06-24 9:40 ` Mauro Carvalho Chehab
2019-06-24 12:26 ` André Almeida
2019-06-23 16:40 ` [PATCH 4/5] media: vimc.rst: Add a proper alt attribute to vimc.dot André Almeida
2019-06-23 16:40 ` André Almeida [this message]
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=20190623164024.9836-5-andrealmeid@collabora.com \
--to=andrealmeid@collabora.com \
--cc=helen.koike@collabora.com \
--cc=hverkuil@xs4all.nl \
--cc=kernel@collabora.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--cc=mchehab+samsung@kernel.org \
--cc=mchehab@kernel.org \
/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).