mirrors/wayland
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland.git synced 2026-04-07 08:21:33 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Unpublish wl_display_get_additional_shm_formats

Browse source 
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>
This commit is contained in:
Yong Bakos 2016-05-12 15:52:37 -05:00 • committed by Bryce Harrington
parent 98d94b5c1d
commit 3e58aa1e06
2 changed files with 3 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/publican/doxygen-to-publican.xsl
View file

@ -101,7 +101,7 @@
<!-- methods --> <!-- methods -->
<xsl:template match="memberdef" > <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) != ''"> @kind !='function' and normalize-space(briefdescription) != ''">
<varlistentry id="{$which}-{@id}"> <varlistentry id="{$which}-{@id}">
<term> <term>

2
src/wayland-server.c
View file

@ -1470,6 +1470,8 @@ wl_display_add_shm_format(struct wl_display *display, uint32_t format)
* *
* \sa wl_display_add_shm_format() * \sa wl_display_add_shm_format()
* *
* \private
*
* \memberof wl_display * \memberof wl_display
*/ */
struct wl_array * struct wl_array *