doxygen docs: Fix all invalid @param names

There were quite a few of these...
This commit is contained in:
Xavi Artigas 2020-04-20 12:22:44 +02:00
parent 6b1ed0f573
commit e7f4bc4c2a
19 changed files with 36 additions and 39 deletions

View File

@ -68,7 +68,7 @@ EAPI int efl_loop_exit_code_process(Eina_Value *value);
/** /**
* @brief Get the future scheduler for the current loop. * @brief Get the future scheduler for the current loop.
* *
* @param[in] An object which is either a loop or a loop consumer * @param[in] obj An object which is either a loop or a loop consumer
* @return The current loop's future scheduler. * @return The current loop's future scheduler.
*/ */
EAPI Eina_Future_Scheduler *efl_loop_future_scheduler_get(const Eo *obj); EAPI Eina_Future_Scheduler *efl_loop_future_scheduler_get(const Eo *obj);

View File

@ -2396,7 +2396,7 @@ EAPI int ecore_con_url_status_code_get(Ecore_Con_Url *url_con);
/** /**
* @brief Sets a maximum upload speed. * @brief Sets a maximum upload speed.
* *
* @param url_con Connection object * @param url_obj Connection object
* @param max_speed Maximum upload speed, in bytes per second * @param max_speed Maximum upload speed, in bytes per second
*/ */
EAPI void ecore_con_url_limit_upload_speed(Ecore_Con_Url *url_obj, off_t max_speed); EAPI void ecore_con_url_limit_upload_speed(Ecore_Con_Url *url_obj, off_t max_speed);
@ -2404,7 +2404,7 @@ EAPI void ecore_con_url_limit_upload_speed(Ecore_Con_Url *url_obj, off_t max_spe
/** /**
* @brief Sets a maximum download speed. * @brief Sets a maximum download speed.
* *
* @param url_con Connection object * @param url_obj Connection object
* @param max_speed Maximum download speed, in bytes per second * @param max_speed Maximum download speed, in bytes per second
*/ */
EAPI void ecore_con_url_limit_download_speed(Ecore_Con_Url *url_obj, off_t max_speed); EAPI void ecore_con_url_limit_download_speed(Ecore_Con_Url *url_obj, off_t max_speed);

View File

@ -998,8 +998,8 @@ EAPI Eina_Bool ecore_drm_output_possible_crtc_get(Ecore_Drm_Output *output, unsi
* *
* @param output The Ecore_Drm_Output to set the mode on * @param output The Ecore_Drm_Output to set the mode on
* @param mode A valid Ecore_Drm_Output_Mode to set or NULL to disable the output * @param mode A valid Ecore_Drm_Output_Mode to set or NULL to disable the output
* @param X The X position to set this output to * @param x The X position to set this output to
* @param Y The Y position to set this output to * @param y The Y position to set this output to
* *
* @return @c EINA_TRUE on success, @c EINA_FALSE on failure * @return @c EINA_TRUE on success, @c EINA_FALSE on failure
* *

View File

@ -963,7 +963,7 @@ _ecore_drm_evdev_event_process(struct libinput_event *event)
/** /**
* @brief Set the axis size of the given device. * @brief Set the axis size of the given device.
* *
* @param dev The device to set the axis size to. * @param edev The device to set the axis size to.
* @param w The width of the axis. * @param w The width of the axis.
* @param h The height of the axis. * @param h The height of the axis.
* *

View File

@ -148,7 +148,7 @@ EAPI int ecore_drm2_shutdown(void);
* Read and process pending Drm events * Read and process pending Drm events
* *
* @param dev drm device * @param dev drm device
* @param ctx * @param drmctx
* *
* @return 0 on success, -1 otherwise * @return 0 on success, -1 otherwise
* *
@ -230,7 +230,7 @@ EAPI void ecore_drm2_device_pointer_xy_get(Ecore_Drm2_Device *device, int *x, in
/** /**
* Warp the pointer position to given coordinates * Warp the pointer position to given coordinates
* *
* @param dev * @param device
* @param x * @param x
* @param y * @param y
* *
@ -807,7 +807,7 @@ EAPI int ecore_drm2_output_rotation_get(Ecore_Drm2_Output *output);
/** /**
* Set the user data for the output's page flip handler * Set the user data for the output's page flip handler
* *
* @param output The output to update user data for * @param o The output to update user data for
* @param data The new user data pointer * @param data The new user data pointer
* *
* @ingroup Ecore_Drm2_Output_Group * @ingroup Ecore_Drm2_Output_Group
@ -840,7 +840,7 @@ EAPI unsigned int ecore_drm2_output_subpixel_get(const Ecore_Drm2_Output *output
* Set the relative mode for an output * Set the relative mode for an output
* *
* @param output The output to set relative mode * @param output The output to set relative mode
* @param relative The relative mode to set * @param mode The relative mode to set
* *
* @ingroup Ecore_Drm2_Output_Group * @ingroup Ecore_Drm2_Output_Group
* @since 1.21 * @since 1.21
@ -1005,7 +1005,7 @@ EAPI Eina_Bool ecore_drm2_fb_busy_get(Ecore_Drm2_Fb *fb);
* Releasing buffers committed to scanout will potentially cause flicker, * Releasing buffers committed to scanout will potentially cause flicker,
* so this is only done when the panic flag is set. * so this is only done when the panic flag is set.
* *
* @param output The output to force release * @param o The output to force release
* @param panic Try to release even buffers committed to scanout * @param panic Try to release even buffers committed to scanout
* *
* @return EINA_TRUE if a buffer was released * @return EINA_TRUE if a buffer was released
@ -1036,7 +1036,7 @@ EAPI void *ecore_drm2_fb_bo_get(Ecore_Drm2_Fb *fb);
* @param depth * @param depth
* @param bpp * @param bpp
* @param format * @param format
* @param stride * @param strides
* @param dmabuf_fd * @param dmabuf_fd
* @param dmabuf_fd_count * @param dmabuf_fd_count
* *

View File

@ -2077,7 +2077,7 @@ EAPI void ecore_imf_context_input_panel_position_set(Eco
* *
* @param[in] ctx An #Ecore_IMF_Context * @param[in] ctx An #Ecore_IMF_Context
* @param key The key of the prediction hint * @param key The key of the prediction hint
* @param data The data to replace * @param value The data to replace
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
* *
* This function modifies the data of @p key with @p data in the hash associated @p * This function modifies the data of @p key with @p data in the hash associated @p

View File

@ -836,10 +836,11 @@ EAPI void ecore_wl_server_mode_set(Eina_Bool on);
* @brief Creates and returns a new subsurface. * @brief Creates and returns a new subsurface.
* *
* Create a new surface (and subsurface interface), with the parent surface * Create a new surface (and subsurface interface), with the parent surface
* being the one associated with the given @param win. * being the one associated with the given @p win.
* *
* The @param win must be visible, otherwise there will be no surface created * @p win must be visible, otherwise there will be no surface created
* for it yet. * for it yet.
* @param win The window
* *
* @return the allocated and initialized Ecore_Wl_Subsurf object, or * @return the allocated and initialized Ecore_Wl_Subsurf object, or
* NULL on failure * NULL on failure
@ -900,8 +901,8 @@ EAPI void ecore_wl_subsurf_position_get(Ecore_Wl_Subsurf *ess, int *x, int *y);
* @ingroup Ecore_Wl_Subsurf * @ingroup Ecore_Wl_Subsurf
* @brief Places subsurface on layer above a reference surface. * @brief Places subsurface on layer above a reference surface.
* *
* Moves the @param ess subsurface to just above the reference @param * Moves the @p ess subsurface to just above the reference
* surface, changing the z-order. The reference @param surface must * @p surface, changing the z-order. The reference @p surface must
* be either a sibling or parent surface, else a protocol error will * be either a sibling or parent surface, else a protocol error will
* be generated. * be generated.
* *

View File

@ -702,15 +702,12 @@ EAPI Eina_Bool ecore_win32_clipboard_set(const Ecore_Win32_Window *window,
* @brief Get data from the clipboard. * @brief Get data from the clipboard.
* *
* @param[in] window The window that owns the clipboard. * @param[in] window The window that owns the clipboard.
* @param[out] data The retrieved data.
* @param[out] size The size of the data. * @param[out] size The size of the data.
* @param[in] mime_type The mime type describing the data in the clipboard. * @param[in] mime_type The mime type describing the data in the clipboard.
* @return #EINA_TRUE on success, #EINA_FALSE otherwise. * @return The retrieved data.
* *
* This function gets @p data of size @p size from the clipboard owned by * This function gets data of size @p size from the clipboard owned by
* @p window. This function returns #EINA_TRUE on success, and * @p window. @p size must be a valid buffer.
* #EINA_FALSE otherwise. If @p window is @c NULL, this function returns
* #EINA_FALSE. @p data and @p size must be valid buffers.
* *
* @since 1.24 * @since 1.24
*/ */

View File

@ -1809,7 +1809,7 @@ EAPI Eina_Bool edje_mmap_group_exists(Eina_File *f, const char *glob);
/** /**
* @brief Determines whether a group have 3D Scene. * @brief Determines whether a group have 3D Scene.
* @param f The mapped file * @param f The mapped file
* @param glob The group name * @param group The group name
* *
* @return @c 1 if a Scene is found is found, @c 0 otherwise * @return @c 1 if a Scene is found is found, @c 0 otherwise
* *

View File

@ -274,7 +274,7 @@ EAPI const char *elm_datetime_format_get(const Evas_Object *obj);
* *
* There is no provision to set the limits of AM/PM field. * There is no provision to set the limits of AM/PM field.
* *
* @param[in] fieldtype Type of the field. #ELM_DATETIME_YEAR etc. * @param[in] type Type of the field. #ELM_DATETIME_YEAR etc.
* @param[in] min Reference to field's minimum value. * @param[in] min Reference to field's minimum value.
* @param[in] max Reference to field's maximum value. * @param[in] max Reference to field's maximum value.
* *

View File

@ -68,7 +68,7 @@ elm_validator_regexp_free(Elm_Validator_Regexp *validator) EINA_ARG_NONNULL(1);
/** /**
* @brief Get the validation status. * @brief Get the validation status.
* *
* @param The given validator * @param validator The given validator
* *
* @note All return value see here: http://www.gnu.org/software/libc/manual/html_node/Regular-Expressions.html * @note All return value see here: http://www.gnu.org/software/libc/manual/html_node/Regular-Expressions.html
* *

View File

@ -508,7 +508,7 @@ EAPI void elm_scroller_movement_block_set(Evas_Object *o
/** /**
* @brief Get a scroller's scroll blocking state * @brief Get a scroller's scroll blocking state
* *
* @param parent The scroller object * @param obj The scroller object
* @return The blocking state * @return The blocking state
* *
* @since 1.8 * @since 1.8

View File

@ -696,7 +696,7 @@ EAPI Elm_Win_Indicator_Opacity_Mode elm_win_indicator_opacity_get(const Evas_Obj
/** /**
* @brief Sets whether the window is a keyboard. * @brief Sets whether the window is a keyboard.
* *
* @param[in] mode If true, the window is a virtual keyboard.. * @param[in] is_keyboard If true, the window is a virtual keyboard..
* *
* @ingroup Elm_Win * @ingroup Elm_Win
*/ */

View File

@ -194,7 +194,6 @@ EAPI int elput_shutdown(void);
* *
* @param seat * @param seat
* @param tty * @param tty
* @param sync
* *
* @return A Elput_Manager on success, NULL on failure * @return A Elput_Manager on success, NULL on failure
* *

View File

@ -23,7 +23,7 @@ EAPI Eina_Strbuf *emile_base64_encode(const Eina_Binbuf *in);
/** /**
* @brief base64 url and filename safe encoding function. * @brief base64 url and filename safe encoding function.
* @param src The buffer to be encoded. * @param in The buffer to be encoded.
* @return the base64 url encoded string. * @return the base64 url encoded string.
* *
* This will create a string which is base64 encoded with url and * This will create a string which is base64 encoded with url and
@ -37,7 +37,7 @@ EAPI Eina_Strbuf *emile_base64url_encode(const Eina_Binbuf *in);
/** /**
* @brief base64 decoding function. * @brief base64 decoding function.
* @param src The string to be decoded. * @param in The string to be decoded.
* @return the base64 decoded buffer. * @return the base64 decoded buffer.
* *
* This will create a buffer which is base64 decode of the src. * This will create a buffer which is base64 decode of the src.
@ -49,7 +49,7 @@ EAPI Eina_Binbuf* emile_base64_decode(const Eina_Strbuf *in);
/** /**
* @brief decoding function for base64 url and filename safe encoding. * @brief decoding function for base64 url and filename safe encoding.
* @param src The string to be decoded. * @param in The string to be decoded.
* @return the base64 url decoded buffer. * @return the base64 url decoded buffer.
* *
* This will create a buffer which is base64 url decode of the src. * This will create a buffer which is base64 url decode of the src.

View File

@ -953,7 +953,7 @@ EAPI Evas_Device *evas_device_add_full(Evas *e, const char *name,
Evas_Device *parent_dev, Evas_Device *parent_dev,
Evas_Device *emulation_dev, Evas_Device *emulation_dev,
Evas_Device_Class clas, Evas_Device_Class clas,
Evas_Device_Subclass sub_clas); Evas_Device_Subclass sub_class);
/** /**
* Delete a new device type * Delete a new device type
@ -1055,7 +1055,7 @@ EAPI Evas_Device *evas_device_get(Evas *e, const char *name);
/** /**
* Get a device by its seat id * Get a device by its seat id
* *
* @param e The canvas to find the device on * @param eo_e The canvas to find the device on
* @param id The seat id of the device. * @param id The seat id of the device.
* *
* Gets the device with id @p id on Evas @p e list of devices. * Gets the device with id @p id on Evas @p e list of devices.

View File

@ -5162,7 +5162,7 @@ EAPI void evas_object_image_animated_frame_set(Evas_Object *obj, int frame_index
* @ref evas_object_image_animated_frame_set. * @ref evas_object_image_animated_frame_set.
* *
* @param[in] obj The object * @param[in] obj The object
* @param[in] frame_index The index of current frame. * @return The index of current frame.
* *
* @since 1.24 * @since 1.24
*/ */
@ -6080,7 +6080,7 @@ EAPI Eina_Bool evas_object_image_source_clip_get(const Evas_Object *obj);
* on it. * on it.
* *
* @param[in] obj The object * @param[in] obj The object
* @param[in] source Whether @c obj is to pass events ($true) or not ($false). * @param[in] repeat Whether @c obj is to pass events ($true) or not ($false).
* *
* @since 1.8 * @since 1.8
*/ */

View File

@ -1018,7 +1018,7 @@ EAPI void evas_textblock_cursor_line_char_last(Evas_Textblock_Cursor *cur);
* Set the cursor pos. * Set the cursor pos.
* *
* @param cur the cursor to be set. * @param cur the cursor to be set.
* @param pos the pos to set. * @param _pos the pos to set.
*/ */
EAPI void evas_textblock_cursor_pos_set(Evas_Textblock_Cursor *cur, int _pos); EAPI void evas_textblock_cursor_pos_set(Evas_Textblock_Cursor *cur, int _pos);
@ -1071,7 +1071,7 @@ EAPI Evas_Textblock_Cursor *evas_object_textblock_cursor_get(const Evas_Object *
/** Get the object's content it options. /** Get the object's content it options.
* *
* @param obj The textblock object. * @param obj The textblock object.
* @param[out] options content fitting options. * @param[out] p_options content fitting options.
* @return Returns error code. * @return Returns error code.
*/ */
EAPI int evas_textblock_fit_options_get(const Evas_Object *obj, unsigned int * p_options); EAPI int evas_textblock_fit_options_get(const Evas_Object *obj, unsigned int * p_options);

View File

@ -146,7 +146,7 @@ EAPI int munmap(void *addr,
* *
* @param addr Pointer to the base address. * @param addr Pointer to the base address.
* @param len Length of the memory. * @param len Length of the memory.
* @param New protection. * @param prot New protection.
* @return 0 on success, -1 otherwise. * @return 0 on success, -1 otherwise.
* *
* Changes protection for the calling process' memory page. * Changes protection for the calling process' memory page.