drm/amd/display: dc.h: eliminate kernel-doc warnings
authorRandy Dunlap <rdunlap@infradead.org>
Wed, 12 Jul 2023 02:23:38 +0000 (19:23 -0700)
committerAlex Deucher <alexander.deucher@amd.com>
Wed, 12 Jul 2023 16:22:52 +0000 (12:22 -0400)
Quash 175 kernel-doc warnings in dc.h by unmarking 2 struct
comments as containing kernel-doc notation and by spelling one
struct field correctly in a kernel-doc comment.

Fixes: 1682bd1a6b5f ("drm/amd/display: Expand kernel doc for DC")
Fixes: ea76895ffab1 ("drm/amd/display: Document pipe split policy")
Fixes: f6ae69f49fcf ("drm/amd/display: Include surface of unaffected streams")
Reviewed-by: Harry Wentland <harry.wentland@amd.com>
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Alex Deucher <alexander.deucher@amd.com>
Cc: Harry Wentland <harry.wentland@amd.com>
Cc: Leo Li <sunpeng.li@amd.com>
Cc: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
Cc: Aurabindo Pillai <aurabindo.pillai@amd.com>
Cc: Alex Deucher <alexander.deucher@amd.com>
Cc: amd-gfx@lists.freedesktop.org
Cc: Alex Deucher <alexander.deucher@amd.com>
Cc: Christian König <christian.koenig@amd.com>
Cc: "Pan, Xinhui" <Xinhui.Pan@amd.com>
Cc: dri-devel@lists.freedesktop.org
drivers/gpu/drm/amd/display/dc/dc.h

index 6394817..358cfa8 100644 (file)
@@ -506,7 +506,7 @@ enum dcn_zstate_support_state {
        DCN_ZSTATE_SUPPORT_DISALLOW,
 };
 
-/**
+/*
  * struct dc_clocks - DC pipe clocks
  *
  * For any clocks that may differ per pipe only the max is stored in this
@@ -728,7 +728,7 @@ struct resource_pool;
 struct dce_hwseq;
 struct link_service;
 
-/**
+/*
  * struct dc_debug_options - DC debug struct
  *
  * This struct provides a simple mechanism for developers to change some
@@ -756,7 +756,7 @@ struct dc_debug_options {
        bool use_max_lb;
        enum dcc_option disable_dcc;
 
-       /**
+       /*
         * @pipe_split_policy: Define which pipe split policy is used by the
         * display core.
         */
@@ -1334,7 +1334,7 @@ struct dc_validation_set {
        struct dc_stream_state *stream;
 
        /**
-        * @plane_state: Surface state
+        * @plane_states: Surface state
         */
        struct dc_plane_state *plane_states[MAX_SURFACES];