* @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
*/
/**
* 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
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);
* 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
* 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.
* 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
* 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
/**
* 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.
/**
* 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.
*
* 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
* 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
/**
* @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
* @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);
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
*
/**
* @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).
* 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.
#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.
*
* @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
*/
}
/**
- * @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.
}
/**
- * @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
/**
* @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
/**
* 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.
*
/**
* 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.
/**
* 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
*/
* 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
/**
* Destroy a damage object
*
- * @param The damage object to destroy
+ * @param damage The damage object to destroy
*
* Destroys the damage object @p damage
*
/**
* 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
/**
* 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
/**
* 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
/**
* 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)
/**
* @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
/**
* 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.
*
* 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.
* @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
* 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
/**
* 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
/**
* 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
/**
* 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
/**
* 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)
* @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
* 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
projects / framework / uifw / ecore.git / commitdiff