timer23
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

ecore - Various patches in ecore's doc 

Hello e people, i modified some comments to get less doxygen
warnings/errors.

Signed-Off-By: Guillaume Friloux <guillaume.friloux@asp64.com>




SVN revision: 67270
This commit is contained in:
Guillaume Friloux 2012-01-17 11:37:35 +00:00 committed by ChunEon Park
parent a70fc50208
commit 14ff0e1ae0
21 changed files with 48 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
legacy/ecore/doc/examples.dox
View File

@ -940,7 +940,7 @@
* @example ecore_con_url_headers_example.c
* Shows how to make GET or POST requests using an @ref Ecore_Con_Url object,
* and make use of most of its API. See the complete example description at
* @ref ecore_con_headers_example_c
* @ref ecore_con_url_headers_example_c
*/
/**
@ -1394,7 +1394,7 @@
* On this example, we accomplish the very same task, but by using the
* @c Ecore_Evas helper wrapper functions on a buffer engine
* canvas. If you compare both codes, you'll see how much code one is
* saved from by using the @Ecore_Evas wrapper functions.
* saved from by using the @c Ecore_Evas wrapper functions.
*
* The code is simple as it can be. After instantianting our canvas
* window, with ecore_evas_buffer_new(), we grab its canvas pointer

8
legacy/ecore/src/lib/ecore/Ecore.h
View File

@ -398,7 +398,7 @@ EAPI extern Ecore_Version *ecore_version;
typedef Eina_Bool (*Ecore_Task_Cb)(void *data);
/**
* @typedef Ecore_Eselect_Function Ecore_Eselect_Function
* @typedef Ecore_Eselect_Function
* A function which can be used to replace select() in the main loop
*/
typedef int (*Ecore_Select_Function)(int nfds, fd_set *readfds, fd_set *writefds, fd_set *exceptfds, struct timeval *timeout);
@ -846,7 +846,7 @@ EAPI void *ecore_main_win32_handler_del(Ecore_Win32_Handler *win32_handler);
* areound a core poll interval. For now only 1 core poller type is
* supprted: ECORE_POLLER_CORE
*
* Example of @ref Ecore_Poller:
* Example of @ref Ecore_Poller :
* @li @ref ecore_poller_example_c
*
* @ingroup Ecore_Main_Loop_Group
@ -1621,7 +1621,7 @@ EAPI Eina_Bool ecore_thread_feedback(Ecore_Thread *thread, const void *msg_data)
* EINA_FALSE if anything goes wrong.
*
* This function should be called only from the same function represented
* by @pthread.
* by @p thread.
*
* Calling this function will mark the thread for a reschedule, so as soon
* as it returns, it will be added to the end of the list of pending tasks.
@ -2082,7 +2082,7 @@ EAPI int ecore_pipe_wait(Ecore_Pipe *p, int message_count, double wait);
* will be processed first). This also gives the chance to other
* actions in your program to cancel the job before it is started.
*
* Examples of using @ref Ecore_Job:
* Examples of using @ref Ecore_Job :
* @li @ref ecore_job_example_c
*
* @ingroup Ecore_Main_Loop_Group

8
legacy/ecore/src/lib/ecore/ecore_getopt.c
View File

