summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2020-03-10 09:41:14 +0100
committerXavi Artigas <xavierartigas@yahoo.es>2020-03-10 21:36:34 +0100
commit5c2dfd80a649f84f6fc282abb958f69098ad226c (patch)
treec5733a3782d6d9c44b980ce5387536a61c93eafa
parenta89a2ef1dee61da73cb8d67e8c70450674d02ed5 (diff)
doxygen docs: Adapt to Doxygen syntax
I don't know where did these comments come from, but it was not Doxygen.
-rw-r--r--src/lib/ecore_wayland/ivi-application-client-protocol.h42
-rw-r--r--src/lib/ecore_wayland/xdg-shell-client-protocol.h42
2 files changed, 25 insertions, 59 deletions
diff --git a/src/lib/ecore_wayland/ivi-application-client-protocol.h b/src/lib/ecore_wayland/ivi-application-client-protocol.h
index 84fecd84ef..7f825772df 100644
--- a/src/lib/ecore_wayland/ivi-application-client-protocol.h
+++ b/src/lib/ecore_wayland/ivi-application-client-protocol.h
@@ -44,59 +44,45 @@ extern const struct wl_interface ivi_application_interface;
44#ifndef IVI_SURFACE_WARNING_CODE_ENUM 44#ifndef IVI_SURFACE_WARNING_CODE_ENUM
45#define IVI_SURFACE_WARNING_CODE_ENUM 45#define IVI_SURFACE_WARNING_CODE_ENUM
46/** 46/**
47 * ivi_surface_warning_code - possible warning codes returned by ivi 47 * @brief Possible warning codes returned by ivi compositor
48 * compositor
49 * @IVI_SURFACE_WARNING_CODE_INVALID_WL_SURFACE: wl_surface is invalid
50 * @IVI_SURFACE_WARNING_CODE_IVI_ID_IN_USE: ivi_id is in use and can not
51 * be shared
52 * 48 *
53 * These define all possible warning codes returned by ivi compositor on 49 * These define all possible warning codes returned by ivi compositor on
54 * server-side warnings. invalid_wl_surface: - wl_surface already has a 50 * server-side warnings.
55 * another role. - wl_surface is destroyed before the ivi_surface is
56 * destroyed. ivi_id_in_use: ivi_id is already assigned by another
57 * application.
58 */ 51 */
59enum ivi_surface_warning_code { 52enum ivi_surface_warning_code {
60 IVI_SURFACE_WARNING_CODE_INVALID_WL_SURFACE = 1, 53 IVI_SURFACE_WARNING_CODE_INVALID_WL_SURFACE = 1, /**< Surface is invalid. */
61 IVI_SURFACE_WARNING_CODE_IVI_ID_IN_USE = 2, 54 IVI_SURFACE_WARNING_CODE_IVI_ID_IN_USE = 2, /**< ivi_id is in use and cannot be shared. */
62}; 55};
63#endif /* IVI_SURFACE_WARNING_CODE_ENUM */ 56#endif /* IVI_SURFACE_WARNING_CODE_ENUM */
64 57
65/** 58/**
66 * ivi_surface - application interface to surface in ivi compositor 59 * @brief Application interface to surface in ivi compositor
67 * @visibility: visibility of surface in ivi compositor has changed
68 * @warning: server-side warning detected
69 *
70 *
71 */ 60 */
72struct ivi_surface_listener { 61struct ivi_surface_listener {
73 /** 62 /**
74 * visibility - visibility of surface in ivi compositor has 63 * @brief Visibility of surface in ivi compositor has
75 * changed 64 * changed
76 * @visibility: (none)
77 * 65 *
78 * The new visibility state is provided in argument visibility. 66 * The new visibility state is provided in argument @p visibility.
79 * If visibility is 0, the surface has become invisible. If 67 * If @p visibility is 0, the surface has become invisible. If
80 * visibility is not 0, the surface has become visible. 68 * @p visibility is not 0, the surface has become visible.
81 */ 69 */
82 void (*visibility)(void *data, 70 void (*visibility)(void *data,
83 struct ivi_surface *ivi_surface, 71 struct ivi_surface *ivi_surface,
84 int32_t visibility); 72 int32_t visibility);
85 /** 73 /**
86 * warning - server-side warning detected 74 * @brief Server-side warning detected
87 * @warning_code: (none)
88 * @warning_text: (none)
89 * 75 *
90 * The ivi compositor encountered warning while processing a 76 * The ivi compositor encountered warning while processing a
91 * request by this application. The warning is defined by argument 77 * request by this application. The warning is defined by argument
92 * warning_code and optional warning_text. If the warning is 78 * @p warning_code and optional @p warning_text. If the warning is
93 * detected, client shall destroy the ivi_surface object. 79 * detected, client shall destroy the @p ivi_surface object.
94 * 80 *
95 * When a warning event is sent, the compositor turns the 81 * When a warning event is sent, the compositor turns the
96 * ivi_surface object inert. The ivi_surface will not deliver 82 * @p ivi_surface object inert. The @p ivi_surface will not deliver
97 * further events, all requests on it are ignored except 'destroy', 83 * further events, all requests on it are ignored except 'destroy',
98 * and the association to the ivi_id is removed. The client should 84 * and the association to the ivi_id is removed. The client should
99 * destroy the ivi_surface object. If an inert ivi_surface object 85 * destroy the @p ivi_surface object. If an inert @p ivi_surface object
100 * is used as an argument to any other object's request, that 86 * is used as an argument to any other object's request, that
101 * request will [produce a fatal error / produce a warning / be 87 * request will [produce a fatal error / produce a warning / be
102 * ignored]. 88 * ignored].
diff --git a/src/lib/ecore_wayland/xdg-shell-client-protocol.h b/src/lib/ecore_wayland/xdg-shell-client-protocol.h
index 24b92b01e1..2b20845db5 100644
--- a/src/lib/ecore_wayland/xdg-shell-client-protocol.h
+++ b/src/lib/ecore_wayland/xdg-shell-client-protocol.h
@@ -77,8 +77,7 @@ enum xdg_shell_error {
77#endif /* XDG_SHELL_ERROR_ENUM */ 77#endif /* XDG_SHELL_ERROR_ENUM */
78 78
79/** 79/**
80 * xdg_shell - create desktop-style surfaces 80 * @brief Create desktop-style surfaces
81 * @ping: check if the client is alive
82 * 81 *
83 * xdg_shell allows clients to turn a wl_surface into a "real window" 82 * xdg_shell allows clients to turn a wl_surface into a "real window"
84 * which can be dragged, resized, stacked, and moved around by the user. 83 * which can be dragged, resized, stacked, and moved around by the user.
@@ -87,8 +86,7 @@ enum xdg_shell_error {
87 */ 86 */
88struct xdg_shell_listener { 87struct xdg_shell_listener {
89 /** 88 /**
90 * ping - check if the client is alive 89 * @brief Check if the client is alive
91 * @serial: pass this to the pong request
92 * 90 *
93 * The ping event asks the client if it's still alive. Pass the 91 * The ping event asks the client if it's still alive. Pass the
94 * serial specified in the event back to the compositor by sending 92 * serial specified in the event back to the compositor by sending
@@ -101,6 +99,8 @@ struct xdg_shell_listener {
101 * 99 *
102 * A compositor is free to ping in any way it wants, but a client 100 * A compositor is free to ping in any way it wants, but a client
103 * must always respond to any xdg_shell object it created. 101 * must always respond to any xdg_shell object it created.
102 *
103 * @param serial Pass this to the pong request
104 */ 104 */
105 void (*ping)(void *data, 105 void (*ping)(void *data,
106 struct xdg_shell *xdg_shell, 106 struct xdg_shell *xdg_shell,
@@ -181,16 +181,7 @@ xdg_shell_pong(struct xdg_shell *xdg_shell, uint32_t serial)
181#ifndef XDG_SURFACE_RESIZE_EDGE_ENUM 181#ifndef XDG_SURFACE_RESIZE_EDGE_ENUM
182#define XDG_SURFACE_RESIZE_EDGE_ENUM 182#define XDG_SURFACE_RESIZE_EDGE_ENUM
183/** 183/**
184 * xdg_surface_resize_edge - edge values for resizing 184 * @brief Edge values for resizing
185 * @XDG_SURFACE_RESIZE_EDGE_NONE: (none)
186 * @XDG_SURFACE_RESIZE_EDGE_TOP: (none)
187 * @XDG_SURFACE_RESIZE_EDGE_BOTTOM: (none)
188 * @XDG_SURFACE_RESIZE_EDGE_LEFT: (none)
189 * @XDG_SURFACE_RESIZE_EDGE_TOP_LEFT: (none)
190 * @XDG_SURFACE_RESIZE_EDGE_BOTTOM_LEFT: (none)
191 * @XDG_SURFACE_RESIZE_EDGE_RIGHT: (none)
192 * @XDG_SURFACE_RESIZE_EDGE_TOP_RIGHT: (none)
193 * @XDG_SURFACE_RESIZE_EDGE_BOTTOM_RIGHT: (none)
194 * 185 *
195 * These values are used to indicate which edge of a surface is being 186 * These values are used to indicate which edge of a surface is being
196 * dragged in a resize operation. The server may use this information to 187 * dragged in a resize operation. The server may use this information to
@@ -212,11 +203,7 @@ enum xdg_surface_resize_edge {
212#ifndef XDG_SURFACE_STATE_ENUM 203#ifndef XDG_SURFACE_STATE_ENUM
213#define XDG_SURFACE_STATE_ENUM 204#define XDG_SURFACE_STATE_ENUM
214/** 205/**
215 * xdg_surface_state - types of state on the surface 206 * @brief Types of state on the surface
216 * @XDG_SURFACE_STATE_MAXIMIZED: the surface is maximized
217 * @XDG_SURFACE_STATE_FULLSCREEN: the surface is fullscreen
218 * @XDG_SURFACE_STATE_RESIZING: (none)
219 * @XDG_SURFACE_STATE_ACTIVATED: (none)
220 * 207 *
221 * The different state values used on the surface. This is designed for 208 * The different state values used on the surface. This is designed for
222 * state values like maximized, fullscreen. It is paired with the configure 209 * state values like maximized, fullscreen. It is paired with the configure
@@ -246,9 +233,7 @@ enum xdg_surface_state {
246#endif /* XDG_SURFACE_STATE_ENUM */ 233#endif /* XDG_SURFACE_STATE_ENUM */
247 234
248/** 235/**
249 * xdg_surface - A desktop window 236 * @brief A desktop window
250 * @configure: suggest a surface change
251 * @close: surface wants to be closed
252 * 237 *
253 * An interface that may be implemented by a wl_surface, for 238 * An interface that may be implemented by a wl_surface, for
254 * implementations that provide a desktop-style user interface. 239 * implementations that provide a desktop-style user interface.
@@ -272,11 +257,7 @@ enum xdg_surface_state {
272 */ 257 */
273struct xdg_surface_listener { 258struct xdg_surface_listener {
274 /** 259 /**
275 * configure - suggest a surface change 260 * @brief Suggest a surface change
276 * @width: (none)
277 * @height: (none)
278 * @states: (none)
279 * @serial: (none)
280 * 261 *
281 * The configure event asks the client to resize its surface or 262 * The configure event asks the client to resize its surface or
282 * to change its state. 263 * to change its state.
@@ -311,7 +292,7 @@ struct xdg_surface_listener {
311 struct wl_array *states, 292 struct wl_array *states,
312 uint32_t serial); 293 uint32_t serial);
313 /** 294 /**
314 * close - surface wants to be closed 295 * @brief Surface wants to be closed
315 * 296 *
316 * The close event is sent by the compositor when the user wants 297 * The close event is sent by the compositor when the user wants
317 * the surface to be closed. This should be equivalent to the user 298 * the surface to be closed. This should be equivalent to the user
@@ -462,8 +443,7 @@ xdg_surface_set_minimized(struct xdg_surface *xdg_surface)
462} 443}
463 444
464/** 445/**
465 * xdg_popup - short-lived, popup surfaces for menus 446 * @brief Short-lived popup surfaces for menus
466 * @popup_done: popup interaction is done
467 * 447 *
468 * A popup surface is a short-lived, temporary surface that can be used 448 * A popup surface is a short-lived, temporary surface that can be used
469 * to implement menus. It takes an explicit grab on the surface that will 449 * to implement menus. It takes an explicit grab on the surface that will
@@ -513,7 +493,7 @@ xdg_surface_set_minimized(struct xdg_surface *xdg_surface)
513 */ 493 */
514struct xdg_popup_listener { 494struct xdg_popup_listener {
515 /** 495 /**
516 * popup_done - popup interaction is done 496 * @brief Popup interaction is done
517 * 497 *
518 * The popup_done event is sent out when a popup is dismissed by 498 * The popup_done event is sent out when a popup is dismissed by
519 * the compositor. The client should destroy the xdg_popup object 499 * the compositor. The client should destroy the xdg_popup object