diff options
| author | Emil Velikov <emil.velikov@collabora.com> | 2017-09-08 11:49:53 +0100 |
|---|---|---|
| committer | Pekka Paalanen <pekka.paalanen@collabora.co.uk> | 2017-10-13 14:26:46 +0300 |
| commit | 242005636d0897db166215ed09cf3832217df008 (patch) | |
| tree | 3cac278598bacbbe5d2d96cf08a5911bce439428 | |
| parent | f6bbc975d30560a4cd73038b1cca840d330ed428 (diff) | |
Add some inline information, what the macro is used for, why it came to
be and what we shouldn't do if we consider further deprecation in the future
deprecation.
Cc: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
Signed-off-by: Emil Velikov <emil.velikov@collabora.com>
Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
| -rw-r--r-- | src/wayland-server.h | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/src/wayland-server.h b/src/wayland-server.h index f11fb4d..ccf9783 100644 --- a/src/wayland-server.h +++ b/src/wayland-server.h @@ -43,6 +43,16 @@ extern "C" { #endif +/* + * The user can set this macro to hide the wl_object, wl_resource and wl_buffer + * objects alongside the associated API. + * + * The structs were meant to be opaque, although we missed that in the early days. + * + * NOTE: the list of structs, functions, etc in this section MUST NEVER GROW. + * Otherwise we will break forward compatibility and applications that used to + * build fine will no longer be able to do so. + */ #ifndef WL_HIDE_DEPRECATED struct wl_object { |