@ -1763,7 +1763,7 @@ _ecore_getopt_find_help(const Ecore_Getopt *parser)
* will be applied on them if ecore was compiled with such support.
*
* @param parser description of how to work.
* @param value where to store values, it is assumed that this is a vector
* @param values where to store values, it is assumed that this is a vector
* of the same size as @c parser->descs. Values should be previously
* initialized.
* @param argc how many elements in @a argv. If not provided it will be
@ -1855,7 +1855,8 @@ ecore_getopt_list_free(Eina_List *list)
/**
* Helper ecore_getopt callback to parse geometry (x:y:w:h).
*
* Storage must be a pointer to @c Eina_Rectangle and will be used to
* @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.
*
* @c callback_data value is ignored, you can safely use @c NULL.
@ -1881,7 +1882,8 @@ ecore_getopt_callback_geometry_parse(const Ecore_Getopt *parser __UNUSED__,
/**
* Helper ecore_getopt callback to parse geometry size (WxH).
*
* Storage must be a pointer to @c Eina_Rectangle and will be used to
* @param str size value
* @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.
*

2
legacy/ecore/src/lib/ecore_con/Ecore_Con.h
View File

@ -1637,7 +1637,7 @@ EAPI Eina_Bool ecore_con_url_post(Ecore_Con_Url *url_con,
* modification time.
*
* @param url_con Ecore_Con_Url to act upon.
* @param condition Condition to use for HTTP requests.
* @param time_condition Condition to use for HTTP requests.
* @param timestamp Time since 1 Jan 1970 to use in the condition.
*
* This function may set the header "If-Modified-Since" or

2
legacy/ecore/src/lib/ecore_con/ecore_con_ssl.c
View File

@ -819,7 +819,7 @@ ecore_con_ssl_server_upgrade(Ecore_Con_Server *svr, Ecore_Con_Type ssl_type)
* Once the upgrade has been completed, an ECORE_CON_EVENT_CLIENT_UPGRADE event will be emitted.
* The connection should be treated as disconnected until the next event.
* @param cl The client object
* @param compl_type The SSL connection type (ONLY).
* @param ssl_type The SSL connection type (ONLY).
* @return EINA_FALSE if the connection cannot be upgraded, otherwise EINA_TRUE.
* @warning Setting a wrong value for @p compl_type WILL mess up your program.
* @since 1.1

8
legacy/ecore/src/lib/ecore_evas/Ecore_Evas.h
View File

@ -827,7 +827,7 @@ EAPI void ecore_evas_ews_delete_request(Ecore_Evas *ee);
/**
* @brief Create an Evas image object with image data <b>bound to an
* own, internal @c Ecore_Evas canvas wrapper<b>
* own, internal @c Ecore_Evas canvas wrapper</b>
*
* @param ee_target @c Ecore_Evas to have the canvas receiving the new
* image object
@ -1329,7 +1329,7 @@ EAPI void ecore_evas_size_base_get(const Ecore_Evas *ee, int *w, int *h);
* @param h The step height
*
* This function sets the size steps of @p ee to be @p w x @p h. This
* limits the size of this @cEcore_Evas window to be @b always an
* limits the size of this @c Ecore_Evas window to be @b always an
* integer multiple of the step size, for each axis.
*/
EAPI void ecore_evas_size_step_set(Ecore_Evas *ee, int w, int h);
@ -1781,7 +1781,7 @@ EAPI Ecore_Evas *ecore_evas_extn_socket_new(int w, int h);
EAPI Eina_Bool ecore_evas_extn_socket_listen(Ecore_Evas *ee, const char *svcname, int svcnum, Eina_Bool svcsys);
/**
* @briefLock the pixel data so the socket cannot change it
* @brief Lock the pixel data so the socket cannot change it
*
* @param obj The image object returned by ecore_evas_extn_plug_new() to lock
*
@ -1853,7 +1853,7 @@ EAPI Evas_Object *ecore_evas_extn_plug_new(Ecore_Evas *ee_target);
/**
* @brief Connect a external ecore evas plug to service provided by external ecore evas socket
*
* @param ee_target The Ecore_Evas containing the canvas in which the new image object will live.
* @param obj The Ecore_Evas containing the canvas in which the new image object will live.
* @param svcname The service name to connect to set up by the socket.
* @param svcnum The service number to connect to (set up by socket).
* @param svcsys Booleain to set if the service is a system one or not (set up by socket).

2
legacy/ecore/src/lib/ecore_evas/ecore_evas.c
View File

@ -2005,7 +2005,7 @@ ecore_evas_fullscreen_get(const Ecore_Evas *ee)
* Set whether or not an Ecore_Evas' window should avoid damage
*
* @param ee The Ecore_Evas
* @param The type of the damage management
* @param on The type of the damage management
*
* This function causes @p ee to be drawn to a pixmap to avoid recalculations.
* On expose events it will copy from the pixmap to the window.

6
legacy/ecore/src/lib/ecore_fb/ecore_fb_li.c
View File

@ -454,9 +454,9 @@ ecore_fb_input_device_listen(Ecore_Fb_Input_Device *dev, Eina_Bool listen)
#endif
/**
* @brief Associates an input device with the given @ref Ecore_Evas.
* @brief Associates an input device with the given @ref Ecore_Evas_Group.
*
* @param dev The input being associated with an @ref Ecore_Evas (not @c NULL).
* @param dev The input being associated with an @ref Ecore_Evas_Group (not @c NULL).
* @param window The window which this input is being associated to.
* @c NULL will remove any previous association.
*
@ -477,7 +477,7 @@ ecore_fb_input_device_listen(Ecore_Fb_Input_Device *dev, Eina_Bool listen)
* @endcode
*
* On the previous code, all input captured on the mentioned device will be
* delivered to the @Ecore_Evas @c ee.
* delivered to the @c Ecore_Evas @c ee.
*
* @since 1.1
*/

4
legacy/ecore/src/lib/ecore_file/ecore_file.c
View File

