[PATCH wayland 5/5] man: Add man page for wl_display_roundtrip()

[Jonas Ådahl]

Signed-off-by: Jonas Ådahl <jadahl at gmail.com>
---
 doc/man/Makefile.am              |    3 +-
 doc/man/wl_display_roundtrip.xml |   75 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 77 insertions(+), 1 deletion(-)
 create mode 100644 doc/man/wl_display_roundtrip.xml

diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index 5093bd9..95de7e0 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -6,7 +6,8 @@
 
 MANPAGES = \
 	wl_display_connect.3 \
-	wl_display_dispatch.3
+	wl_display_dispatch.3 \
+	wl_display_roundtrip.3
 
 MANPAGES_ALIASES = \
 	wl_display_connect_to_fd.3 \
diff --git a/doc/man/wl_display_roundtrip.xml b/doc/man/wl_display_roundtrip.xml
new file mode 100644
index 0000000..9cb7f34
--- /dev/null
+++ b/doc/man/wl_display_roundtrip.xml
@@ -0,0 +1,75 @@
+<?xml version='1.0'?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+          "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+
+<refentry id="wl_display_roundtrip">
+  <refentryinfo>
+    <title>wl_display_roundtrip</title>
+    <productname>wayland-client</productname>
+    <date>December 2012</date>
+    <authorgroup>
+      <author>
+        <contrib>Developer</contrib>
+        <firstname>Jonas</firstname>
+        <surname>Ådahl</surname>
+        <email>jadahl at gmail.com</email>
+      </author>
+    </authorgroup>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle>wl_display_roundtrip</refentrytitle>
+    <manvolnum>3</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>wl_display_roundtrip</refname>
+    <refpurpose>synchronize with server</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <funcsynopsis>
+
+      <funcsynopsisinfo>#include <wayland-client.h></funcsynopsisinfo>
+
+      <funcprototype>
+        <funcdef>int <function>wl_display_roundtrip</function></funcdef>
+        <paramdef>struct wl_display *<parameter>display</parameter></paramdef>
+      </funcprototype>
+
+    </funcsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+  <title>Description</title>
+    <para>
+      <function>wl_display_roundtrip</function> will block until all pending
+      requests have been processed by the server. Calling this function
+      guarantees that response events from already issued callback requests will
+      have their events queued. If the event proxy of a callback object uses the
+      display queue, the response event will have been dispatched as well.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>Return Value</title>
+    <para>
+      On success, the number of dispatched events is returned. On error,
+      -1 is returned and <varname>errno</varname> is set appropriately.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>See Also</title>
+    <para>
+      <citerefentry>
+        <refentrytitle>wayland-client</refentrytitle>
+        <manvolnum>7</manvolnum>
+      </citerefentry>,
+      <citerefentry>
+        <refentrytitle>wl_display_dispatch</refentrytitle>
+        <manvolnum>3</manvolnum>
+      </citerefentry>
+    </para>
+  </refsect1>
+</refentry>
-- 
1.7.10.4