From: Yong Bakos <ybakos@humanoriented.com>
Date: Thu, 12 May 2016 20:52:37 +0000 (-0500)
Subject: doc: Unpublish wl_display_get_additional_shm_formats
X-Git-Tag: 1.11.91~35
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=3e58aa1e0621f9183188bc79c51e0a3eca932465;p=platform%2Fupstream%2Fwayland.git

doc: Unpublish wl_display_get_additional_shm_formats

The Wayland docbook and the doxygen html docs had been presenting
wl_display_get_additional_shm_formats as part of the public API, but the
prototype for this function is in wayland-private.h.

Add a \private annotation to the doc comment, preventing doxygen from
publishing this function as public.
Add logic to the publican xsl to only transform elements with a "prot"
attribute value of "public".

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

diff --git a/doc/publican/doxygen-to-publican.xsl b/doc/publican/doxygen-to-publican.xsl
index 7c3b507..e13dcd7 100644
--- a/doc/publican/doxygen-to-publican.xsl
+++ b/doc/publican/doxygen-to-publican.xsl
@@ -101,7 +101,7 @@
 
 <!-- methods -->
 <xsl:template match="memberdef" >
-  <xsl:if test="@kind = 'function' and @static = 'no' or
+  <xsl:if test="@kind = 'function' and @static = 'no' and @prot = 'public' or
                 @kind !='function' and normalize-space(briefdescription) != ''">
     <varlistentry id="{$which}-{@id}">
         <term>
diff --git a/src/wayland-server.c b/src/wayland-server.c
index f745e62..ad82bc2 100644
--- a/src/wayland-server.c
+++ b/src/wayland-server.c
@@ -1470,6 +1470,8 @@ wl_display_add_shm_format(struct wl_display *display, uint32_t format)
  *
  * \sa wl_display_add_shm_format()
  *
+ * \private
+ *
  * \memberof wl_display
  */
 struct wl_array *