All of lore.kernel.org
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: dri-devel@lists.freedesktop.org,
	Linus Torvalds <torvalds@linux-foundation.org>
Cc: David Airlie <airlied@linux.ie>, LKML <linux-kernel@vger.kernel.org>
Subject: [PATCH] drm: fix new kernel-doc warnings
Date: Tue, 05 Mar 2013 09:08:16 -0800	[thread overview]
Message-ID: <51362680.3030203@infradead.org> (raw)

From: Randy Dunlap <rdunlap@infradead.org>

Fix new kernel-doc warnings in drm_edid.c: convert doxygen(?) to
kernel-doc to match the rest of the file's documentation.

Warning(drivers/gpu/drm/drm_edid.c:997): No description found for parameter 'adapter'
Warning(drivers/gpu/drm/drm_edid.c:997): No description found for parameter 'buf'
Warning(drivers/gpu/drm/drm_edid.c:997): No description found for parameter 'block'
Warning(drivers/gpu/drm/drm_edid.c:997): No description found for parameter 'len'
Warning(drivers/gpu/drm/drm_edid.c:1138): No description found for parameter 'adapter'
Warning(drivers/gpu/drm/drm_edid.c:1467): No description found for parameter 'connector'
Warning(drivers/gpu/drm/drm_edid.c:1467): No description found for parameter 'edid'
Warning(drivers/gpu/drm/drm_edid.c:1467): No description found for parameter 'revision'
Warning(drivers/gpu/drm/drm_edid.c:1467): Excess function parameter 'timing_level' description in 'drm_mode_std'
Warning(drivers/gpu/drm/drm_edid.c:2010): No description found for parameter 'connector'
Warning(drivers/gpu/drm/drm_edid.c:2072): No description found for parameter 'connector'
Warning(drivers/gpu/drm/drm_edid.c:2237): No description found for parameter 'edid'
Warning(drivers/gpu/drm/drm_edid.c:2616): No description found for parameter 'edid'
Warning(drivers/gpu/drm/drm_edid.c:2658): No description found for parameter 'edid'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: David Airlie <airlied@linux.ie>
Cc: dri-devel@lists.freedesktop.org

---
 drivers/gpu/drm/drm_edid.c |   30 +++++++++++++++++++-----------
 1 file changed, 19 insertions(+), 11 deletions(-)

--- lnx-39-rc1.orig/drivers/gpu/drm/drm_edid.c
+++ lnx-39-rc1/drivers/gpu/drm/drm_edid.c
@@ -982,12 +982,13 @@ EXPORT_SYMBOL(drm_edid_is_valid);
 
 #define DDC_SEGMENT_ADDR 0x30
 /**
- * Get EDID information via I2C.
+ * drm_do_probe_ddc_edid - Get EDID information via I2C.
  *
- * \param adapter : i2c device adaptor
- * \param buf     : EDID data buffer to be filled
- * \param len     : EDID data buffer length
- * \return 0 on success or -1 on failure.
+ * @adapter : i2c device adaptor
+ * @buf     : EDID data buffer to be filled
+ * @block   : block number
+ * @len     : EDID data buffer length
+ * return   : 0 on success or -1 on failure.
  *
  * Try to fetch EDID information by calling i2c driver function.
  */
@@ -1128,10 +1129,10 @@ out:
 }
 
 /**
- * Probe DDC presence.
+ * drm_probe_ddc - Probe DDC presence.
  *
- * \param adapter : i2c device adaptor
- * \return 1 on success
+ * @adapter : i2c device adaptor
+ * return   : 1 on success
  */
 bool
 drm_probe_ddc(struct i2c_adapter *adapter)
@@ -1455,8 +1456,10 @@ bad_std_timing(u8 a, u8 b)
 
 /**
  * drm_mode_std - convert standard mode info (width, height, refresh) into mode
+ * @connector: attached connector
+ * @edid: EDID block
  * @t: standard timing params
- * @timing_level: standard timing level
+ * @revision: EDID revision
  *
  * Take the standard timing params (in this case width, aspect, and refresh)
  * and convert them into a real mode using CVT/GTF/DMT.
@@ -1999,7 +2002,8 @@ do_established_modes(struct detailed_tim
 }
 
 /**
- * add_established_modes - get est. modes from EDID and add them
+ * add_established_modes - get established modes from EDID and add them
+ * @connector: attached connector
  * @edid: EDID block to scan
  *
  * Each EDID block contains a bitmap of the supported "established modes" list
@@ -2062,6 +2066,7 @@ do_standard_modes(struct detailed_timing
 
 /**
  * add_standard_modes - get std. modes from EDID and add them
+ * @connector: attached connector
  * @edid: EDID block to scan
  *
  * Standard modes can be calculated using the appropriate standard (DMT,
@@ -2231,7 +2236,8 @@ add_detailed_modes(struct drm_connector
 #define EDID_CEA_VCDB_QS	(1 << 6)
 
 /**
- * Search EDID for CEA extension block.
+ * drm_find_cea_extension - Search EDID for CEA extension block.
+ * @edid: EDID block to search
  */
 u8 *drm_find_cea_extension(struct edid *edid)
 {
@@ -2604,6 +2610,7 @@ EXPORT_SYMBOL(drm_detect_hdmi_monitor);
 
 /**
  * drm_detect_monitor_audio - check monitor audio capability
+ * @edid: EDID block
  *
  * Monitor should have CEA extension block.
  * If monitor has 'basic audio', but no CEA audio blocks, it's 'basic
@@ -2649,6 +2656,7 @@ EXPORT_SYMBOL(drm_detect_monitor_audio);
 
 /**
  * drm_rgb_quant_range_selectable - is RGB quantization range selectable?
+ * @edid: EDID block
  *
  * Check whether the monitor reports the RGB quantization range selection
  * as supported. The AVI infoframe can then be used to inform the monitor

             reply	other threads:[~2013-03-05 17:08 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-03-05 17:08 Randy Dunlap [this message]
2013-03-06  4:28 ` [PATCH] drm: fix new kernel-doc warnings Rob Landley

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=51362680.3030203@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=airlied@linux.ie \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=torvalds@linux-foundation.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.