lkml.org 
[lkml]   [2021]   [Mar]   [25]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH v4 2/5] phy: Add LVDS configuration options
On 18-03-21, 10:22, Liu Ying wrote:

> > Can we have these in kernel-doc style please, similar to style in linux/phy/phy.h
>
> I take this way of in-line member documentation comment for the below 3
> reasons:
>
> 1) Members of struct phy_configure_opts_mipi_dphy and
> struct phy_configure_opts_dp use the same way of comment.
> The structures are defined in linux/phy/phy-mipi-dphy.h and
> linux/phy/phy-dp.h respectively.
> Aligning to them makes a bit sense, IMHO.
>
> 2) In-line member documentation comments[1] are mentioned in kernel-doc
> guide. It says 'The structure members may also be documented in-line
> within the definition.'.
>
> 3) Even the 'configure' and 'validate' members of struct phy_ops use
> the same way of comment. struct phy_ops is defined in linux/phy/phy.h.
>
> [1]
> https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html#in-line-member-documentation-comments

It 'may be' but I would like all headers of a subsystem to display one
style. As I said linux/phy/phy.h use a style which we should use
everywhere.

Thanks

--
~Vinod

\
 
 \ /
  Last update: 2021-03-25 08:30    [W:0.059 / U:0.040 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site