@ -758,7 +758,7 @@ ecore_file_can_write(const char *file)
}
/**
* @bbrief Check if the given file can be executed.
* @brief Check if the given file can be executed.
*
* @param file The name of the file.
* @return EINA_TRUE if the file can be executed, EINA_FALSE otherwise.
@ -1037,7 +1037,7 @@ ecore_file_escape_name(const char *filename)
}
/**
* @bried Remove the extension from the given file name.
* @brief Remove the extension from the given file name.
*
* @param path The name of the file.
* @return A newly allocated string with the extension stripped out or

2
legacy/ecore/src/lib/ecore_file/ecore_file_path.c
View File

@ -86,7 +86,7 @@ _ecore_file_path_from_env(const char *env)
/**
* @brief Check if the given directory is in PATH.
*
* @param The name of the directory to search in PATH.
* @param in_dir The name of the directory to search in PATH.
* @return EINA_TRUE if the directory exist in PATH, EINA_FALSE otherwise.
*
* This function checks if @p in_dir is in the environment variable

4
legacy/ecore/src/lib/ecore_imf/ecore_imf_context.c
View File

@ -529,7 +529,7 @@ ecore_imf_context_cursor_location_set(Ecore_IMF_Context *ctx, int x, int y, int
/**
* Set whether the IM context should use the preedit string
* to display feedback. If @use_preedit is EINA_FALSE (default
* to display feedback. If @c use_preedit is EINA_FALSE (default
* is EINA_TRUE), then the IM context may use some other method to display
* feedback, such as displaying it in a child of the root window.
*
@ -551,7 +551,7 @@ ecore_imf_context_use_preedit_set(Ecore_IMF_Context *ctx, Eina_Bool use_preedit)
/**
* Set whether the IM context should allow to use the text prediction.
* If @prediction is EINA_FALSE (default is EINA_TRUE), then the IM context will not display the text prediction window.
* If @c prediction is EINA_FALSE (default is EINA_TRUE), then the IM context will not display the text prediction window.
*
* @param ctx An #Ecore_IMF_Context.
* @param prediction Whether the IM context should allow to use the text prediction.

3
legacy/ecore/src/lib/ecore_ipc/ecore_ipc.c
View File

@ -926,7 +926,7 @@ ecore_ipc_client_data_get(Ecore_Ipc_Client *cl)
/**
* Sets the max data payload size for an Ipc message in bytes
*
* @param client The given client.
* @param cl The given client.
* @param size The maximum data payload size in bytes.
* @ingroup Ecore_Ipc_Client_Group
*/
@ -946,7 +946,6 @@ 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
*
* @param cl The given client.
* @param size The maximum data payload size in bytes.
* @ingroup Ecore_Ipc_Client_Group
*/
EAPI int

2
legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_damage.c
View File

