Re: [Intel-gfx] [PATCH 02/24] drm: Extract drm_prime.h

Sean Paul
2017-03-14T15:42:07Z

On Tue, Mar 14, 2017 at 10:12:59AM +0100, Daniel Vetter wrote:
> On Mon, Mar 13, 2017 at 12:42:54PM -0400, Sean Paul wrote:
> > On Wed, Mar 08, 2017 at 03:12:35PM +0100, Daniel Vetter wrote:
> > > +/**
> > > + * struct drm_prime_file_private - per-file tracking for PRIME
> > > + *
> > > + * This just contains the internal &struct dma_buf and handle caches for each
> > > + * &struct drm_file used by the PRIME core code.
> > > + */
> > > +
> > > +struct drm_prime_file_private {
> > > +/* private: */
> >
> > I'm a little confused by this comment. The struct has private in its name, I'm
> > not sure you're adding any additional information. Could you either remove or
> > expand this?
>
> private: is special markup for kernel-doc to ingore everything below as
> implementation-internals. This avoids warnings when building the docs. I
> have no idea why it doesn't use the usual /** kernel-doc comment starter

Yeah, that kind of sucks. When there are public and private members, it's pretty
easy to reason about. However, when the struct is strictly private, it's pretty
redundant/annoying.

Ah well.

Sean

> ...
> -Daniel
> --
> Daniel Vetter
> Software Engineer, Intel Corporation
> http://blog.ffwll.ch
> _______________________________________________
> dri-devel mailing list
> dri-devel@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org