lkml.org 
[lkml]   [2018]   [Feb]   [16]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH 6/6] drm: intel_dpio_phy: fix kernel-doc comments at nested struct
    Date
    The in-lined comments for channel.port doesn't follow the syntax
    described at kernel-doc document, causing the following warning:

    $ ./scripts/kernel-doc -none drivers/gpu/drm/i915/intel_dpio_phy.c
    drivers/gpu/drm/i915/intel_dpio_phy.c:154: warning: Function parameter or member 'channel.port' not described in 'bxt_ddi_phy_info'

    While the best would be for the Kernel to deduce that from the
    context, supporting it is not trivial. So, let's just stick with
    the existing syntax.

    Reported-by: Jani Nikula <jani.nikula@intel.com>
    Tested-by: Jani Nikula <jani.nikula@intel.com>
    Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
    ---
    drivers/gpu/drm/i915/intel_dpio_phy.c | 2 +-
    1 file changed, 1 insertion(+), 1 deletion(-)

    diff --git a/drivers/gpu/drm/i915/intel_dpio_phy.c b/drivers/gpu/drm/i915/intel_dpio_phy.c
    index 76473e9836c6..c8e9e44e5981 100644
    --- a/drivers/gpu/drm/i915/intel_dpio_phy.c
    +++ b/drivers/gpu/drm/i915/intel_dpio_phy.c
    @@ -147,7 +147,7 @@ struct bxt_ddi_phy_info {
    */
    struct {
    /**
    - * @port: which port maps to this channel.
    + * @channel.port: which port maps to this channel.
    */
    enum port port;
    } channel[2];
    --
    2.14.3
    \
     
     \ /
      Last update: 2018-02-16 14:50    [W:4.514 / U:0.136 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site