From 754ce18135c778c378bd09b19d9e1e84a5578b07 Mon Sep 17 00:00:00 2001 From: Srivardhan Hebbar Date: Wed, 15 Oct 2014 14:51:27 +0530 Subject: [PATCH] doc: Added API documentation for wl_display_destroy and wl_display_add_socket functions. Signed-off-by: Srivardhan Hebbar [Pekka Paalanen: minor re-wording.] Signed-off-by: Pekka Paalanen --- src/wayland-server.c | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/src/wayland-server.c b/src/wayland-server.c index 53ae5ee..270e5c7 100644 --- a/src/wayland-server.c +++ b/src/wayland-server.c @@ -861,6 +861,20 @@ wl_socket_alloc(void) return s; } +/** Destroy Wayland display object. + * + * \param display The Wayland display object which should be destroyed. + * \return None. + * + * This function emits the wl_display destroy signal, releases + * all the sockets added to this display, free's all the globals associated + * with this display, free's memory of additional shared memory formats and + * destroy the display object. + * + * \sa wl_display_add_destroy_listener + * + * \memberof wl_display + */ WL_EXPORT void wl_display_destroy(struct wl_display *display) { @@ -1180,6 +1194,30 @@ 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. + * + * If NULL is passed as name, then it would look for WAYLAND_DISPLAY env + * variable for the socket name. If WAYLAND_DISPLAY is not set, then default + * wayland-0 is used. + * + * The Unix socket will be created in the directory pointed to by environment + * variable XDG_RUNTIME_DIR. If XDG_RUNTIME_DIR is not set, then this function + * fails and returns -1. + * + * The length of socket path, i.e., the path set in XDG_RUNTIME_DIR and the + * socket name, must not exceed the maxium length of a Unix socket path. + * The function also fails if the user do not have write permission in the + * XDG_RUNTIME_DIR path or if the socket name is already in use. + * + * \memberof wl_display + */ WL_EXPORT int wl_display_add_socket(struct wl_display *display, const char *name) { -- 2.7.4