diff options
author | Christopher Michael <cp.michael@samsung.com> | 2019-09-05 07:57:41 -0400 |
---|---|---|
committer | Christopher Michael <cp.michael@samsung.com> | 2019-09-05 07:57:41 -0400 |
commit | 1e7c079048c555306a308f6cce42fd688e89d77e (patch) | |
tree | 04a409d2ef4714638ab896c72c4321d5f67e01aa | |
parent | 9736541957927d2d77e4e5bd55aac46cb0d34240 (diff) |
ecore-wl2: Fix formatting and remove duplicate EAPI
Fix some doxygen formatting issues and remove a duplicated EAPI in
front of function.
NB: No functional changes
-rw-r--r-- | src/lib/ecore_wl2/Ecore_Wl2.h | 39 |
1 files changed, 33 insertions, 6 deletions
diff --git a/src/lib/ecore_wl2/Ecore_Wl2.h b/src/lib/ecore_wl2/Ecore_Wl2.h index 7be0d4fd55..2df3a9804a 100644 --- a/src/lib/ecore_wl2/Ecore_Wl2.h +++ b/src/lib/ecore_wl2/Ecore_Wl2.h | |||
@@ -286,6 +286,7 @@ typedef struct _Ecore_Wl2_Event_Window_Rotation | |||
286 | int rotation, w, h, angle; | 286 | int rotation, w, h, angle; |
287 | Eina_Bool resize : 1; | 287 | Eina_Bool resize : 1; |
288 | } Ecore_Wl2_Event_Window_Rotation; | 288 | } Ecore_Wl2_Event_Window_Rotation; |
289 | |||
289 | typedef struct _Ecore_Wl2_Event_Window_Rotation Ecore_Wl2_Event_Window_Rotation_Change_Prepare; | 290 | typedef struct _Ecore_Wl2_Event_Window_Rotation Ecore_Wl2_Event_Window_Rotation_Change_Prepare; |
290 | typedef struct _Ecore_Wl2_Event_Window_Rotation Ecore_Wl2_Event_Window_Rotation_Change_Prepare_Done; | 291 | typedef struct _Ecore_Wl2_Event_Window_Rotation Ecore_Wl2_Event_Window_Rotation_Change_Prepare_Done; |
291 | typedef struct _Ecore_Wl2_Event_Window_Rotation Ecore_Wl2_Event_Window_Rotation_Change_Request; | 292 | typedef struct _Ecore_Wl2_Event_Window_Rotation Ecore_Wl2_Event_Window_Rotation_Change_Request; |
@@ -598,7 +599,6 @@ EAPI struct wl_shm *ecore_wl2_display_shm_get(Ecore_Wl2_Display *display); | |||
598 | * @param display The Ecore_Wl2_Display for which to retrieve the existing | 599 | * @param display The Ecore_Wl2_Display for which to retrieve the existing |
599 | * Wayland dmabuf interface from | 600 | * Wayland dmabuf interface from |
600 | * | 601 | * |
601 | * | ||
602 | * @return The wl_dmabuf which this Ecore_Wl2_Display is using | 602 | * @return The wl_dmabuf which this Ecore_Wl2_Display is using |
603 | * | 603 | * |
604 | * @ingroup Ecore_Wl2_Display_Group | 604 | * @ingroup Ecore_Wl2_Display_Group |
@@ -640,8 +640,11 @@ EAPI void ecore_wl2_display_screen_size_get(Ecore_Wl2_Display *display, int *w, | |||
640 | 640 | ||
641 | /** | 641 | /** |
642 | * Get all the Ecore_Wl2_Input from the display. | 642 | * Get all the Ecore_Wl2_Input from the display. |
643 | * | ||
643 | * @param display The display | 644 | * @param display The display |
645 | * | ||
644 | * @return A Eina_Iterator of Ecore_Wl2_Input or @c NULL on error | 646 | * @return A Eina_Iterator of Ecore_Wl2_Input or @c NULL on error |
647 | * | ||
645 | * @ingroup Ecore_Wl2_Display_Group | 648 | * @ingroup Ecore_Wl2_Display_Group |
646 | * @since 1.19 | 649 | * @since 1.19 |
647 | */ | 650 | */ |
@@ -649,9 +652,12 @@ EAPI Eina_Iterator *ecore_wl2_display_inputs_get(Ecore_Wl2_Display *display); | |||
649 | 652 | ||
650 | /** | 653 | /** |
651 | * Find a seat for a given display object using the seat id | 654 | * Find a seat for a given display object using the seat id |
655 | * | ||
652 | * @param display The display | 656 | * @param display The display |
653 | * @param id The seat id | 657 | * @param id The seat id |
658 | * | ||
654 | * @return The corresponding Ecore_Wl2_Input object or @c NULL if no match is found | 659 | * @return The corresponding Ecore_Wl2_Input object or @c NULL if no match is found |
660 | * | ||
655 | * @ingroup Ecore_Wl2_Display_Group | 661 | * @ingroup Ecore_Wl2_Display_Group |
656 | * @since 1.20 | 662 | * @since 1.20 |
657 | */ | 663 | */ |
@@ -659,9 +665,12 @@ EAPI Ecore_Wl2_Input *ecore_wl2_display_input_find(const Ecore_Wl2_Display *disp | |||
659 | 665 | ||
660 | /** | 666 | /** |
661 | * Find a seat for a given display object using the seat id | 667 | * Find a seat for a given display object using the seat id |
668 | * | ||
662 | * @param display The display | 669 | * @param display The display |
663 | * @param name The seat name | 670 | * @param name The seat name |
671 | * | ||
664 | * @return The corresponding Ecore_Wl2_Input object or @c NULL if no match is found | 672 | * @return The corresponding Ecore_Wl2_Input object or @c NULL if no match is found |
673 | * | ||
665 | * @ingroup Ecore_Wl2_Display_Group | 674 | * @ingroup Ecore_Wl2_Display_Group |
666 | * @since 1.20 | 675 | * @since 1.20 |
667 | */ | 676 | */ |
@@ -1183,6 +1192,7 @@ EAPI void ecore_wl2_window_aux_hint_del(Ecore_Wl2_Window *window, int id); | |||
1183 | 1192 | ||
1184 | /** | 1193 | /** |
1185 | * @brief Get the activated state of a window | 1194 | * @brief Get the activated state of a window |
1195 | * | ||
1186 | * @param window The window | 1196 | * @param window The window |
1187 | * @return @c EINA_TRUE if activated | 1197 | * @return @c EINA_TRUE if activated |
1188 | * | 1198 | * |
@@ -1193,6 +1203,7 @@ EAPI Eina_Bool ecore_wl2_window_activated_get(const Ecore_Wl2_Window *window); | |||
1193 | 1203 | ||
1194 | /** | 1204 | /** |
1195 | * @brief Set the seat for a popup window to be used with grab | 1205 | * @brief Set the seat for a popup window to be used with grab |
1206 | * | ||
1196 | * @param window The window | 1207 | * @param window The window |
1197 | * @param input The seat | 1208 | * @param input The seat |
1198 | * | 1209 | * |
@@ -1317,8 +1328,11 @@ EAPI Ecore_Wl2_Seat_Capabilities ecore_wl2_input_seat_capabilities_get(Ecore_Wl2 | |||
1317 | 1328 | ||
1318 | /** | 1329 | /** |
1319 | * Get the wayland's seat id from an input. | 1330 | * Get the wayland's seat id from an input. |
1331 | * | ||
1320 | * @param input The input | 1332 | * @param input The input |
1333 | * | ||
1321 | * @return The seat id | 1334 | * @return The seat id |
1335 | * | ||
1322 | * @ingroup Ecore_Wl2_Input_Group | 1336 | * @ingroup Ecore_Wl2_Input_Group |
1323 | * @since 1.19 | 1337 | * @since 1.19 |
1324 | */ | 1338 | */ |
@@ -1326,8 +1340,11 @@ EAPI unsigned int ecore_wl2_input_seat_id_get(Ecore_Wl2_Input *input) EINA_WARN_ | |||
1326 | 1340 | ||
1327 | /** | 1341 | /** |
1328 | * Get the display object of an input | 1342 | * Get the display object of an input |
1343 | * | ||
1329 | * @param input The input | 1344 | * @param input The input |
1345 | * | ||
1330 | * @return The display | 1346 | * @return The display |
1347 | * | ||
1331 | * @ingroup Ecore_Wl2_Input_Group | 1348 | * @ingroup Ecore_Wl2_Input_Group |
1332 | * @since 1.20 | 1349 | * @since 1.20 |
1333 | */ | 1350 | */ |
@@ -1335,8 +1352,11 @@ EAPI Ecore_Wl2_Display *ecore_wl2_input_display_get(const Ecore_Wl2_Input *input | |||
1335 | 1352 | ||
1336 | /** | 1353 | /** |
1337 | * Get the xkb_keymap object of an input | 1354 | * Get the xkb_keymap object of an input |
1355 | * | ||
1338 | * @param input The input | 1356 | * @param input The input |
1357 | * | ||
1339 | * @return The xkb_keymap object | 1358 | * @return The xkb_keymap object |
1359 | * | ||
1340 | * @ingroup Ecore_Wl2_Input_Group | 1360 | * @ingroup Ecore_Wl2_Input_Group |
1341 | * @since 1.20 | 1361 | * @since 1.20 |
1342 | */ | 1362 | */ |
@@ -1344,8 +1364,11 @@ EAPI struct xkb_keymap *ecore_wl2_input_keymap_get(const Ecore_Wl2_Input *input) | |||
1344 | 1364 | ||
1345 | /** | 1365 | /** |
1346 | * Get the name of an input | 1366 | * Get the name of an input |
1367 | * | ||
1347 | * @param input The input | 1368 | * @param input The input |
1369 | * | ||
1348 | * @return The name | 1370 | * @return The name |
1371 | * | ||
1349 | * @ingroup Ecore_Wl2_Input_Group | 1372 | * @ingroup Ecore_Wl2_Input_Group |
1350 | * @since 1.20 | 1373 | * @since 1.20 |
1351 | */ | 1374 | */ |
@@ -1353,10 +1376,13 @@ EAPI Eina_Stringshare *ecore_wl2_input_name_get(Ecore_Wl2_Input *input); | |||
1353 | 1376 | ||
1354 | /** | 1377 | /** |
1355 | * Get the keyboard repeat rate and delay of an input | 1378 | * Get the keyboard repeat rate and delay of an input |
1379 | * | ||
1356 | * @param input The input | 1380 | * @param input The input |
1357 | * @param rate Pointer to store the repeat rate (in seconds) | 1381 | * @param rate Pointer to store the repeat rate (in seconds) |
1358 | * @param rate Pointer to store the repeat delay (in seconds) | 1382 | * @param rate Pointer to store the repeat delay (in seconds) |
1383 | * | ||
1359 | * @return True if repeat is enabled | 1384 | * @return True if repeat is enabled |
1385 | * | ||
1360 | * @ingroup Ecore_Wl2_Input_Group | 1386 | * @ingroup Ecore_Wl2_Input_Group |
1361 | * @since 1.20 | 1387 | * @since 1.20 |
1362 | */ | 1388 | */ |
@@ -1364,9 +1390,12 @@ EAPI Eina_Bool ecore_wl2_input_keyboard_repeat_get(const Ecore_Wl2_Input *input, | |||
1364 | 1390 | ||
1365 | /** | 1391 | /** |
1366 | * Get the Evas_Device for the seat belonging to a window from an input | 1392 | * Get the Evas_Device for the seat belonging to a window from an input |
1393 | * | ||
1367 | * @param input The input | 1394 | * @param input The input |
1368 | * @param window The window | 1395 | * @param window The window |
1396 | * | ||
1369 | * @return The device object | 1397 | * @return The device object |
1398 | * | ||
1370 | * @ingroup Ecore_Wl2_Input_Group | 1399 | * @ingroup Ecore_Wl2_Input_Group |
1371 | * @since 1.20 | 1400 | * @since 1.20 |
1372 | */ | 1401 | */ |
@@ -1426,7 +1455,6 @@ EAPI void ecore_wl2_input_cursor_from_name_set(Ecore_Wl2_Input *input, const cha | |||
1426 | * This call initializes a data source and offeres the given mimetypes | 1455 | * This call initializes a data source and offeres the given mimetypes |
1427 | * | 1456 | * |
1428 | * @param input the input where to add on the data source | 1457 | * @param input the input where to add on the data source |
1429 | * | ||
1430 | * @param types a null-terminated array of mimetypes | 1458 | * @param types a null-terminated array of mimetypes |
1431 | * | 1459 | * |
1432 | * @ingroup Ecore_Wl2_Dnd_Group | 1460 | * @ingroup Ecore_Wl2_Dnd_Group |
@@ -1438,10 +1466,9 @@ EAPI void ecore_wl2_dnd_drag_types_set(Ecore_Wl2_Input *input, const char **type | |||
1438 | * Start a drag on the given input | 1466 | * Start a drag on the given input |
1439 | * | 1467 | * |
1440 | * @param input the input to use | 1468 | * @param input the input to use |
1441 | * | ||
1442 | * @param window the window which is the origin of the drag operation | 1469 | * @param window the window which is the origin of the drag operation |
1443 | * | ||
1444 | * @param drag_window the window which is used as window of the visible hint. | 1470 | * @param drag_window the window which is used as window of the visible hint. |
1471 | * | ||
1445 | * @return The serial for the start_drag request | 1472 | * @return The serial for the start_drag request |
1446 | * | 1473 | * |
1447 | * @ingroup Ecore_Wl2_Dnd_Group | 1474 | * @ingroup Ecore_Wl2_Dnd_Group |
@@ -1459,7 +1486,7 @@ EAPI uint32_t ecore_wl2_dnd_drag_start(Ecore_Wl2_Input *input, Ecore_Wl2_Window | |||
1459 | * @ingroup Ecore_Wl2_Dnd_Group | 1486 | * @ingroup Ecore_Wl2_Dnd_Group |
1460 | * @since 1.20 | 1487 | * @since 1.20 |
1461 | */ | 1488 | */ |
1462 | EAPI EAPI void ecore_wl2_dnd_set_actions(Ecore_Wl2_Input *input); | 1489 | EAPI void ecore_wl2_dnd_set_actions(Ecore_Wl2_Input *input); |
1463 | 1490 | ||
1464 | /** | 1491 | /** |
1465 | * End a drag started by a call to ecore_wl2_dnd_drag_start | 1492 | * End a drag started by a call to ecore_wl2_dnd_drag_start |
@@ -1487,7 +1514,6 @@ EAPI Ecore_Wl2_Offer* ecore_wl2_dnd_selection_get(Ecore_Wl2_Input *input); | |||
1487 | * where the caller of this api must write the data (encoded in the given mimetype) to the fd | 1514 | * where the caller of this api must write the data (encoded in the given mimetype) to the fd |
1488 | * | 1515 | * |
1489 | * @param input the input to provice this types on | 1516 | * @param input the input to provice this types on |
1490 | * | ||
1491 | * @param types a null-terminated array of mimetypes supported by the client | 1517 | * @param types a null-terminated array of mimetypes supported by the client |
1492 | * | 1518 | * |
1493 | * @return serial of request on success, 0 on failure | 1519 | * @return serial of request on success, 0 on failure |
@@ -1719,6 +1745,7 @@ EAPI int ecore_wl2_display_compositor_version_get(Ecore_Wl2_Display *disp); | |||
1719 | * @param offer Offer object to use | 1745 | * @param offer Offer object to use |
1720 | * | 1746 | * |
1721 | * @return or´ed values from Ecore_Wl2_Drag_Action which are describing the available actions | 1747 | * @return or´ed values from Ecore_Wl2_Drag_Action which are describing the available actions |
1748 | * | ||
1722 | * @ingroup Ecore_Wl2_Dnd_Group | 1749 | * @ingroup Ecore_Wl2_Dnd_Group |
1723 | * @since 1.19 | 1750 | * @since 1.19 |
1724 | */ | 1751 | */ |