doxygen docs: Fix all invalid @param names
authorXavi Artigas <xavierartigas@yahoo.es>
Mon, 20 Apr 2020 10:22:44 +0000 (12:22 +0200)
committerJongmin Lee <jm105.lee@samsung.com>
Mon, 20 Apr 2020 21:11:28 +0000 (06:11 +0900)
There were quite a few of these...

19 files changed:
src/lib/ecore/Ecore_Eo.h
src/lib/ecore_con/Ecore_Con.h
src/lib/ecore_drm/Ecore_Drm.h
src/lib/ecore_drm/ecore_drm_evdev.c
src/lib/ecore_drm2/Ecore_Drm2.h
src/lib/ecore_imf/Ecore_IMF.h
src/lib/ecore_wayland/Ecore_Wayland.h
src/lib/ecore_win32/Ecore_Win32.h
src/lib/edje/Edje_Common.h
src/lib/elementary/elm_datetime.h
src/lib/elementary/elm_helper.h
src/lib/elementary/elm_scroller_legacy.h
src/lib/elementary/elm_win_legacy.h
src/lib/elput/Elput.h
src/lib/emile/emile_base64.h
src/lib/evas/Evas_Common.h
src/lib/evas/Evas_Legacy.h
src/lib/evas/canvas/evas_textblock_legacy.h
src/lib/evil/evil_mman.h

index a15a1c1265eed08752dbb954f43894d7f08c0beb..f0e7eee057f676cddfb1b95219907c279f6ea20b 100644 (file)
@@ -72,7 +72,7 @@ EAPI int efl_loop_exit_code_process(Eina_Value *value);
 /**
  * @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.
  */
 EAPI Eina_Future_Scheduler *efl_loop_future_scheduler_get(const Eo *obj);
index 1a8841021f1d1cc083f755b1aff5e61e990c46fa..fc7fd91c520d30d3c4286f81b1a8b3e2e4cae8a8 100644 (file)
@@ -2396,7 +2396,7 @@ EAPI int ecore_con_url_status_code_get(Ecore_Con_Url *url_con);
 /**
  * @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
  */
 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.
  *
- * @param url_con Connection object
+ * @param url_obj Connection object
  * @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);
