mirrors/wayland
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland.git synced 2025-10-29 05:40:16 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

wayland-server: document WL_HIDE_DEPRECATED

Browse source 
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>
This commit is contained in:
Emil Velikov 2017-09-08 11:49:53 +01:00 • committed by Pekka Paalanen
parent f6bbc975d3
commit 242005636d
1 changed files with 10 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
src/wayland-server.h
View file

@ -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 {