[PATCH wayland 0/3] doc: Unpublish private objects and functions

Yong Bakos junk at humanoriented.com
Thu May 12 20:52:36 UTC 2016

From: Yong Bakos <ybakos at humanoriented.com>

The Wayland docbook and the doxygen html docs had been presenting a number
of private/inaccessible things as part of the public API, which is misleading.

For 1/3, a \private command was introduced since the function is a private
wl_display member function. For the xsl rule, I did test both != 'private'
and = 'public' (thinking of future flexibility) but the doc diff is the same
and = 'public' is more direct. Note that I placed the \private marker between
the \sa and \memberof to match the convention that \sa follows a long
description and \memberof precedes the close of a doc comment.

In 2-3/3, using the \cond command was sufficient and preferred.

Yong Bakos (3):
  doc: Unpublish wl_display_get_additional_shm_formats
  doc: Unpublish wl_log* and wl_abort
  doc: Unpublish global_zombie_object and wl_interface_equal

 doc/publican/doxygen-to-publican.xsl |  2 +-
 src/wayland-server.c                 |  2 ++
 src/wayland-util.c                   | 34 +++++++++++++++++-----------------
 3 files changed, 20 insertions(+), 18 deletions(-)


More information about the wayland-devel mailing list