xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=5b2d2a85b2c74ceabfe5da4dbf2a5c00f0b643e2
commit 5b2d2a85b2c74ceabfe5da4dbf2a5c00f0b643e2 Author: Xavi Artigas <[email protected]> Date: Tue Mar 10 10:20:24 2020 +0100 doxygen docs: Fix tons of invalid Doxygen commands Mostly typos --- src/lib/ecore_evas/Ecore_Evas.h | 8 ++++---- src/lib/ecore_wayland/session-recovery-client-protocol.h | 4 ---- src/lib/ecore_wl2/Ecore_Wl2.h | 2 +- src/lib/eeze/Eeze.h | 2 +- src/lib/eina/eina_freeq.h | 2 +- src/lib/eina/eina_inline_mempool.x | 4 ++-- src/lib/eina/eina_types.h | 8 ++++---- src/lib/eina/eina_ustrbuf.h | 2 +- src/lib/eio/Eio_Legacy.h | 2 -- src/lib/elementary/elm_focus_item.h | 4 ++-- src/lib/eo/Eo.h | 2 +- src/lib/evas/Evas_Legacy.h | 2 +- src/lib/evas/filters/evas_filter_parser.c | 2 +- src/lib/evil/evil_time.h | 4 ++-- 14 files changed, 21 insertions(+), 27 deletions(-) diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h index e3e8b63000..d484bb1b95 100644 --- a/src/lib/ecore_evas/Ecore_Evas.h +++ b/src/lib/ecore_evas/Ecore_Evas.h @@ -3186,7 +3186,7 @@ typedef void (*Ecore_Evas_Vnc_Client_Disconnected_Cb)(void *data, Ecore_Evas *ee * @param port The port number to start the VNC server. Use @c -1 to set the default VNC port (5900) * @param accept_cb A callback used to accept a new client. If @c NULL all clients will be accepted. * @param disc_cb A callback used to inform that a client has disconnected. It may be @c NULL. - * @param data Data to pass to @a accept_cb and @disc_cb + * @param data Data to pass to @p accept_cb and @p disc_cb * @return an Evas_Object that take everything under it to represent the view of the client. * * @see ecore_evas_vnc_stop() @@ -3809,7 +3809,7 @@ typedef void (*Ecore_Evas_Drag_State_Changed_Cb)(Ecore_Evas *ee, unsigned int se * @param[in] cb Method to call when the events are received. * * Only one such callback can exist for each Ecore_Evas. Calling this method multiple - * times overwrites previous functions. Use a NULL @cb func to stop being notified. + * times overwrites previous functions. Use a NULL @p cb func to stop being notified. */ EAPI void ecore_evas_callback_drop_state_changed_set(Ecore_Evas *ee, Ecore_Evas_Drag_State_Changed_Cb cb); @@ -3832,7 +3832,7 @@ typedef void (*Ecore_Evas_Drag_Motion_Cb)(Ecore_Evas *ee, unsigned int seat, Ein * @param[in] cb Method to call when the events are received. * * Only one such callback can exist for each Ecore_Evas. Calling this method multiple - * times overwrites previous functions. Use a NULL @cb func to stop being notified. + * times overwrites previous functions. Use a NULL @p cb func to stop being notified. */ EAPI void ecore_evas_callback_drop_motion_set(Ecore_Evas *ee, Ecore_Evas_Drag_Motion_Cb cb); @@ -3858,7 +3858,7 @@ typedef void (*Ecore_Evas_Drop_Cb)(Ecore_Evas *ee, unsigned int seat, Eina_Posit * @param[in] cb Method to call when the events are received. * * Only one such callback can exist for each Ecore_Evas. Calling this method multiple - * times overwrites previous functions. Use a NULL @cb func to stop being notified. + * times overwrites previous functions. Use a NULL @p cb func to stop being notified. */ EAPI void ecore_evas_callback_drop_drop_set(Ecore_Evas *ee, Ecore_Evas_Drop_Cb cb); diff --git a/src/lib/ecore_wayland/session-recovery-client-protocol.h b/src/lib/ecore_wayland/session-recovery-client-protocol.h index 24057471fb..5ea65c555d 100644 --- a/src/lib/ecore_wayland/session-recovery-client-protocol.h +++ b/src/lib/ecore_wayland/session-recovery-client-protocol.h @@ -17,10 +17,6 @@ struct zwp_e_session_recovery; extern const struct wl_interface zwp_e_session_recovery_interface; struct zwp_e_session_recovery_listener { - /** - * uuid - (none) - * @uuid: (none) - */ void (*uuid)(void *data, struct zwp_e_session_recovery *zwp_e_session_recovery, const char *uuid); diff --git a/src/lib/ecore_wl2/Ecore_Wl2.h b/src/lib/ecore_wl2/Ecore_Wl2.h index c68890cd74..85bfd134e8 100644 --- a/src/lib/ecore_wl2/Ecore_Wl2.h +++ b/src/lib/ecore_wl2/Ecore_Wl2.h @@ -1103,7 +1103,7 @@ EAPI void ecore_wl2_window_geometry_set(Ecore_Wl2_Window *window, int x, int y, * Set the type of a given window * * @param window The window to set the type of - * @type The Ecore_Wl2_Window_Type to set on the window + * @param type The Ecore_Wl2_Window_Type to set on the window * * @ingroup Ecore_Wl2_Window_Group * @since 1.17 diff --git a/src/lib/eeze/Eeze.h b/src/lib/eeze/Eeze.h index d6807262a6..a7d92f50bf 100644 --- a/src/lib/eeze/Eeze.h +++ b/src/lib/eeze/Eeze.h @@ -569,7 +569,7 @@ EAPI Eina_Bool eeze_udev_syspath_check_sysattr(const char *syspath, const char * * @param sysattr The sysattr to set; * @param value The value of sysattr to be set * @return @c EINA_TRUE if the sysattr value is set - * @Since 1.12 + * @since 1.12 */ EAPI Eina_Bool eeze_udev_syspath_set_sysattr(const char *syspath, const char *sysattr, double value); diff --git a/src/lib/eina/eina_freeq.h b/src/lib/eina/eina_freeq.h index a9c789c42e..acbc59b765 100644 --- a/src/lib/eina/eina_freeq.h +++ b/src/lib/eina/eina_freeq.h @@ -258,7 +258,7 @@ eina_freeq_reduce(Eina_FreeQ *fq, int count); * @brief Return if there are any items pending a free in the free queue * * @param[in] fq The free queue to query - * @raturn EINA_TRUE if there are items to free, EINA_FALSE otherwise + * @return EINA_TRUE if there are items to free, EINA_FALSE otherwise * * @since 1.19 */ diff --git a/src/lib/eina/eina_inline_mempool.x b/src/lib/eina/eina_inline_mempool.x index b0ab81587d..e0b8d24dad 100644 --- a/src/lib/eina/eina_inline_mempool.x +++ b/src/lib/eina/eina_inline_mempool.x @@ -58,12 +58,12 @@ struct _Eina_Mempool_Backend Eina_Bool (*from)(void *data, void *element); /** Function to get an Eina_Iterator that will walk every allocated element * in the pool. - * @use eina_mempool_iterator_new + * @see eina_mempool_iterator_new */ Eina_Iterator *(*iterator)(void *data); /** Function to allocate memory near already allocated memory. * @since 1.24 - * @use eina_mempool_malloc_near + * @see eina_mempool_malloc_near */ void *(*alloc_near)(void *data, void *after, void *before, unsigned int size); }; diff --git a/src/lib/eina/eina_types.h b/src/lib/eina/eina_types.h index eed37097de..33c8193015 100644 --- a/src/lib/eina/eina_types.h +++ b/src/lib/eina/eina_types.h @@ -423,7 +423,7 @@ /** * @def EINA_PREFETCH - * @brief Hints that the pointer @parg needs to be pre-fetched into cache + * @brief Hints that the pointer @p arg needs to be pre-fetched into cache * * This hints to the compiler to probably issue a prefetch command for the * memory address @p arg and ensure it goes into all levels of cache. For @@ -438,7 +438,7 @@ /** * @def EINA_PREFETCH_WRITE - * @brief Hints that the pointer @parg needs to be pre-fetched into cache + * @brief Hints that the pointer @p arg needs to be pre-fetched into cache * * This hints to the compiler to probably issue a prefetch command for the * memory address @p arg and ensure it goes into all levels of cache. This @@ -454,7 +454,7 @@ /** * @def EINA_PREFETCH_NOCACHE - * @brief Hints that the pointer @parg needs to be pre-fetched into cache + * @brief Hints that the pointer @p arg needs to be pre-fetched into cache * * This hints to the compiler to probably issue a prefetch command for the * memory address @p arg and ensure it goes into just the closest(l1) cache. @@ -470,7 +470,7 @@ /** * @def EINA_PREFETCH_NOCACHE_WRITE * - * @brief Hints that the pointer @parg needs to be pre-fetched into cache + * @brief Hints that the pointer @p arg needs to be pre-fetched into cache * * This hints to the compiler to probably issue a prefetch command for the * memory address @p arg and ensure it goes into just the closest(l1) cache. diff --git a/src/lib/eina/eina_ustrbuf.h b/src/lib/eina/eina_ustrbuf.h index 0030735a5d..8fe87afd65 100644 --- a/src/lib/eina/eina_ustrbuf.h +++ b/src/lib/eina/eina_ustrbuf.h @@ -325,7 +325,7 @@ EAPI Eina_Bool eina_ustrbuf_insert_char(Eina_UStrbuf *buf, Eina_Unicode c, size_ * @param[in,out] buf The string buffer. * @param[in] str The string to prepend. * @param[in] maxlen The maximum number of Eina_Unicode *s to prepend. - * @return #EINA_TRUE on success, #EINA_FALSE if @str could not be prepended. + * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be prepended. * * This macro simply calls eina_ustrbuf_insert_n() with position 0. */ diff --git a/src/lib/eio/Eio_Legacy.h b/src/lib/eio/Eio_Legacy.h index 90c1263856..fbdd6fc3e3 100644 --- a/src/lib/eio/Eio_Legacy.h +++ b/src/lib/eio/Eio_Legacy.h @@ -1254,7 +1254,6 @@ EAPI const char *eio_monitor_path_get(Eio_Monitor *monitor); * to check whether a monitor is a fallback monitor before relying on these events. * * @since 1.21 - * @beta */ EAPI Eina_Bool eio_monitor_fallback_check(const Eio_Monitor *monitor); @@ -1272,7 +1271,6 @@ EAPI Eina_Bool eio_monitor_fallback_check(const Eio_Monitor *monitor); * In case the monitor does not yet have context, you can be sure that the monitor will bring up an FILE_ADD event about that file. * * @since 1.23 - * @beta */ EAPI Eina_Bool eio_monitor_has_context(const Eio_Monitor *monitor, const char *path); #endif diff --git a/src/lib/elementary/elm_focus_item.h b/src/lib/elementary/elm_focus_item.h index 71c068a12c..aff1dfbfdf 100644 --- a/src/lib/elementary/elm_focus_item.h +++ b/src/lib/elementary/elm_focus_item.h @@ -9,8 +9,8 @@ * The focused item can be unfocused with function * elm_object_item_focus_set(). * - * see @elm_object_item_focus_set() - * see @elm_object_item_focus_get() + * @see elm_object_item_focus_set() + * @see elm_object_item_focus_get() * * @ingroup Elm_Focus * @since 1.10 diff --git a/src/lib/eo/Eo.h b/src/lib/eo/Eo.h index c85c2defd7..0ebbd53e9c 100644 --- a/src/lib/eo/Eo.h +++ b/src/lib/eo/Eo.h @@ -1233,7 +1233,7 @@ EAPI Efl_Id_Domain efl_domain_data_adopt(Efl_Domain_Data *data_in); EAPI Eina_Bool efl_domain_data_return(Efl_Id_Domain domain); /** - * @prief Check if 2 objects are compatible + * @brief Check if 2 objects are compatible * @param obj The basic object * @param obj_target The alternate object that may be referenced by @p obj * @return EINA_TRUE if compatible, EINA_FALSE if not diff --git a/src/lib/evas/Evas_Legacy.h b/src/lib/evas/Evas_Legacy.h index eb8850d3fc..7970966230 100644 --- a/src/lib/evas/Evas_Legacy.h +++ b/src/lib/evas/Evas_Legacy.h @@ -7900,7 +7900,7 @@ EAPI int evas_map_count_get(const Evas_Map *m) EINA_CONST; * @param mx point x after transformation by m * @param my point y after transformation by m * @param grab - * @return #EINA_TRUE on success interpolation, @EINA_FALSE otherwise + * @return #EINA_TRUE on success interpolation, #EINA_FALSE otherwise * @since 1.20 */ EAPI Eina_Bool evas_map_coords_get(const Evas_Map *m, double x, double y, diff --git a/src/lib/evas/filters/evas_filter_parser.c b/src/lib/evas/filters/evas_filter_parser.c index 6654841061..38d68224d9 100644 --- a/src/lib/evas/filters/evas_filter_parser.c +++ b/src/lib/evas/filters/evas_filter_parser.c @@ -1669,7 +1669,7 @@ _grow_instruction_prepare(Evas_Filter_Program *pgm, Evas_Filter_Instruction *ins @param dst Destination buffer for blending. This must be of same size and colorspace as @a src. @param color A color to use for alpha to RGBA conversion for the blend operations. White means no change. See @ref evasfilters_color "colors". This will have no effect on RGBA sources. - @param fillmode Defines whether to stretch or repeat the @a mask if its size that of @src. + @param fillmode Defines whether to stretch or repeat the @a mask if its size that of @p src. Should be set when masking with external textures. Default is repeat. See @ref evasfilter_fillmode "fillmodes". Note that @a src and @a mask are interchangeable, if they have the same dimensions. diff --git a/src/lib/evil/evil_time.h b/src/lib/evil/evil_time.h index 00f538cae7..42004144a2 100644 --- a/src/lib/evil/evil_time.h +++ b/src/lib/evil/evil_time.h @@ -22,12 +22,12 @@ * * @param buf The string to convert. * @param fmt The representation of time. - * @aram tm The time tm structure. + * @param tm The time tm structure. * @return The first character not processed in this function call. * * This function converts the string @p s to a time tm structure and * fill the buffer @p tm. The format of the time is specified by - * @p format. on success, this function returns the first character + * @p format. On success, this function returns the first character * not processed in this function call, @c NULL otherwise. * * Conformity: Non applicable. --
