doc: Added API documentation for wl_display_destroy and wl_display_add_socket functions.

Submitted by Srivardhan Hebbar on Oct. 13, 2014, 9:51 a.m.

Details

Message ID 1413193887-1353-1-git-send-email-sri.hebbar@samsung.com
State Superseded
Headers show

Not browsing as part of any series.

Commit Message

Srivardhan Hebbar Oct. 13, 2014, 9:51 a.m.
Signed-off-by: Srivardhan Hebbar <sri.hebbar@samsung.com>
---
 src/wayland-server.c | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

Patch hide | download patch | download mbox

diff --git a/src/wayland-server.c b/src/wayland-server.c
index 674aeca..0f61e6e 100644
--- a/src/wayland-server.c
+++ b/src/wayland-server.c
@@ -862,6 +862,15 @@  wl_socket_alloc(void)
 	return s;
 }
 
+/** Destroy Wayland display object.
+ *
+ * \param display The Wayland display object which should be destroyed.
+ * \return None.
+ *
+ * This destroys the wl_display object which has been passed.
+ *
+ * \memberof wl_display
+ */
 WL_EXPORT void
 wl_display_destroy(struct wl_display *display)
 {
@@ -1181,6 +1190,17 @@  wl_display_add_socket_auto(struct wl_display *display)
 	return NULL;
 }
 
+/** Add a socket to Wayland display for the clients to connect.
+ *
+ * \param display Wayland display to which the socket should be added.
+ * \param name Name of the Unix socket.
+ * \return 0 if success. -1 if failed.
+ *
+ * This adds a Unix socket to Wayland display which can be used by clients to
+ * connect to Wayland display.
+ *
+ * \memberof wl_display
+ */
 WL_EXPORT int
 wl_display_add_socket(struct wl_display *display, const char *name)
 {