Re: [PATCH] hsi: Fix kerneldoc content to get rid of current warnings.

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Sun, 26 Aug 2012, Randy Dunlap wrote:

> On 08/26/2012 08:14 AM, Robert P. J. Day wrote:
>
> > On Sun, 26 Aug 2012, Randy Dunlap wrote:
> >
> >> On 08/26/2012 04:47 AM, Robert P. J. Day wrote:
> >>
> >>>
> >>> Fix *obvious* errors in current kerneldoc in both hsi.h and hsi.c,
> >>> including that a comment in the middle of the structure seems to screw
> >>> up kerneldoc processing.  I didn't know that.
> >>
> >>
> >> FYI, scripts/kernel-doc supports using
> >> /* private: */
> >> and
> >> /* public: */
> >>
> >> to mark fields of a struct that the owner/maintainer wishes
> >> to retain as private fields, undocumented, generally not to be
> >> used/touched by common drivers, just used by the core code.
> >>
> >> In this case it does appear that the /* private: */ line might
> >> as well be deleted since the fields are documented.
> >
> >   but when i removed that line, some warnings disappeared.  i'll take
> > another look at that.
>
> Yes, private fields are not expected to have kernel-doc entries,
> so that causes warnings.

  oh, so *that's* what's happening.  got it.

rday

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux