[PATCH wayland 4/6] doc: Don't warn if something is undocumented

Bryce Harrington bryce at osg.samsung.com
Wed Jan 13 15:48:37 PST 2016


On Tue, Dec 29, 2015 at 01:56:14PM +0100, Nils Chr. Brause wrote:
> No.
> If we want Wayland to be successful and widely used it has to be well
> documented (which it still is far from). Turning off warnings about
> undocumented fields doesn't exactly help the documentation effort but
> rather impedes it.

I want to see all the docs written, however I'm skeptical these warnings
are providing adequate motivation to get people writing docs.

My guess is that most people just tune them out at this point, and
they're more clutter than usefulness...

> On Tue, Dec 29, 2015 at 3:10 AM, Jonas Ådahl <jadahl at gmail.com> wrote:
> > There are lots of warnings about fields and other things not being
> > documented, and many of those will probably never be documented, so
> > stop warning about it.
> >
> > Signed-off-by: Jonas Ådahl <jadahl at gmail.com>
> > ---
> >  doc/doxygen/wayland.doxygen.in | 1 +
> >  1 file changed, 1 insertion(+)
> >
> > diff --git a/doc/doxygen/wayland.doxygen.in b/doc/doxygen/wayland.doxygen.in
> > index fb76b12..6cb77de 100644
> > --- a/doc/doxygen/wayland.doxygen.in
> > +++ b/doc/doxygen/wayland.doxygen.in
> > @@ -14,3 +14,4 @@ EXPAND_ONLY_PREDEF     = YES
> >  DOT_MULTI_TARGETS      = YES
> >  ALIASES                += comment{1}="/* \1 *<!-- -->/"
> >  GENERATE_HTML          = NO
> > +WARN_IF_UNDOCUMENTED   = NO
> > --
> > 2.4.3
> >
> > _______________________________________________
> > wayland-devel mailing list
> > wayland-devel at lists.freedesktop.org
> > http://lists.freedesktop.org/mailman/listinfo/wayland-devel
> _______________________________________________
> wayland-devel mailing list
> wayland-devel at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/wayland-devel


More information about the wayland-devel mailing list