@ -99,7 +99,7 @@ ecore_x_damage_new(Ecore_X_Drawable drawable,
/**
* Destroy a damage object
*
* @param The damage object to destroy
* @param damage The damage object to destroy
*
* Destroys the damage object @p damage
*

6
legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_dpms.c
View File

@ -270,7 +270,7 @@ ecore_x_dpms_timeout_off_get(void)
/**
* Sets the standby timeout (in unit of seconds).
* @param new_standby Amount of time of inactivity before standby mode will be invoked.
* @param new_timeout Amount of time of inactivity before standby mode will be invoked.
* @ingroup Ecore_X_DPMS_Group
*/
EAPI void
@ -286,7 +286,7 @@ ecore_x_dpms_timeout_standby_set(unsigned int new_timeout)
/**
* Sets the suspend timeout (in unit of seconds).
* @param suspend Amount of time of inactivity before the screen is placed into suspend mode.
* @param new_timeout Amount of time of inactivity before the screen is placed into suspend mode.
* @ingroup Ecore_X_DPMS_Group
*/
EAPI void
@ -302,7 +302,7 @@ ecore_x_dpms_timeout_suspend_set(unsigned int new_timeout)
/**
* Sets the off timeout (in unit of seconds).
* @param off Amount of time of inactivity before the monitor is shut off.
* @param new_timeout Amount of time of inactivity before the monitor is shut off.
* @ingroup Ecore_X_DPMS_Group
*/
EAPI void

2
legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_icccm.c
View File

@ -396,7 +396,7 @@ ecore_x_icccm_transient_for_set(Ecore_X_Window win,
/**
* Remove the transient_for setting from a window.
* @param The window
* @param win The window
*/
EAPI void
ecore_x_icccm_transient_for_unset(Ecore_X_Window win)

6
legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_randr.c
View File

@ -1528,9 +1528,9 @@ ecore_x_randr_crtc_geometry_get(Ecore_X_Window root,
/**
* @brief sets a CRTC relative to another one.
* @param crtc_r1 the CRTC to be positioned.
* @param crtc_r2 the CRTC the position should be relative to
* @param position the relation between the crtcs
* @param crtc1 the CRTC to be positioned.
* @param crtc2 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
* @return EINA_TRUE if crtc could be successfully positioned. EINA_FALSE if

14
legacy/ecore/src/lib/ecore_x/xcb/ecore_xcb_xfixes.c
View File

@ -178,7 +178,7 @@ ecore_x_region_new_from_bitmap(Ecore_X_Pixmap bitmap)
/**
* Create a region from a window.
* @param window The window used to initialize the region.
* @param win The window used to initialize the region.
* @param type The type of the region.
* @return The newly created region.
*
@ -609,8 +609,8 @@ ecore_x_region_expand(Ecore_X_Region dest,
* Change clip-mask in a graphic context to the specified region.
* @param region The region to change.
* @param gc The clip-mask graphic context.
* @param x_origin The horizontal translation.
* @param y_origin The vertical translation.
* @param x The horizontal translation.
* @param y The vertical translation.
*
* Changes clip-mask in @p gc to the specified @p region and
* sets the clip origin with the values of @p x_origin and @p y_origin.
@ -643,8 +643,8 @@ ecore_x_region_gc_clip_set(Ecore_X_Region region,
* @param region The region.
* @param dest The window whose shape is changed.
* @param type The kind of shape.
* @param x_offset The horizontal offset.
* @param y_offset The vertical offset.
* @param x The horizontal offset.
* @param y The vertical offset.
*
* Set the specified Shape extension region of @p window to @p region,
* offset by @p x_offset and @p y_offset. Future changes to region
@ -673,8 +673,8 @@ ecore_x_region_window_shape_set(Ecore_X_Region region,
* Change clip-mask in picture to the specified region.
* @param region The region.
* @param picture The picture.
* @param x_origin The X coordinate of the origin.
* @param y_origin The Y coordinate of the origin.
* @param x The X coordinate of the origin.
* @param y The Y coordinate of the origin.
*
* Changes clip-mask in picture to the specified @p region
* and sets the clip origin. Input and output will be clipped to

6
legacy/ecore/src/lib/ecore_x/xlib/ecore_x_dpms.c
View File

@ -196,7 +196,7 @@ ecore_x_dpms_timeout_off_get(void)
/**
* Sets the standby timeout (in unit of seconds).
* @param new_standby Amount of time of inactivity before standby mode will be invoked.
* @param new_timeout Amount of time of inactivity before standby mode will be invoked.
* @ingroup Ecore_X_DPMS_Group
*/
EAPI void
@ -213,7 +213,7 @@ ecore_x_dpms_timeout_standby_set(unsigned int new_timeout)
/**
* Sets the suspend timeout (in unit of seconds).
* @param suspend Amount of time of inactivity before the screen is placed into suspend mode.
* @param new_timeout Amount of time of inactivity before the screen is placed into suspend mode.
* @ingroup Ecore_X_DPMS_Group
*/
EAPI void
@ -230,7 +230,7 @@ ecore_x_dpms_timeout_suspend_set(unsigned int new_timeout)
/**
* Sets the off timeout (in unit of seconds).
* @param off Amount of time of inactivity before the monitor is shut off.
* @param new_timeout Amount of time of inactivity before the monitor is shut off.
* @ingroup Ecore_X_DPMS_Group
*/
EAPI void

2
legacy/ecore/src/lib/ecore_x/xlib/ecore_x_icccm.c
View File

@ -1096,7 +1096,7 @@ ecore_x_icccm_transient_for_set(Ecore_X_Window win,
/**
* Remove the transient_for setting from a window.
* @param The window
* @param win The window
*/
EAPI void
ecore_x_icccm_transient_for_unset(Ecore_X_Window win)

2
legacy/ecore/src/lib/ecore_x/xlib/ecore_x_randr_12.c
View File

@ -1064,7 +1064,7 @@ ecore_x_randr_crtc_settings_set(Ecore_X_Window root,
* @brief sets a CRTC relative to another one.
* @param crtc_r1 the CRTC to be positioned.
* @param crtc_r2 the CRTC the position should be relative to
* @param position the relation between the crtcs
* @param policy the relation between the crtcs
* @param alignment in case CRTCs size differ, aligns CRTC1 accordingly at CRTC2's
* borders
* @return EINA_TRUE if crtc could be successfully positioned. EINA_FALSE if

2
legacy/ecore/src/lib/ecore_x/xlib/ecore_x_selection.c
View File

@ -732,7 +732,7 @@ ecore_x_selection_parser_del(const char *target)
* Change the owner and last-change time for the specified selection.
* @param win The owner of the specified atom.
* @param atom The selection atom
* @param time Specifies the time
* @param tim Specifies the time
* @since 1.1.0
*/
EAPI void