linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Tobin C. Harding" <me@tobin.cc>
To: Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Jiri Slaby <jslaby@suse.com>
Cc: "Tobin C. Harding" <me@tobin.cc>,
	linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org
Subject: [PATCH 3/3] tty_port: Fix kernel-docs warnings
Date: Wed, 12 Sep 2018 17:50:44 +1000	[thread overview]
Message-ID: <20180912075044.8695-4-me@tobin.cc> (raw)
In-Reply-To: <20180912075044.8695-1-me@tobin.cc>

Currently extracting the kernel-docs causes a six warnings of type

  warning: Function parameter or member 'foo' not described in 'bar'

Add function parameter descriptions to the function kernel-docs.

Signed-off-by: Tobin C. Harding <me@tobin.cc>
---
 drivers/tty/tty_port.c | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/drivers/tty/tty_port.c b/drivers/tty/tty_port.c
index 382282013c9d..2444ed90b93d 100644
--- a/drivers/tty/tty_port.c
+++ b/drivers/tty/tty_port.c
@@ -622,6 +622,9 @@ EXPORT_SYMBOL(tty_port_close_end);
 
 /**
  * tty_port_close()
+ * @port: tty port
+ * @tty: the tty
+ * @filp: the file pointer
  *
  * Caller holds tty lock
  */
@@ -657,6 +660,9 @@ EXPORT_SYMBOL_GPL(tty_port_install);
 
 /**
  * tty_port_open()
+ * @port: tty port
+ * @tty: the tty
+ * @filp: the file pointer
  *
  * Caller holds tty lock.
  *
-- 
2.17.1


  parent reply	other threads:[~2018-09-12  7:51 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-09-12  7:50 [PATCH 0/3] ttp_port: Clean up kernel-docs Tobin C. Harding
2018-09-12  7:50 ` [PATCH 1/3] tty_port: Remove incorrect whitespace after comments Tobin C. Harding
2018-09-12  7:50 ` [PATCH 2/3] tty_port: Fix function name and brief desc Tobin C. Harding
2018-09-12  9:31   ` Johan Hovold
2018-09-12 21:08     ` Tobin C. Harding
2018-09-18 13:37   ` Greg Kroah-Hartman
2018-09-12  7:50 ` Tobin C. Harding [this message]
2018-09-18 13:38   ` [PATCH 3/3] tty_port: Fix kernel-docs warnings Greg Kroah-Hartman
2018-09-18 22:02     ` Tobin C. Harding
2018-09-19  5:15       ` Greg Kroah-Hartman

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=20180912075044.8695-4-me@tobin.cc \
    --to=me@tobin.cc \
    --cc=gregkh@linuxfoundation.org \
    --cc=jslaby@suse.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@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).