[igt-dev] [PATCH i-g-t 1/2] lib/igt_kms: Fix docbook warnings

[Maarten Lankhorst]

This gets rid of the following warnings:
lib/igt_kms.c:2688: warning: Symbol name not found at the start of the comment block.
lib/igt_kms.c:2738: warning: Symbol name not found at the start of the comment block.
lib/igt_kms.c:2788: warning: Symbol name not found at the start of the comment block.
lib/igt_kms.c:2812: warning: Parameter description for igt_pipe_obj_replace_prop_blob::pipe is not used from source code comment block.
lib/igt_kms.c:2812: warning: Parameter description for igt_pipe_obj_replace_prop_blob::pipe_obj is missing in source code comment block.
lib/igt_kms.c:3794: warning: Parameter description for igt_cleanup_hotplug::mon is missing in source code comment block.

Signed-off-by: Maarten Lankhorst <maarten.lankhorst at linux.intel.com>
---
 lib/igt_kms.c | 20 ++++++++++++--------
 lib/igt_kms.h |  2 +-
 2 files changed, 13 insertions(+), 9 deletions(-)

diff --git a/lib/igt_kms.c b/lib/igt_kms.c
index e14ecf3b155d..8c10eb5b67e9 100644
--- a/lib/igt_kms.c
+++ b/lib/igt_kms.c
@@ -361,9 +361,9 @@ int kmstest_pipe_to_index(char pipe)
 
 /**
  * kmstest_plane_type_name:
- * @plane: display plane
+ * @plane_type: display plane type
  *
- * Returns: String representing @plane, e.g. "overlay".
+ * Returns: String representing @plane_type, e.g. "overlay".
  */
 const char *kmstest_plane_type_name(int plane_type)
 {
@@ -2677,11 +2677,12 @@ static uint64_t igt_mode_object_get_prop(igt_display_t *display,
 }
 
 /**
- * igt_plane_get_prop - Return current value on a plane for a given property.
- *
+ * igt_plane_get_prop:
  * @plane: Target plane.
  * @prop: Property to check.
  *
+ * Return current value on a plane for a given property.
+ *
  * Returns: The value the property is set to, if this
  * is a blob, the blob id is returned. This can be passed
  * to drmModeGetPropertyBlob() to get the contents of the blob.
@@ -2727,11 +2728,12 @@ igt_plane_replace_prop_blob(igt_plane_t *plane, enum igt_atomic_plane_properties
 }
 
 /**
- * igt_output_get_prop - Return current value on an output for a given property.
- *
+ * igt_output_get_prop:
  * @output: Target output.
  * @prop: Property to return.
  *
+ * Return current value on an output for a given property.
+ *
  * Returns: The value the property is set to, if this
  * is a blob, the blob id is returned. This can be passed
  * to drmModeGetPropertyBlob() to get the contents of the blob.
@@ -2777,11 +2779,12 @@ igt_output_replace_prop_blob(igt_output_t *output, enum igt_atomic_connector_pro
 }
 
 /**
- * igt_pipe_obj_get_prop - Return current value on a pipe for a given property.
- *
+ * igt_pipe_obj_get_prop:
  * @pipe: Target pipe.
  * @prop: Property to return.
  *
+ * Return current value on a pipe for a given property.
+ *
  * Returns: The value the property is set to, if this
  * is a blob, the blob id is returned. This can be passed
  * to drmModeGetPropertyBlob() to get the contents of the blob.
@@ -3789,6 +3792,7 @@ void igt_flush_hotplugs(struct udev_monitor *mon)
 
 /**
  * igt_cleanup_hotplug:
+ * @mon: A udev monitor initialized with #igt_watch_hotplug
  *
  * Cleanup the resources allocated by #igt_watch_hotplug
  */
diff --git a/lib/igt_kms.h b/lib/igt_kms.h
index b75210393d3b..94e4619b4dd0 100644
--- a/lib/igt_kms.h
+++ b/lib/igt_kms.h
@@ -640,7 +640,7 @@ igt_pipe_has_prop(igt_display_t *display, enum pipe pipe,
 #define igt_pipe_set_prop_value(display, pipe, prop, value) \
 	igt_pipe_obj_set_prop_value(&(display)->pipes[(pipe)], prop, value)
 
-extern void igt_pipe_obj_replace_prop_blob(igt_pipe_t *pipe_obj,
+extern void igt_pipe_obj_replace_prop_blob(igt_pipe_t *pipe,
 					   enum igt_atomic_crtc_properties prop,
 					   const void *ptr, size_t length);
 
-- 
2.16.1