index ad60ca37c9f7484d7d52aa731bce9880f518d6b1..6d87efded562cb603b27808951f39a6c07b089cd 100644 (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 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 Y The Y 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
  *
  * @return @c EINA_TRUE on success, @c EINA_FALSE on failure
  *
index 4fa66bc076cd549884329c7eb4907fab0b2814ac..c907769be9569b3e800daa0c581ab5056a821218 100644 (file)
@@ -963,7 +963,7 @@ _ecore_drm_evdev_event_process(struct libinput_event *event)
 /**
  * @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 h The height of the axis.
  *
index 5c43258177decae9f8334139af54cd84204e4595..26e55b670aa953f47858b84e4311d5d30bd2495d 100644 (file)
@@ -148,7 +148,7 @@ EAPI int ecore_drm2_shutdown(void);
  * Read and process pending Drm events
  *
  * @param dev drm device
- * @param ctx
+ * @param drmctx
  *
  * @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
  *
- * @param dev
+ * @param device
  * @param x
  * @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
  *
- * @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
  *
  * @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
  *
  * @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
  * @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,
  * 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
  *
  * @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 bpp
  * @param format
- * @param stride
+ * @param strides
  * @param dmabuf_fd
  * @param dmabuf_fd_count
  *
index 0651224cee7424c806fd72a87d45d0a73c8d9071..d7e1b390b1e8699ee4836d4edf901229b604f184 100644 (file)
@@ -2078,7 +2078,7 @@ EAPI void                         ecore_imf_context_input_panel_position_set(Eco
  *
  * @param[in] ctx An #Ecore_IMF_Context
  * @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
  *
  * This function modifies the data of @p key with @p data in the hash associated @p
index a6334bb4935fbbb7e79383be2296e05b152a0f22..b3a71bf052b629503b6342b4cd8db56e376dfdd8 100644 (file)
@@ -1297,10 +1297,11 @@ EAPI Eina_Bool ecore_wl_server_mode_get(void);
  * @brief Creates and returns a new subsurface.
  *
  * 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.
+ * @param win The window
  *
  * @return the allocated and initialized Ecore_Wl_Subsurf object, or
  * NULL on failure
@@ -1366,8 +1367,8 @@ EAPI void ecore_wl_subsurf_position_get(Ecore_Wl_Subsurf *ess, int *x, int *y);
  * @ingroup Ecore_Wl_Subsurf
  * @brief Places subsurface on layer above a reference surface.
  *
- * Moves the @param ess subsurface to just above the reference @param
- * surface, changing the z-order.  The reference @param surface must
+ * Moves the @p ess subsurface to just above the reference
+ * @p surface, changing the z-order.  The reference @p surface must
  * be either a sibling or parent surface, else a protocol error will
  * be generated.
  *
index 8f36b278f5f53ee0041c07cd48087d3032dcff3f..fbd0ad7ab781765538d4053875434b59a403d8df 100644 (file)
@@ -706,15 +706,12 @@ EAPI Eina_Bool ecore_win32_clipboard_set(const Ecore_Win32_Window *window,
  * @brief Get data from 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[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
- * @p window. This function returns #EINA_TRUE on success, and
- * #EINA_FALSE otherwise. If @p window is @c NULL, this function returns
- * #EINA_FALSE. @p data and @p size must be valid buffers.
+ * This function gets data of size @p size from the clipboard owned by
+ * @p window. @p size must be a valid buffer.
  *
  * @since 1.24
  */
index d04f694e6780d32293ef402398d0205a3d030eef..b79b5afa2aa3463888abf6971e878ea4e00aee48 100644 (file)
@@ -2328,7 +2328,7 @@ EAPI Eina_Bool         edje_mmap_group_exists(Eina_File *f, const char *glob);
 /**
  * @brief Determines whether a group have 3D Scene.
  * @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
  *
index 73855925e1b3f8e2fd3004cd5cbf6c36076bd032..b775130a769e87d42b9e6e562d4c88f694bf31da 100644 (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.
  *
- * @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] max Reference to field's maximum value.
  *
index 488372939aeed7b0458b697c8e7a1cac610db878..a0ae990a81ff7eac7931423086ef95dc762f1c7e 100644 (file)
@@ -68,7 +68,7 @@ elm_validator_regexp_free(Elm_Validator_Regexp *validator) EINA_ARG_NONNULL(1);
 /**
  * @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
  *
index 76748986c425720857ef8607be235c2cbe60b7c9..8d50f4a62a73d419ff44a4eb7a4d71626430bc93 100644 (file)
@@ -508,7 +508,7 @@ EAPI void                         elm_scroller_movement_block_set(Evas_Object *o
 /**
  * @brief Get a scroller's scroll blocking state
  *
- * @param parent The scroller object
+ * @param obj The scroller object
  * @return The blocking state
  *
  * @since 1.8
index 1af5afac3c73730fe50bf2916f74d8917b6fe5cc..fe9b5ce5648c191ddf83af645cf7a6cd8a2f31cd 100644 (file)
@@ -697,7 +697,7 @@ EAPI Elm_Win_Indicator_Opacity_Mode elm_win_indicator_opacity_get(const Evas_Obj
 /**
  * @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
  */
index cc0570e8ccf90de0c9b4b495d942b2c744fc7495..eb9e0a15dbae344bba15860ee20c432081295a4b 100644 (file)
@@ -194,7 +194,6 @@ EAPI int elput_shutdown(void);
  *
  * @param seat
  * @param tty
- * @param sync
  *
  * @return A Elput_Manager on success, NULL on failure
  *
index 7e677458a2a90b2e84de8200bcafbd159d315f75..0502031fbcb395cac019a230ec007ec5b39d8a24 100644 (file)
@@ -23,7 +23,7 @@ EAPI Eina_Strbuf *emile_base64_encode(const Eina_Binbuf *in);
 
 /**
  * @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.
  *
  * 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.
- * @param src The string to be decoded.
+ * @param in The string to be decoded.
  * @return the base64 decoded buffer.
  *
  * 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.
- * @param src The string to be decoded.
+ * @param in The string to be decoded.
  * @return the base64 url decoded buffer.
  *
  * This will create a buffer which is base64 url decode of the src.
index 4e3ac49787b87d9967b1b6477675ef3735272f03..1402ce47b7a0a36ec01cd09ade854953891a1c88 100644 (file)
@@ -964,7 +964,7 @@ EAPI Evas_Device *evas_device_add_full(Evas *e, const char *name,
                                        Evas_Device *parent_dev,
                                        Evas_Device *emulation_dev,
                                        Evas_Device_Class clas,
-                                       Evas_Device_Subclass sub_clas);
+                                       Evas_Device_Subclass sub_class);
 
 /**
  * Delete a new device type
@@ -1066,7 +1066,7 @@ EAPI Evas_Device *evas_device_get(Evas *e, const char *name);
 /**
  * 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.
  *
  * Gets the device with id @p id on Evas @p e list of devices.
index efc4fd8008ad830c0552769fcc450ce982ee6f3b..a4487efc210a0a69962a1ef57643093f3e0ef7f2 100755 (executable)
@@ -5265,7 +5265,7 @@ EAPI void evas_object_image_animated_frame_set(Evas_Object *obj, int frame_index
  * @ref evas_object_image_animated_frame_set.
  *
  * @param[in] obj The object
- * @param[in] frame_index The index of current frame.
+ * @return The index of current frame.
  *
  * @since 1.24
  */
@@ -6183,7 +6183,7 @@ EAPI Eina_Bool evas_object_image_source_clip_get(const Evas_Object *obj);
  * on it.
  *
  * @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
  */
index e79a0c23c1a9fae851c6b6a111a5bcd2ac938a25..78ad78511ead136c226b75573fa3f4b8d1c3edb4 100644 (file)
@@ -1035,7 +1035,7 @@ EAPI void evas_textblock_cursor_line_char_last(Evas_Textblock_Cursor *cur);
  * Set the cursor pos.
  *
  * @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);
 
@@ -1088,7 +1088,7 @@ EAPI Evas_Textblock_Cursor *evas_object_textblock_cursor_get(const Evas_Object *
 /** Get the object's content it options.
  *
  * @param obj The textblock object.
- * @param[out] options content fitting options.
+ * @param[out] p_options content fitting options.
  * @return Returns error code.
  */
 EAPI int evas_textblock_fit_options_get(const Evas_Object *obj,  unsigned int * p_options);
index c9c57aa5e077fbb9a950141c72c53a46b660bff2..97f56681b0415bdf1260506be899ed0f32d0fdd8 100644 (file)
@@ -146,7 +146,7 @@ EAPI int   munmap(void  *addr,
  *
  * @param addr Pointer to the base address.
  * @param len  Length of the memory.
- * @param New protection.
+ * @param prot New protection.
  * @return 0 on success, -1 otherwise.
  *
  * Changes protection for the calling process' memory page.