doc: Unpublish global_zombie_object and wl_interface_equal
authorYong Bakos <ybakos@humanoriented.com>
Thu, 12 May 2016 20:52:39 +0000 (15:52 -0500)
committerBryce Harrington <bryce@osg.samsung.com>
Thu, 2 Jun 2016 00:34:30 +0000 (17:34 -0700)
Both global_zombie_object and wl_interface_equal are private, yet were
part of public documentation despite not being part of the public API.

Move these two definitions to the top of an existing doxygen \cond block,
which removes them from the public documentation.

Signed-off-by: Yong Bakos <ybakos@humanoriented.com>
Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
src/wayland-util.c

index 407d1f0..7467366 100644 (file)
 #include "wayland-util.h"
 #include "wayland-private.h"
 
-struct wl_object global_zombie_object;
-
-int
-wl_interface_equal(const struct wl_interface *a, const struct wl_interface *b)
-{
-       /* In most cases the pointer equality test is sufficient.
-        * However, in some cases, depending on how things are split
-        * across shared objects, we can end up with multiple
-        * instances of the interface metadata constants.  So if the
-        * pointers match, the interfaces are equal, if they don't
-        * match we have to compare the interface names.
-        */
-       return a == b || strcmp(a->name, b->name) == 0;
-}
-
 WL_EXPORT void
 wl_list_init(struct wl_list *list)
 {
@@ -167,6 +152,21 @@ wl_array_copy(struct wl_array *array, struct wl_array *source)
 
 /** \cond */
 
+struct wl_object global_zombie_object;
+
+int
+wl_interface_equal(const struct wl_interface *a, const struct wl_interface *b)
+{
+       /* In most cases the pointer equality test is sufficient.
+        * However, in some cases, depending on how things are split
+        * across shared objects, we can end up with multiple
+        * instances of the interface metadata constants.  So if the
+        * pointers match, the interfaces are equal, if they don't
+        * match we have to compare the interface names.
+        */
+       return a == b || strcmp(a->name, b->name) == 0;
+}
+
 union map_entry {
        uintptr_t next;
        void *data;