Re: Top-level include files



> Its supposed to be documented in the api docs, at the top of the
> synopsis for each section. Of course, the documentation may be
> outdated.

This is a farce.  Why try to enforce something that does not seem to
have ever been documented?  At least not correctly.

On http://library.gnome.org/devel/glib/stable/glib-compiling.html we have:

"The recommended way of using GLib has always been to only include the
toplevel headers glib.h, glib-object.h, gio.h. Starting with 2.17,
GLib enforces this by generating an error when individual headers are
directly included."

That's wrong.

http://library.gnome.org/devel/gdk/stable/ has nothing similar that I
can find.  The synopsis for Key Values lists only gdk/gdk.h.  In the
body there is a note about <gdk/gdkkeysyms.h>

Humble suggestion:

1. Correctly document which header files can be included by
    applications.  Then worry about enforcement.

2. Make sure tests and demos subdirectories follow the policy.

3. Then worry about enforcement.

In that order.

Morten


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