From 8b6d230f5bfed840e2d12195d1f96c602c76da0d Mon Sep 17 00:00:00 2001 From: Vincent Torri Date: Thu, 5 Apr 2012 07:00:42 +0000 Subject: [PATCH] Ecore: doc fixes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Patch by Jérôme Pinot SVN revision: 69928 --- legacy/ecore/src/lib/ecore/ecore_exe.c | 1 + legacy/ecore/src/lib/ecore/ecore_getopt.c | 2 ++ legacy/ecore/src/lib/ecore/ecore_timer.c | 3 ++- legacy/ecore/src/lib/ecore_evas/Ecore_Evas.h | 1 + legacy/ecore/src/lib/ecore_file/ecore_file.c | 9 ++++----- legacy/ecore/src/lib/ecore_ipc/ecore_ipc.c | 3 ++- legacy/ecore/src/lib/ecore_x/Ecore_X.h | 1 + legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_dpms.c | 1 + legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_randr.c | 7 ++++--- legacy/ecore/src/lib/ecore_x/xlib/ecore_x_window_prop.c | 3 +-- 10 files changed, 19 insertions(+), 12 deletions(-) diff --git a/legacy/ecore/src/lib/ecore/ecore_exe.c b/legacy/ecore/src/lib/ecore/ecore_exe.c index 958df4c437..b59d2cc370 100644 --- a/legacy/ecore/src/lib/ecore/ecore_exe.c +++ b/legacy/ecore/src/lib/ecore/ecore_exe.c @@ -867,6 +867,7 @@ ecore_exe_auto_limits_set(Ecore_Exe *exe, * * @param exe The given process handle. * @param flags Is this a ECORE_EXE_PIPE_READ or ECORE_EXE_PIPE_ERROR? + * @return The event data. */ EAPI Ecore_Exe_Event_Data * ecore_exe_event_data_get(Ecore_Exe *exe, diff --git a/legacy/ecore/src/lib/ecore/ecore_getopt.c b/legacy/ecore/src/lib/ecore/ecore_getopt.c index d334d2d309..8d023dc97f 100644 --- a/legacy/ecore/src/lib/ecore/ecore_getopt.c +++ b/legacy/ecore/src/lib/ecore/ecore_getopt.c @@ -1863,6 +1863,7 @@ ecore_getopt_list_free(Eina_List *list) * @param str Geometry value * @param storage must be a pointer to @c Eina_Rectangle and will be used to * store the four values passed in the given string. + * @return EINA_TRUE on success, EINA_FALSE on incorrect geometry value. * * @c callback_data value is ignored, you can safely use @c NULL. */ @@ -1891,6 +1892,7 @@ ecore_getopt_callback_geometry_parse(const Ecore_Getopt *parser __UNUSED__, * @param storage must be a pointer to @c Eina_Rectangle and will be used to * store the two values passed in the given string and 0 in the x and y * fields. + * @return EINA_TRUE on success, EINA_FALSE on incorrect size value. * * @c callback_data value is ignored, you can safely use @c NULL. */ diff --git a/legacy/ecore/src/lib/ecore/ecore_timer.c b/legacy/ecore/src/lib/ecore/ecore_timer.c index 45b5b81929..15facc3994 100644 --- a/legacy/ecore/src/lib/ecore/ecore_timer.c +++ b/legacy/ecore/src/lib/ecore/ecore_timer.c @@ -63,7 +63,7 @@ static double precision = 10.0 / 1000000.0; /** * Retrieves the current precision used by timer infrastructure. - * + * @return Current precision. * @see ecore_timer_precision_set() */ EAPI double @@ -332,6 +332,7 @@ ecore_timer_reset(Ecore_Timer *timer) * Get the pending time regarding a timer. * * @param timer The timer to learn from. + * @return The pending time. * @ingroup Ecore_Timer_Group */ EAPI double diff --git a/legacy/ecore/src/lib/ecore_evas/Ecore_Evas.h b/legacy/ecore/src/lib/ecore_evas/Ecore_Evas.h index 75bdfc3d1b..c12b1dc2bb 100644 --- a/legacy/ecore/src/lib/ecore_evas/Ecore_Evas.h +++ b/legacy/ecore/src/lib/ecore_evas/Ecore_Evas.h @@ -990,6 +990,7 @@ EAPI Ecore_Evas *ecore_evas_ews_new(int x, int y, int w, int h); /** * Returns the backing store image object that represents the given * window in EWS. + * @return The evas object of EWS backing store. * * @note This should not be modified anyhow, but may be helpful to * determine stacking and geometry of it for window managers diff --git a/legacy/ecore/src/lib/ecore_file/ecore_file.c b/legacy/ecore/src/lib/ecore_file/ecore_file.c index cb037178cd..5ec2e996a5 100644 --- a/legacy/ecore/src/lib/ecore_file/ecore_file.c +++ b/legacy/ecore/src/lib/ecore_file/ecore_file.c @@ -841,11 +841,10 @@ ecore_file_ls(const char *dir) * @brief Return the executable from the given command. * * @param app The application command, with parameters. - * - * This function returns the executable from @p app as a newly - * allocated string. Arguments are removed and escae characters are - * handled. If @p app is @c NULL, or on failure, the function returns - * @c NULL. When not needed anymore, the returned value must be freed. + * @return The executable from @p app as a newly allocated string. Arguments + * are removed and escape characters are handled. If @p app is @c NULL, or + * on failure, the function returns @c NULL. When not needed anymore, the + * returned value must be freed. */ EAPI char * ecore_file_app_exe_get(const char *app) diff --git a/legacy/ecore/src/lib/ecore_ipc/ecore_ipc.c b/legacy/ecore/src/lib/ecore_ipc/ecore_ipc.c index 0210f1d3ac..775cc89dfc 100644 --- a/legacy/ecore/src/lib/ecore_ipc/ecore_ipc.c +++ b/legacy/ecore/src/lib/ecore_ipc/ecore_ipc.c @@ -946,9 +946,10 @@ ecore_ipc_client_data_size_max_set(Ecore_Ipc_Client *cl, int size) } /** - * Sets the max data payload size for an Ipc message in bytes + * Gets the max data payload size for an Ipc message in bytes * * @param cl The given client. + * @return The maximum data payload size in bytes on success, @c -1 on failure. * @ingroup Ecore_Ipc_Client_Group */ EAPI int diff --git a/legacy/ecore/src/lib/ecore_x/Ecore_X.h b/legacy/ecore/src/lib/ecore_x/Ecore_X.h index 336b6569de..463c9b69a0 100644 --- a/legacy/ecore/src/lib/ecore_x/Ecore_X.h +++ b/legacy/ecore/src/lib/ecore_x/Ecore_X.h @@ -3470,6 +3470,7 @@ EAPI const char * /** * Given a keyname, return the keycode representing that key + * @return The keycode of the key. * * @since 1.2.0 */ diff --git a/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_dpms.c b/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_dpms.c index 324717ce5f..9e6f6c7089 100644 --- a/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_dpms.c +++ b/legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_dpms.c @@ -197,6 +197,7 @@ ecore_x_dpms_timeouts_get(unsigned int *standby, * @param standby Amount of time of inactivity before standby mode will be invoked. * @param suspend Amount of time of inactivity before the screen is placed into suspend mode. * @param off Amount of time of inactivity before the monitor is shut off. + * @return EINA_TRUE on success, EINA_FALSE on failure. * @ingroup Ecore_X_DPMS_Group */ EAPI Eina_Bool 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 81a7c3fd07..142259aa63 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 @@ -941,7 +941,8 @@ ecore_x_randr_mode_size_get(Ecore_X_Window root, * comparison functions, since it includes 0-bytes. * @param root window this information should be queried from * @param output the XID of the output - * @param length length of the byte-array. If NULL, request will fail. + * @param length length of the byte-array. If @c NULL, request will fail. + * @return EDID information of the output. */ EAPI unsigned char * ecore_x_randr_output_edid_get(Ecore_X_Window root, @@ -989,11 +990,11 @@ ecore_x_randr_output_edid_get(Ecore_X_Window root, } /** - * @brief gets the the outputs which might be used simultenously on the same - * CRTC. + * @brief gets the outputs which might be used simultaneously on the same CRTC. * @param root window that this information should be queried for. * @param output the output which's clones we concern * @param num number of possible clones + * @return The existing outputs, @c NULL otherwise. */ EAPI Ecore_X_Randr_Output * ecore_x_randr_output_clones_get(Ecore_X_Window root, 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 b581a0ef38..1ebe7a77af 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 @@ -630,8 +630,7 @@ ecore_x_window_prop_string_set(Ecore_X_Window win, * Get a window string property. * @param win The window * @param type The property - * - * Return window string property of a window. String must be free'd when done. + * @return Window string property of a window. String must be free'd when done. */ EAPI char * ecore_x_window_prop_string_get(Ecore_X_Window win,