[Intel-gfx] [PATCH] lib/igt_kms: move gtk-doc comments next to the definition

Jani Nikula jani.nikula at intel.com
Tue May 17 11:44:13 UTC 2016


Now that we have actual functions for kms_test_*_str since

commit 2d432fc5773df17f04283f4780dab161dd2e1c85
Author: Jani Nikula <jani.nikula at intel.com>
Date:   Wed May 11 12:42:06 2016 +0300

    lib/igt_aux: define actual functions for kmstest_*_str

move also the gtk-doc comments next to the definitions, for consistency.

Acked-by: Daniel Vetter <daniel at ffwll.ch>
Signed-off-by: Jani Nikula <jani.nikula at intel.com>
---
 lib/igt_aux.c | 18 ++++++++++++++++++
 lib/igt_kms.h | 20 --------------------
 2 files changed, 18 insertions(+), 20 deletions(-)

diff --git a/lib/igt_aux.c b/lib/igt_aux.c
index 6c3eb1f42fab..27b74aec8461 100644
--- a/lib/igt_aux.c
+++ b/lib/igt_aux.c
@@ -942,6 +942,12 @@ static const struct type_name encoder_type_names[] = {
 	{}
 };
 
+/**
+ * kmstest_encoder_type_str:
+ * @type: DRM_MODE_ENCODER_* enumeration value
+ *
+ * Returns: A string representing the drm encoder @type.
+ */
 const char *kmstest_encoder_type_str(int type)
 {
 	return find_type_name(encoder_type_names, type);
@@ -954,6 +960,12 @@ static const struct type_name connector_status_names[] = {
 	{}
 };
 
+/**
+ * kmstest_connector_status_str:
+ * @status: DRM_MODE_* connector status value
+ *
+ * Returns: A string representing the drm connector status @status.
+ */
 const char *kmstest_connector_status_str(int status)
 {
 	return find_type_name(connector_status_names, status);
@@ -980,6 +992,12 @@ static const struct type_name connector_type_names[] = {
 	{}
 };
 
+/**
+ * kmstest_connector_type_str:
+ * @type: DRM_MODE_CONNECTOR_* enumeration value
+ *
+ * Returns: A string representing the drm connector @type.
+ */
 const char *kmstest_connector_type_str(int type)
 {
 	return find_type_name(connector_type_names, type);
diff --git a/lib/igt_kms.h b/lib/igt_kms.h
index 5c8340171ab6..7aad8c8c2153 100644
--- a/lib/igt_kms.h
+++ b/lib/igt_kms.h
@@ -77,28 +77,8 @@ enum port {
  */
 #define kmstest_port_name(port) ((port) + 'A')
 
-/**
- * kmstest_encoder_type_str:
- * @type: DRM_MODE_ENCODER_* enumeration value
- *
- * Returns: A string representing the drm encoder @type.
- */
 const char *kmstest_encoder_type_str(int type);
-
-/**
- * kmstest_connector_status_str:
- * @status: DRM_MODE_* connector status value
- *
- * Returns: A string representing the drm connector status @status.
- */
 const char *kmstest_connector_status_str(int status);
-
-/**
- * kmstest_connector_type_str:
- * @type: DRM_MODE_CONNECTOR_* enumeration value
- *
- * Returns: A string representing the drm connector @type.
- */
 const char *kmstest_connector_type_str(int type);
 
 void kmstest_dump_mode(drmModeModeInfo *mode);
-- 
2.1.4



More information about the Intel-gfx mailing list