summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristopher Michael <cp.michael@samsung.com>2019-09-05 08:22:56 -0400
committerChristopher Michael <cp.michael@samsung.com>2019-09-05 08:22:56 -0400
commitee0023055f76096788afae3dbdaaeb9c05b99334 (patch)
treeeec35539236214104689990b1bc8c2f0e7305bac
parent1e7c079048c555306a308f6cce42fd688e89d77e (diff)
ecore-wl2: Update doxygen for various functions
Small patch to update some missing doxygen parameter information. ref T8014
-rw-r--r--src/lib/ecore_wl2/Ecore_Wl2.h56
1 files changed, 31 insertions, 25 deletions
diff --git a/src/lib/ecore_wl2/Ecore_Wl2.h b/src/lib/ecore_wl2/Ecore_Wl2.h
index 2df3a9804a..240ec820ac 100644
--- a/src/lib/ecore_wl2/Ecore_Wl2.h
+++ b/src/lib/ecore_wl2/Ecore_Wl2.h
@@ -1096,8 +1096,8 @@ EAPI Eina_Bool ecore_wl2_window_rotation_app_get(Ecore_Wl2_Window *window);
1096/** 1096/**
1097 * Set preferred rotation on a given window 1097 * Set preferred rotation on a given window
1098 * 1098 *
1099 * @param window 1099 * @param window The window to set preferred rotation on
1100 * @param rot 1100 * @param rot The value of the preferred rotation to set
1101 * 1101 *
1102 * @ingroup Ecore_Wl2_Window_Group 1102 * @ingroup Ecore_Wl2_Window_Group
1103 * @since 1.20 1103 * @since 1.20
@@ -1107,7 +1107,7 @@ EAPI void ecore_wl2_window_preferred_rotation_set(Ecore_Wl2_Window *window, int
1107/** 1107/**
1108 * Get preferred rotation for a given window 1108 * Get preferred rotation for a given window
1109 * 1109 *
1110 * @param window 1110 * @param window The window to get preferred rotation from
1111 * 1111 *
1112 * @return Given windows preferred rotation 1112 * @return Given windows preferred rotation
1113 * 1113 *
@@ -1193,7 +1193,8 @@ EAPI void ecore_wl2_window_aux_hint_del(Ecore_Wl2_Window *window, int id);
1193/** 1193/**
1194 * @brief Get the activated state of a window 1194 * @brief Get the activated state of a window
1195 * 1195 *
1196 * @param window The window 1196 * @param window The window to get activated state from
1197 *
1197 * @return @c EINA_TRUE if activated 1198 * @return @c EINA_TRUE if activated
1198 * 1199 *
1199 * @ingroup Ecore_Wl2_Window_Group 1200 * @ingroup Ecore_Wl2_Window_Group
@@ -1242,8 +1243,8 @@ EAPI Ecore_Wl2_Display *ecore_wl2_window_display_get(const Ecore_Wl2_Window *win
1242/** 1243/**
1243 * Set if this window should ignore focus requests 1244 * Set if this window should ignore focus requests
1244 * 1245 *
1245 * @param window 1246 * @param window The window to set ignore focus requests on
1246 * @param focus_skip 1247 * @param focus_skip EINA_TRUE if this window should skip focus requests, EINA_FALSE otherwise
1247 * 1248 *
1248 * @ingroup Ecore_Wl2_Window_Group 1249 * @ingroup Ecore_Wl2_Window_Group
1249 * @since 1.20 1250 * @since 1.20
@@ -1253,7 +1254,7 @@ EAPI void ecore_wl2_window_focus_skip_set(Ecore_Wl2_Window *window, Eina_Bool fo
1253/** 1254/**
1254 * Get if this window ignores focus requests 1255 * Get if this window ignores focus requests
1255 * 1256 *
1256 * @param window 1257 * @param window The window to get the focus skip value from
1257 * 1258 *
1258 * @return EINA_TRUE if a window should skip focus requests, EINA_FALSE otherwise 1259 * @return EINA_TRUE if a window should skip focus requests, EINA_FALSE otherwise
1259 * 1260 *
@@ -1276,8 +1277,8 @@ EAPI void ecore_wl2_window_role_set(Ecore_Wl2_Window *window, const char *role);
1276/** 1277/**
1277 * Set if a given window is in floating mode 1278 * Set if a given window is in floating mode
1278 * 1279 *
1279 * @param window 1280 * @param window The window to set floating mode on
1280 * @param floating 1281 * @param floating EINA_TRUE if this window should be in floating mode, EINA_FALSE otherwise
1281 * 1282 *
1282 * @ingroup Ecore_Wl2_Window_Group 1283 * @ingroup Ecore_Wl2_Window_Group
1283 * @since 1.20 1284 * @since 1.20
@@ -1287,7 +1288,7 @@ EAPI void ecore_wl2_window_floating_mode_set(Ecore_Wl2_Window *window, Eina_Bool
1287/** 1288/**
1288 * Get if a given window is in floating mode 1289 * Get if a given window is in floating mode
1289 * 1290 *
1290 * @param window 1291 * @param window The window to get floating mode
1291 * 1292 *
1292 * @return EINA_TRUE if floating, EINA_FALSE otherwise 1293 * @return EINA_TRUE if floating, EINA_FALSE otherwise
1293 * 1294 *
@@ -1722,6 +1723,7 @@ EAPI int ecore_wl2_output_dpi_get(Ecore_Wl2_Output *output);
1722 * @param output The output to get the transform of 1723 * @param output The output to get the transform of
1723 * 1724 *
1724 * @return The output's current transform value 1725 * @return The output's current transform value
1726 *
1725 * @ingroup Ecore_Wl2_Output_Group 1727 * @ingroup Ecore_Wl2_Output_Group
1726 * @since 1.20 1728 * @since 1.20
1727 */ 1729 */
@@ -1888,8 +1890,8 @@ EAPI void ecore_wl2_session_recovery_disable(void);
1888 * A surface that has been commit will be in the "pending" state until 1890 * A surface that has been commit will be in the "pending" state until
1889 * the compositor tells us it's time to draw again via a frame callback. 1891 * the compositor tells us it's time to draw again via a frame callback.
1890 * 1892 *
1891 * @surface surface to commit 1893 * @param window The window whose surface we want to commit
1892 * @flush EINA_TRUE if we need to flush immediately. 1894 * @param flush EINA_TRUE if we need to flush immediately.
1893 * 1895 *
1894 * @since 1.21 1896 * @since 1.21
1895 */ 1897 */
@@ -1901,6 +1903,8 @@ EAPI void ecore_wl2_window_commit(Ecore_Wl2_Window *window, Eina_Bool flush);
1901 * A surface is pending if it's been commit but we haven't received a 1903 * A surface is pending if it's been commit but we haven't received a
1902 * frame callback for it yet. This mean's we're not ready to draw yet. 1904 * frame callback for it yet. This mean's we're not ready to draw yet.
1903 * 1905 *
1906 * @param window The window whose surface we want to check
1907 *
1904 * @return whether the window's surface is pending or not. 1908 * @return whether the window's surface is pending or not.
1905 * 1909 *
1906 * @since 1.21 1910 * @since 1.21
@@ -1910,9 +1914,9 @@ EAPI Eina_Bool ecore_wl2_window_pending_get(Ecore_Wl2_Window *window);
1910/** 1914/**
1911 * Add a callback that fires when the window's surface_frame callback fires 1915 * Add a callback that fires when the window's surface_frame callback fires
1912 * 1916 *
1913 * @window the window to add a callback on 1917 * @param window The window to add a callback on
1914 * @cb The callback 1918 * @param cb The callback
1915 * @data user data to provide to the callback handler 1919 * @param data User data to provide to the callback handler
1916 * 1920 *
1917 * @since 1.21 1921 * @since 1.21
1918 */ 1922 */
@@ -1921,8 +1925,8 @@ EAPI Ecore_Wl2_Frame_Cb_Handle *ecore_wl2_window_frame_callback_add(Ecore_Wl2_Wi
1921/** 1925/**
1922 * delete a callback that fires when the window's surface_frame callback fires 1926 * delete a callback that fires when the window's surface_frame callback fires
1923 * 1927 *
1924 * @window the window to add a callback on 1928 * @param window The window to add a callback on
1925 * @cb The callback handle 1929 * @param cb The callback handle
1926 * 1930 *
1927 * @since 1.21 1931 * @since 1.21
1928 */ 1932 */
@@ -1936,11 +1940,11 @@ EAPI void ecore_wl2_window_frame_callback_del(Ecore_Wl2_Frame_Cb_Handle *handle)
1936 * has a valid buffer. That is, call with implicit true and buffer NULL at 1940 * has a valid buffer. That is, call with implicit true and buffer NULL at
1937 * the time of glSwapBuffers. 1941 * the time of glSwapBuffers.
1938 * 1942 *
1939 * @window the target window 1943 * @param window The target window
1940 * @buffer the buffer to attach 1944 * @param buffer The buffer to attach
1941 * @x x offset from corner 1945 * @param x X offset from corner
1942 * @y y offset from corner 1946 * @param y Y offset from corner
1943 * @implicit true if an external library is doing the actual attaching 1947 * @param implicit True if an external library is doing the actual attaching
1944 * 1948 *
1945 * @since 1.21 1949 * @since 1.21
1946 */ 1950 */
@@ -1953,7 +1957,8 @@ EAPI void ecore_wl2_window_buffer_attach(Ecore_Wl2_Window *win, void *buffer, in
1953 * so the display should be flushed at appropriate times, such 1957 * so the display should be flushed at appropriate times, such
1954 * as after a commit. 1958 * as after a commit.
1955 * 1959 *
1956 * @param display 1960 * @param display The display to flush
1961 *
1957 * @since 1.21 1962 * @since 1.21
1958 */ 1963 */
1959EAPI void ecore_wl2_display_flush(Ecore_Wl2_Display *display); 1964EAPI void ecore_wl2_display_flush(Ecore_Wl2_Display *display);
@@ -1961,7 +1966,7 @@ EAPI void ecore_wl2_display_flush(Ecore_Wl2_Display *display);
1961/** 1966/**
1962 * Get if a given window is resizing 1967 * Get if a given window is resizing
1963 * 1968 *
1964 * @param window 1969 * @param window The window to check for resizing
1965 * 1970 *
1966 * @return EINA_TRUE if resizing, EINA_FALSE otherwise 1971 * @return EINA_TRUE if resizing, EINA_FALSE otherwise
1967 * 1972 *
@@ -1980,7 +1985,8 @@ EAPI Eina_Bool ecore_wl2_window_resizing_get(Ecore_Wl2_Window *window);
1980 * Events deferred during an update will automatically fire 1985 * Events deferred during an update will automatically fire
1981 * immediately after the caller calls ecore_wl2_window_commit. 1986 * immediately after the caller calls ecore_wl2_window_commit.
1982 * 1987 *
1983 * @param window 1988 * @param window The window whose state we want to latch
1989 *
1984 * @since 1.21 1990 * @since 1.21
1985 */ 1991 */
1986EAPI void ecore_wl2_window_update_begin(Ecore_Wl2_Window *window); 1992EAPI void ecore_wl2_window_update_begin(Ecore_Wl2_Window *window);