From: Jonas M. Gastal Date: Mon, 23 Apr 2012 20:09:55 +0000 (+0000) Subject: Cleanup Doxygen Warnings - ecore 4 X-Git-Tag: submit/devel/efl/20131022.203902~5869 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=a1e12eddbbdc661d24ae9966c763061c58a50d6b;p=platform%2Fupstream%2Fefl.git Cleanup Doxygen Warnings - ecore 4 Files modified: ecore/src/lib/ecore_wayland/ecore_wl_window.c ecore/src/lib/ecore_x/xcb/ecore_xcb.c ecore/src/lib/ecore_x/xcb/ecore_xcb_randr.c ecore/src/lib/ecore_x/xcb/ecore_xcb_window.c ecore/src/lib/ecore_x/xcb/ecore_xcb_window_shadow.c ecore/src/lib/ecore_x/xlib/ecore_x.c ecore/src/lib/ecore_x/xlib/ecore_x_randr_12.c ecore/src/lib/ecore_x/xlib/ecore_x_window.c ecore/src/lib/ecore_x/xlib/ecore_x_window_prop.c SVN revision: 70424 --- diff --git a/legacy/ecore/src/lib/ecore_wayland/ecore_wl_window.c b/legacy/ecore/src/lib/ecore_wayland/ecore_wl_window.c index 932f4de..431e480 100644 --- a/legacy/ecore/src/lib/ecore_wayland/ecore_wl_window.c +++ b/legacy/ecore/src/lib/ecore_wayland/ecore_wl_window.c @@ -51,6 +51,7 @@ _ecore_wl_window_shutdown(void) * @param y Y position * @param w Width * @param h Height + * @param buffer_type The type of the buffer to be used to create a new Ecore_Wl_Window. * * @return The new window * diff --git a/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb.c b/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb.c index a36bd48..17d17af 100644 --- a/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb.c +++ b/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb.c @@ -305,6 +305,8 @@ ecore_x_shutdown(void) * * As ecore_x_shutdown, except do not close Display, only connection. * + * @return The number of times the library has been initialized without + * being shut down. 0 is returned if an error occurs. * @ingroup Ecore_X_Init_Group */ EAPI int @@ -408,6 +410,7 @@ ecore_x_ungrab(void) * * @param win The window the message is sent to. * @param type The client message type. + * @param mask The mask of the message to be sent. * @param d0 The client message data item 1 * @param d1 The client message data item 2 * @param d2 The client message data item 3 @@ -1176,6 +1179,7 @@ ecore_x_screen_count_get(void) /** * Retrieves the index number of the given screen. * + * @param screen The screen for which index will be gotten. * @return The index number of the screen. * @ingroup Ecore_X_Display_Attr_Group * @@ -1204,6 +1208,7 @@ ecore_x_screen_index_get(const Ecore_X_Screen *screen) /** * Retrieves the screen based on index number. * + * @param index The index that will be used to retrieve the screen. * @return The Ecore_X_Screen at this index. * @ingroup Ecore_X_Display_Attr_Group * diff --git a/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_randr.c b/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_randr.c index 114766b..a07e286 100644 --- a/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_randr.c +++ b/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_randr.c @@ -1059,6 +1059,7 @@ ecore_x_randr_output_possible_crtcs_get(Ecore_X_Window root, /** * @brief gets the given output's name as reported by X * @param root the window which's screen will be queried + * @param output The output name given to be reported. * @param len length of returned c-string. * @return name of the output as reported by X */ @@ -1219,7 +1220,7 @@ EAPI Eina_Bool ecore_x_randr_crtc_settings_set(Ecore_X_Window root, Ecore_X_Randr_Crtc crtc, Ecore_X_Randr_Output *outputs, - int num, + int noutputs, int x, int y, Ecore_X_Randr_Mode mode, @@ -1255,15 +1256,15 @@ ecore_x_randr_crtc_settings_set(Ecore_X_Window root, xcb_randr_set_crtc_config_reply_t *sreply; if ((mode == Ecore_X_Randr_None) || - (num == Ecore_X_Randr_None)) + (noutputs == Ecore_X_Randr_None)) { outputs = NULL; - num = 0; + noutputs = 0; } - else if (num == (int)Ecore_X_Randr_Unset) + else if (noutputs == (int)Ecore_X_Randr_Unset) { outputs = xcb_randr_get_crtc_info_outputs(creply); - num = creply->num_outputs; + noutputs = creply->num_outputs; } if ((int)mode == Ecore_X_Randr_Unset) mode = creply->mode; if (x < 0) x = creply->x; @@ -1275,7 +1276,7 @@ ecore_x_randr_crtc_settings_set(Ecore_X_Window root, xcb_randr_set_crtc_config_unchecked(_ecore_xcb_conn, crtc, XCB_CURRENT_TIME, stamp, x, y, mode, orientation, - num, outputs); + noutputs, outputs); sreply = xcb_randr_set_crtc_config_reply(_ecore_xcb_conn, scookie, NULL); if (sreply) @@ -1298,7 +1299,7 @@ ecore_x_randr_crtc_settings_set(Ecore_X_Window root, * @param crtc The CRTC which shall be set * @param outputs Array of outputs which have to be compatible with the mode. If * @c NULL CRTC will be disabled. - * @param num Number of outputs in array to be used. Use + * @param noutputs Number of outputs in array to be used. Use * Ecore_X_Randr_Unset (or @c -1) to use currently used outputs. * @param mode XID of the mode to be set. If set to @c 0 the CRTC will be * disabled. If set to @c -1 the call will fail. @@ -1309,7 +1310,7 @@ EAPI Eina_Bool ecore_x_randr_crtc_mode_set(Ecore_X_Window root, Ecore_X_Randr_Crtc crtc, Ecore_X_Randr_Output *outputs, - int num, + int noutputs, Ecore_X_Randr_Mode mode) { Eina_Bool ret = EINA_FALSE; @@ -1322,7 +1323,7 @@ ecore_x_randr_crtc_mode_set(Ecore_X_Window root, if ((int)mode == Ecore_X_Randr_Unset) return ret; ret = - ecore_x_randr_crtc_settings_set(root, crtc, outputs, num, + ecore_x_randr_crtc_settings_set(root, crtc, outputs, noutputs, Ecore_X_Randr_Unset, Ecore_X_Randr_Unset, mode, Ecore_X_Randr_Unset); #endif @@ -1752,8 +1753,9 @@ ecore_x_randr_crtc_geometry_get(Ecore_X_Window root, /** * @brief Sets a CRTC relative to another one. * - * @param crtc1 The CRTC to be positioned. - * @param crtc2 The CRTC the position should be relative to. + * @param root The window on which CRTC's position will be set. + * @param crtc_r1 The CRTC to be positioned. + * @param crtc_r2 The CRTC the position should be relative to. * @param policy The relation between the crtcs. * @param alignment In case CRTCs size differ, aligns CRTC1 accordingly at * CRTC2's borders. @@ -1763,8 +1765,8 @@ ecore_x_randr_crtc_geometry_get(Ecore_X_Window root, */ EAPI Eina_Bool ecore_x_randr_crtc_pos_relative_set(Ecore_X_Window root, - Ecore_X_Randr_Crtc crtc1, - Ecore_X_Randr_Crtc crtc2, + Ecore_X_Randr_Crtc crtc_r1, + Ecore_X_Randr_Crtc crtc_r2, Ecore_X_Randr_Output_Policy policy, Ecore_X_Randr_Relative_Alignment alignment) { @@ -1779,16 +1781,16 @@ ecore_x_randr_crtc_pos_relative_set(Ecore_X_Window root, #ifdef ECORE_XCB_RANDR RANDR_CHECK_1_2_RET(EINA_FALSE); - if ((ecore_x_randr_crtc_mode_get(root, crtc1) == 0) || - (ecore_x_randr_crtc_mode_get(root, crtc2) == 0)) + if ((ecore_x_randr_crtc_mode_get(root, crtc_r1) == 0) || + (ecore_x_randr_crtc_mode_get(root, crtc_r2) == 0)) return EINA_FALSE; - if ((!_ecore_xcb_randr_crtc_validate(root, crtc1) || - (!(crtc1 != crtc2) && (!_ecore_xcb_randr_crtc_validate(root, crtc2))))) + if ((!_ecore_xcb_randr_crtc_validate(root, crtc_r1) || + (!(crtc_r1 != crtc_r2) && (!_ecore_xcb_randr_crtc_validate(root, crtc_r2))))) return EINA_FALSE; - ecore_x_randr_crtc_geometry_get(root, crtc1, &r1.x, &r1.y, &r1.w, &r1.h); - ecore_x_randr_crtc_geometry_get(root, crtc2, &r2.x, &r2.y, &r2.w, &r2.h); + ecore_x_randr_crtc_geometry_get(root, crtc_r1, &r1.x, &r1.y, &r1.w, &r1.h); + ecore_x_randr_crtc_geometry_get(root, crtc_r2, &r2.x, &r2.y, &r2.w, &r2.h); ecore_x_randr_screen_size_range_get(root, NULL, NULL, &w_max, &h_max); ecore_x_randr_screen_current_size_get(root, &cw, &ch, NULL, NULL); @@ -1835,7 +1837,7 @@ ecore_x_randr_crtc_pos_relative_set(Ecore_X_Window root, break; case ECORE_X_RANDR_OUTPUT_POLICY_CLONE: - return ecore_x_randr_crtc_pos_set(root, crtc1, r2.x, r2.y); + return ecore_x_randr_crtc_pos_set(root, crtc_r1, r2.x, r2.y); break; case ECORE_X_RANDR_OUTPUT_POLICY_NONE: @@ -1846,7 +1848,7 @@ ecore_x_randr_crtc_pos_relative_set(Ecore_X_Window root, if (((yn + r1.h) > h_max) || ((xn + r1.w) > w_max)) return EINA_FALSE; - return ecore_x_randr_crtc_pos_set(root, crtc1, xn, yn); + return ecore_x_randr_crtc_pos_set(root, crtc_r1, xn, yn); #endif return EINA_FALSE; diff --git a/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_window.c b/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_window.c index 3458729..c1ea658 100644 --- a/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_window.c +++ b/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_window.c @@ -923,9 +923,9 @@ ecore_x_window_override_set(Ecore_X_Window win, } /** - * To be documented. - * - * FIXME: To be fixed. + * @brief Show the cursor on a window of type Ecore_X_Window. + * @param win The window for which the cursor will be showed. + * @param show Enables the show of the cursor on the window if equals EINA_TRUE, disables if equals EINA_FALSE. */ EAPI void ecore_x_window_cursor_show(Ecore_X_Window win, @@ -1628,6 +1628,8 @@ ecore_x_window_at_xy_get(int x, * but skips the windows in the list. * @param x The given X position. * @param y The given Y position. + * @param skip The list of windows to be skipped. + * @param skip_num The number of windows to be skipped. * @return The window at that position. * @ingroup Ecore_X_Window_Geometry_Group */ diff --git a/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_window_shadow.c b/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_window_shadow.c index 4f24d62..82326fa 100644 --- a/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_window_shadow.c +++ b/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_window_shadow.c @@ -348,7 +348,9 @@ _inside_rects(Shadow *s, * @param base The base window to start searching from (normally root). * @param x The given X position. * @param y The given Y position. - * @return The window at that position. + * @param skip The list of windows to be skipped. + * @param skip_num The number of windows to be skipped. + * @return The window at the desired position. * @ingroup Ecore_X_Window_Geometry_Group */ EAPI Ecore_X_Window diff --git a/legacy/ecore/src/lib/ecore_x/xlib/ecore_x.c b/legacy/ecore/src/lib/ecore_x/xlib/ecore_x.c index 96d84e0..4530b0c 100644 --- a/legacy/ecore/src/lib/ecore_x/xlib/ecore_x.c +++ b/legacy/ecore/src/lib/ecore_x/xlib/ecore_x.c @@ -692,7 +692,7 @@ _ecore_x_shutdown(int close_display) * and any event handlers for it are removed. * * @return The number of times the library has been initialized without - * being shut down. + * being shut down. 0 is returned if an error occurs. * @ingroup Ecore_X_Init_Group */ EAPI int @@ -798,6 +798,7 @@ ecore_x_screen_count_get(void) /** * Retrieves the index number of the given screen. * + * @param screen The screen for which the index will be retrieved. * @return The index number of the screen. * @ingroup Ecore_X_Display_Attr_Group * @@ -812,15 +813,16 @@ ecore_x_screen_index_get(const Ecore_X_Screen *screen) /** * Retrieves the screen based on index number. * + * @param index The index that will be used to retrieve the screen. * @return The Ecore_X_Screen at this index. * @ingroup Ecore_X_Display_Attr_Group * * @since 1.1 */ EAPI Ecore_X_Screen * -ecore_x_screen_get(int idx) +ecore_x_screen_get(int index) { - return XScreenOfDisplay(_ecore_x_disp, idx); + return XScreenOfDisplay(_ecore_x_disp, index); } /** @@ -1802,6 +1804,7 @@ ecore_x_window_key_ungrab(Ecore_X_Window win, * * @param win The window the message is sent to. * @param type The client message type. + * @param mask The mask of the message to be sent. * @param d0 The client message data item 1 * @param d1 The client message data item 2 * @param d2 The client message data item 3 diff --git a/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_randr_12.c b/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_randr_12.c index 32cddf8..8ec75cd 100644 --- a/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_randr_12.c +++ b/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_randr_12.c @@ -1702,6 +1702,7 @@ ecore_x_randr_output_crtc_get(Ecore_X_Window root, /** * @brief gets the given output's name as reported by X * @param root the window which's screen will be queried + * @param output The output for which the name will be reported. * @param len length of returned c-string. * @return name of the output as reported by X */ diff --git a/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_window.c b/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_window.c index 8f4399c..f16f5b1 100644 --- a/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_window.c +++ b/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_window.c @@ -769,9 +769,9 @@ ecore_x_window_depth_get(Ecore_X_Window win) } /** - * To be documented. - * - * FIXME: To be fixed. + * @brief Show the cursor on a window of type Ecore_X_Window. + * @param win The window for which the cursor will be showed. + * @param show Enables the show of the cursor on the window if equals EINA_TRUE, disables if equals EINA_FALSE. */ EAPI void ecore_x_window_cursor_show(Ecore_X_Window win, @@ -1173,6 +1173,8 @@ _ecore_x_window_shadow_tree_at_xy_get(Window base, * @param base The base window to start searching from (normally root). * @param x The given X position. * @param y The given Y position. + * @param skip The list of windows to be skipped. + * @param skip_num The number of windows to be skipped. * @return The window at that position. * @ingroup Ecore_X_Window_Geometry_Group */ @@ -1356,6 +1358,8 @@ ecore_x_window_at_xy_get(int x, * but skips the windows in the list. * @param x The given X position. * @param y The given Y position. + * @param skip The list of windows to be skipped. + * @param skip_num The number of windows to be skipped. * @return The window at that position. * @ingroup Ecore_X_Window_Geometry_Group */ diff --git a/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_window_prop.c b/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_window_prop.c index 1ebe7a7..a582453 100644 --- a/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_window_prop.c +++ b/legacy/ecore/src/lib/ecore_x/xlib/ecore_x_window_prop.c @@ -434,11 +434,6 @@ ecore_x_window_prop_window_list_get(Ecore_X_Window win, return ecore_x_window_prop_xid_list_get(win, atom, XA_WINDOW, plst); } -/** - * To be documented. - * - * FIXME: To be fixed. - */ EAPI Ecore_X_Atom ecore_x_window_prop_any_type(void) { @@ -446,9 +441,13 @@ ecore_x_window_prop_any_type(void) } /** - * To be documented. - * - * FIXME: To be fixed. + * @brief Set a property of Ecore_X_Window. + * @param win The window for which the property will be set. + * @param property The property of the window to be set. + * @param type The type of the property that will be set. + * @param size The size of the property that will be set. + * @param data The data of the property that will be set. + * @param number The size of data. */ EAPI void ecore_x_window_prop_property_set(Ecore_X_Window win, @@ -489,9 +488,16 @@ ecore_x_window_prop_property_set(Ecore_X_Window win, } /** - * To be documented. - * - * FIXME: To be fixed. + * @brief Get a property of Ecore_X_Window. + * @note If there aren't any data to be got the function return NULL. + * If the function can't allocate the memory then 0 is returned. + * @param win The window for which the property will be got. + * @param property The property of the window that will be gotten. + * @param type The type of the property that will be gotten. + * @param size This parameter isn't in use. + * @param data The data of the property that will be gotten. + * @param num The size of property. + * @return size_ret The size of array that contains the property. */ EAPI int ecore_x_window_prop_property_get(Ecore_X_Window win, @@ -707,9 +713,12 @@ ecore_x_window_prop_protocol_isset(Ecore_X_Window win, } /** - * To be documented. - * - * FIXME: To be fixed. + * @brief Get a array containing the protocols of @a win + * @note If there aren't any properties to be counted or any protocols to get + * then the function returns NULL. + * @param win The window for which protocol list will be got. + * @param num_ret Contains the number of elements of the array to be returned. + * @return The array that contains the protocols. */ EAPI Ecore_X_WM_Protocol * ecore_x_window_prop_protocol_list_get(Ecore_X_Window win,