From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: "André Almeida" <andrealmeid@collabora.com>
Cc: linux-media@vger.kernel.org, hverkuil@xs4all.nl,
helen.koike@collabora.com, kernel@collabora.com,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH v3 1/2] media: vimc: stream: add missing function documentation
Date: Sat, 22 Jun 2019 18:58:44 -0300 [thread overview]
Message-ID: <20190622185844.4b2392a3@coco.lan> (raw)
In-Reply-To: <c9602b72-7dbb-47ad-97ef-9348d7e1c3e9@collabora.com>
Em Sat, 22 Jun 2019 18:51:06 -0300
André Almeida <andrealmeid@collabora.com> escreveu:
> Hello Mauro,
>
> On 6/21/19 6:17 PM, Mauro Carvalho Chehab wrote:
> > Em Mon, 17 Jun 2019 10:32:20 -0300
> > André Almeida <andrealmeid@collabora.com> escreveu:
> >
> >> Add comments at vimc_streamer_s_stream and vimc_streamer_thread, making
> >> the vimc-stream totally documented.
> > I'm applying it right now.
> >
> > Yet, if this is fully documented, IMO you should add it to
> > Documentation/media/v4l-drivers, replacing the comments to kernel-doc
> > markups.
>
> This suggestion is a great improvement and it's simple to apply to the
> source. Where do you believe we can place this at[1]? Maybe something like
>
>
> Source code documentation
> -------------------------
>
> vimc-streamer
> ~~~~~~~~~~~~
>
> .. kernel-doc:: drivers/media/platform/vimc/vimc-streamer.c
> :internal:
>
>
> at the end of the file?
>
Yeah, this should be enough.
> > That would make easier for the ones to read the comments and, if someone
> > changes a function call, warnings will be produced, and the developer
> > will be warned.
> > Thanks,
> > Mauro
>
> Thanks,
> André
>
> [1]
> https://git.linuxtv.org/media_tree.git/tree/Documentation/media/v4l-drivers/vimc.rst
>
Thanks,
Mauro
prev parent reply other threads:[~2019-06-22 21:58 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-06-17 13:32 [PATCH v3 1/2] media: vimc: stream: add missing function documentation André Almeida
2019-06-17 13:32 ` [PATCH v3 2/2] media: docs: create vimc documentation André Almeida
2019-06-21 21:17 ` [PATCH v3 1/2] media: vimc: stream: add missing function documentation Mauro Carvalho Chehab
2019-06-22 21:51 ` André Almeida
2019-06-22 21:58 ` Mauro Carvalho Chehab [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=20190622185844.4b2392a3@coco.lan \
--to=mchehab+samsung@kernel.org \
--cc=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 \
/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).