[PATCH v1 4/8] drm/print: add kernel-doc for drm_debug_enabled

[Sam Ravnborg]

Signed-off-by: Sam Ravnborg <sam at ravnborg.org>
Cc: Jani Nikula <jani.nikula at intel.com>
Cc: Sean Paul <sean at poorly.run>
Cc: Daniel Vetter <daniel at ffwll.ch>
---
 include/drm/drm_print.h | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/include/drm/drm_print.h b/include/drm/drm_print.h
index c1d333bb7534..c9fa06b517cc 100644
--- a/include/drm/drm_print.h
+++ b/include/drm/drm_print.h
@@ -392,6 +392,21 @@ enum drm_debug_category {
 	DRM_UT_DP		= 0x100,
 };
 
+/**
+ * drm_debug_enabled - check if debug logging is enabled for the
+ * specified category
+ * @category: the category that is checked
+ *
+ * The category specified can be either one &drm_debug_category value or several
+ * &drm_debug_category values ORed together.
+ * drm_debug_enabled() can be used to avoid expensive logging functionality
+ * when logging is not enabled.
+ * Use with care.
+ *
+ * RETURNS:
+ * true if debug logging for the specified category is enabled.
+ * false otherwise
+ */
 static inline bool drm_debug_enabled(enum drm_debug_category category)
 {
 	return unlikely(__drm_debug & category);
-- 
2.20.1