[PATCH wayland] wayland-server: document WL_HIDE_DEPRECATED

[Emil Velikov]

From: Emil Velikov <emil.velikov at collabora.com>

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 at collabora.co.uk>
Signed-off-by: Emil Velikov <emil.velikov at collabora.com>
---
I think this is a fairly good start.

Note: I've intentionally omitted any text about handling future
deprecation. There's none, yet, and stipulating about something
that may or may not happen in the future isn't the best of ideas ;-)
---
 src/wayland-server.h | 10 ++++++++++
 1 file changed, 10 insertions(+)

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