All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>,
	"Jonathan Corbet" <corbet@lwn.net>,
	"Mauro Carvalho Chehab" <mchehab+huawei@kernel.org>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Heikki Krogerus <heikki.krogerus@linux.intel.com>,
	linux-kernel@vger.kernel.org, linux-usb@vger.kernel.org
Subject: [PATCH 20/22] usb: typec_altmode: add a missing "@" at a kernel-doc parameter
Date: Tue, 28 Jun 2022 10:46:24 +0100	[thread overview]
Message-ID: <70dc4c5d744cf1fe9a0efe6b85deaa0489628282.1656409369.git.mchehab@kernel.org> (raw)
In-Reply-To: <cover.1656409369.git.mchehab@kernel.org>

Without that, the parameter is not properly parsed:
	include/linux/usb/typec_altmode.h:132: warning: Function parameter or member 'altmode' not described in 'typec_altmode_get_orientation'

Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
---

To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
See [PATCH 00/22] at: https://lore.kernel.org/all/cover.1656409369.git.mchehab@kernel.org/

 include/linux/usb/typec_altmode.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/usb/typec_altmode.h b/include/linux/usb/typec_altmode.h
index 65933cbe9129..350d49012659 100644
--- a/include/linux/usb/typec_altmode.h
+++ b/include/linux/usb/typec_altmode.h
@@ -124,7 +124,7 @@ struct typec_altmode *typec_match_altmode(struct typec_altmode **altmodes,
 
 /**
  * typec_altmode_get_orientation - Get cable plug orientation
- * altmode: Handle to the alternate mode
+ * @altmode: Handle to the alternate mode
  */
 static inline enum typec_orientation
 typec_altmode_get_orientation(struct typec_altmode *altmode)
-- 
2.36.1


  parent reply	other threads:[~2022-06-28  9:47 UTC|newest]

Thread overview: 64+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-06-28  9:46 [PATCH 00/22] Fix kernel-doc warnings at linux-next Mauro Carvalho Chehab
2022-06-28  9:46 ` Mauro Carvalho Chehab
2022-06-28  9:46 ` Mauro Carvalho Chehab
2022-06-28  9:46 ` [PATCH 01/22] net: cfg80211: fix kernel-doc warnings all over the file Mauro Carvalho Chehab
2022-06-28  9:46 ` [PATCH 02/22] net: mac80211: add a missing comma at kernel-doc markup Mauro Carvalho Chehab
2022-06-28 17:09   ` Jeff Johnson
2022-06-28  9:46 ` [PATCH 03/22] net: mac80211: sta_info: fix a missing kernel-doc struct element Mauro Carvalho Chehab
2022-06-28  9:46 ` [PATCH 04/22] x86/sgx: fix kernel-doc markups Mauro Carvalho Chehab
2022-06-29  2:34   ` Jarkko Sakkinen
2022-07-06 17:15   ` Dave Hansen
2022-06-28  9:46 ` [PATCH 05/22] fscache: fix kernel-doc documentation Mauro Carvalho Chehab
2022-06-28  9:46 ` [PATCH 06/22] fs: attr: update vfs uid/gid parameters at kernel-doc Mauro Carvalho Chehab
2022-06-28 10:17   ` Christian Brauner
2022-06-28  9:46 ` [PATCH 07/22] fs: namei: address some kernel-doc issues Mauro Carvalho Chehab
2022-06-28  9:46 ` [PATCH 08/22] devfreq: shut up kernel-doc warnings Mauro Carvalho Chehab
2022-06-29 19:31   ` Chanwoo Choi
2022-06-28  9:46 ` [PATCH 09/22] drm: amdgpu: amdgpu_dm: fix kernel-doc markups Mauro Carvalho Chehab
2022-06-28  9:46   ` Mauro Carvalho Chehab
2022-06-28  9:46   ` Mauro Carvalho Chehab
2022-06-28 14:36   ` Alex Deucher
2022-06-28 14:36     ` Alex Deucher
2022-06-28  9:46 ` [PATCH 10/22] drm: amdgpu: amdgpu_device.c: fix a kernel-doc markup Mauro Carvalho Chehab
2022-06-28  9:46   ` Mauro Carvalho Chehab
2022-06-28  9:46   ` Mauro Carvalho Chehab
2022-06-28 14:37   ` Alex Deucher
2022-06-28 14:37     ` Alex Deucher
2022-06-28 14:37     ` Alex Deucher
2022-06-28  9:46 ` [PATCH 11/22] drm: amd: amd_shared.h: Add missing doc for PP_GFX_DCS_MASK Mauro Carvalho Chehab
2022-06-28  9:46   ` Mauro Carvalho Chehab
2022-06-28  9:46   ` Mauro Carvalho Chehab
2022-06-28 14:38   ` Alex Deucher
2022-06-28 14:38     ` Alex Deucher
2022-06-28 14:38     ` Alex Deucher
2022-06-28  9:46 ` [PATCH 12/22] drm: gpu_scheduler: fix a kernel-doc warning Mauro Carvalho Chehab
2022-06-28  9:46   ` Mauro Carvalho Chehab
2022-06-28 14:42   ` Alex Deucher
2022-06-28 14:42     ` Alex Deucher
2022-06-28  9:46 ` [PATCH 13/22] drm: scheduler: add a missing kernel-doc parameter Mauro Carvalho Chehab
2022-06-28  9:46   ` Mauro Carvalho Chehab
2022-06-28 14:42   ` Alex Deucher
2022-06-28 14:42     ` Alex Deucher
2022-06-28  9:46 ` [PATCH 14/22] kfence: fix a " Mauro Carvalho Chehab
2022-06-28  9:46   ` Mauro Carvalho Chehab
2022-06-28  9:48   ` Marco Elver
2022-06-28  9:48     ` Marco Elver
2022-06-28  9:46 ` [PATCH 15/22] mm: document maple tree pointer at unmap_vmas() at memory.c Mauro Carvalho Chehab
2022-06-29  0:25   ` Liam Howlett
2022-06-28  9:46 ` [PATCH 16/22] genalloc: add a description for start_addr parameter Mauro Carvalho Chehab
2022-06-28  9:46 ` [PATCH 17/22] textsearch: document list inside struct ts_ops Mauro Carvalho Chehab
2022-06-28  9:46 ` [PATCH 18/22] regulator: fix a kernel-doc warning Mauro Carvalho Chehab
2022-06-28 10:35   ` Mark Brown
2022-06-28 11:07     ` Mauro Carvalho Chehab
2022-06-28 11:11       ` Mark Brown
2022-06-28  9:46 ` [PATCH 19/22] dcache: " Mauro Carvalho Chehab
2022-06-28  9:46 ` Mauro Carvalho Chehab [this message]
2022-06-28  9:55   ` [PATCH 20/22] usb: typec_altmode: add a missing "@" at a kernel-doc parameter Heikki Krogerus
2022-06-28  9:46 ` [PATCH 21/22] usb: dwc3: document async_callbacks field Mauro Carvalho Chehab
2022-06-28  9:46 ` [PATCH 22/22] usb: dwc3: gadget: fix a kernel-doc warning Mauro Carvalho Chehab
2022-06-28 13:10 ` (subset) [PATCH 00/22] Fix kernel-doc warnings at linux-next Mark Brown
2022-06-28 13:10   ` Mark Brown
2022-06-28 13:10   ` Mark Brown
2022-06-29  3:23 ` Bagas Sanjaya
2022-06-29  3:23   ` Bagas Sanjaya
2022-06-29  3:23   ` Bagas Sanjaya

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=70dc4c5d744cf1fe9a0efe6b85deaa0489628282.1656409369.git.mchehab@kernel.org \
    --to=mchehab@kernel.org \
    --cc=corbet@lwn.net \
    --cc=gregkh@linuxfoundation.org \
    --cc=heikki.krogerus@linux.intel.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-usb@vger.kernel.org \
    --cc=mchehab+huawei@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 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.