lkml.org 
[lkml]   [2023]   [Mar]   [17]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    /
    From
    Date
    SubjectRe: [PATCH 28/37] drm/amd/display/dc/core/dc_stat: Convert a couple of doc headers to kerneldoc format
    On Fri, Mar 17, 2023 at 4:23 AM Lee Jones <lee@kernel.org> wrote:
    >
    > Fixes the following W=1 kernel build warning(s):
    >
    > drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc_stat.c:38: warning: Cannot understand *****************************************************************************
    > drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc_stat.c:76: warning: Cannot understand *****************************************************************************
    >
    > Cc: Harry Wentland <harry.wentland@amd.com>
    > Cc: Leo Li <sunpeng.li@amd.com>
    > Cc: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
    > Cc: Alex Deucher <alexander.deucher@amd.com>
    > Cc: "Christian König" <christian.koenig@amd.com>
    > Cc: "Pan, Xinhui" <Xinhui.Pan@amd.com>
    > Cc: David Airlie <airlied@gmail.com>
    > Cc: Daniel Vetter <daniel@ffwll.ch>
    > Cc: Mustapha Ghaddar <mghaddar@amd.com>
    > Cc: Nicholas Kazlauskas <Nicholas.Kazlauskas@amd.com>
    > Cc: Jasdeep Dhillon <jdhillon@amd.com>
    > Cc: amd-gfx@lists.freedesktop.org
    > Cc: dri-devel@lists.freedesktop.org
    > Signed-off-by: Lee Jones <lee@kernel.org>
    > ---
    > drivers/gpu/drm/amd/display/dc/core/dc_stat.c | 28 +++++++------------
    > 1 file changed, 10 insertions(+), 18 deletions(-)
    >
    > diff --git a/drivers/gpu/drm/amd/display/dc/core/dc_stat.c b/drivers/gpu/drm/amd/display/dc/core/dc_stat.c
    > index 6c06587dd88c2..5f6392ae31a66 100644
    > --- a/drivers/gpu/drm/amd/display/dc/core/dc_stat.c
    > +++ b/drivers/gpu/drm/amd/display/dc/core/dc_stat.c
    > @@ -35,19 +35,15 @@
    > */
    >
    > /**

    This looks like it follows some other documentation scheme. Would
    probably be better to just remove the extra * and make it not kernel
    doc. @Wentland, Harry @Siqueira, Rodrigo ?

    Alex

    > - *****************************************************************************
    > - * Function: dc_stat_get_dmub_notification
    > + * dc_stat_get_dmub_notification
    > *
    > - * @brief
    > - * Calls dmub layer to retrieve dmub notification
    > + * Calls dmub layer to retrieve dmub notification
    > *
    > - * @param
    > - * [in] dc: dc structure
    > - * [in] notify: dmub notification structure
    > + * @dc: dc structure
    > + * @notify: dmub notification structure
    > *
    > - * @return
    > + * Returns
    > * None
    > - *****************************************************************************
    > */
    > void dc_stat_get_dmub_notification(const struct dc *dc, struct dmub_notification *notify)
    > {
    > @@ -73,19 +69,15 @@ void dc_stat_get_dmub_notification(const struct dc *dc, struct dmub_notification
    > }
    >
    > /**
    > - *****************************************************************************
    > - * Function: dc_stat_get_dmub_dataout
    > + * dc_stat_get_dmub_dataout
    > *
    > - * @brief
    > - * Calls dmub layer to retrieve dmub gpint dataout
    > + * Calls dmub layer to retrieve dmub gpint dataout
    > *
    > - * @param
    > - * [in] dc: dc structure
    > - * [in] dataout: dmub gpint dataout
    > + * @dc: dc structure
    > + * @dataout: dmub gpint dataout
    > *
    > - * @return
    > + * Returns
    > * None
    > - *****************************************************************************
    > */
    > void dc_stat_get_dmub_dataout(const struct dc *dc, uint32_t *dataout)
    > {
    > --
    > 2.40.0.rc1.284.g88254d51c5-goog
    >

    \
     
     \ /
      Last update: 2023-03-27 01:06    [W:5.305 / U:0.008 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site