[PATCH][DRM] Tweak DRM-related kernel-doc content to get rid of warnings.

Robert P. J. Day rpjday at crashcourse.ca
Thu May 2 07:08:37 PDT 2013


Fix kernel-doc content to suppress warnings. No functional change.

Signed-off-by: Robert P. J. Day <rpjday at crashcourse.ca>

---

  someone is welcome to peruse this and tweak it further if they wish.
this gets rid of all of the DRM-related kerneldoc warnings.

diff --git a/drivers/gpu/drm/drm_edid.c b/drivers/gpu/drm/drm_edid.c
index e2acfdb..7591e70 100644
--- a/drivers/gpu/drm/drm_edid.c
+++ b/drivers/gpu/drm/drm_edid.c
@@ -982,14 +982,15 @@ EXPORT_SYMBOL(drm_edid_is_valid);

 #define DDC_SEGMENT_ADDR 0x30
 /**
- * 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.
+ * drm_do_probe_ddc_edid - get EDID information via I2C.
+ * @adapter:	i2c device adaptor
+ * @buf:	EDID data buffer to be filled
+ * @block:	start block
+ * @len:	EDID data buffer length
  *
  * Try to fetch EDID information by calling i2c driver function.
+ *
+ * Return: 0 on success or -1 on failure.
  */
 static int
 drm_do_probe_ddc_edid(struct i2c_adapter *adapter, unsigned char *buf,
@@ -1128,10 +1129,11 @@ out:
 }

 /**
- * Probe DDC presence.
+ * drm_probe_ddc - probe DDC presence.
+ *
+ * @adapter: i2c device adaptor
  *
- * \param adapter : i2c device adaptor
- * \return 1 on success
+ * Return: 1 on success
  */
 bool
 drm_probe_ddc(struct i2c_adapter *adapter)
@@ -1455,8 +1457,10 @@ bad_std_timing(u8 a, u8 b)

 /**
  * drm_mode_std - convert standard mode info (width, height, refresh) into mode
+ * @connector: DRM connector
+ * @edid: EDID structure
  * @t: standard timing params
- * @timing_level: standard timing level
+ * @revision: revision
  *
  * Take the standard timing params (in this case width, aspect, and refresh)
  * and convert them into a real mode using CVT/GTF/DMT.
@@ -2001,6 +2005,7 @@ do_established_modes(struct detailed_timing *timing, void *c)

 /**
  * add_established_modes - get est. modes from EDID and add them
+ * @connector: DRM connector
  * @edid: EDID block to scan
  *
  * Each EDID block contains a bitmap of the supported "established modes" list
@@ -2063,6 +2068,7 @@ do_standard_modes(struct detailed_timing *timing, void *c)

 /**
  * add_standard_modes - get std. modes from EDID and add them
+ * @connector: DRM connector
  * @edid: EDID block to scan
  *
  * Standard modes can be calculated using the appropriate standard (DMT,
@@ -2232,7 +2238,8 @@ add_detailed_modes(struct drm_connector *connector, struct edid *edid,
 #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)
 {
@@ -2605,6 +2612,7 @@ EXPORT_SYMBOL(drm_detect_hdmi_monitor);

 /**
  * drm_detect_monitor_audio - check monitor audio capability
+ * @edid: EDID block to search
  *
  * Monitor should have CEA extension block.
  * If monitor has 'basic audio', but no CEA audio blocks, it's 'basic
@@ -2650,6 +2658,7 @@ EXPORT_SYMBOL(drm_detect_monitor_audio);

 /**
  * drm_rgb_quant_range_selectable - is RGB quantization range selectable?
+ * @edid: EDID block to search
  *
  * Check whether the monitor reports the RGB quantization range selection
  * as supported. The AVI infoframe can then be used to inform the monitor

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================


More information about the dri-devel mailing list