summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYong Bakos <ybakos@humanoriented.com>2016-05-12 15:52:37 -0500
committerBryce Harrington <bryce@osg.samsung.com>2016-06-01 17:34:17 -0700
commit3e58aa1e0621f9183188bc79c51e0a3eca932465 (patch)
treeba06b6dbe4c77806fdb4f86b0f8b78521dd2fc34
parent98d94b5c1d1cc21f5c963cdebc1cd535c6ae5b4f (diff)
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>
-rw-r--r--doc/publican/doxygen-to-publican.xsl2
-rw-r--r--src/wayland-server.c2
2 files changed, 3 insertions, 1 deletions
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 *