summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2020-03-10 10:20:24 +0100
committerXavi Artigas <xavierartigas@yahoo.es>2020-03-10 21:36:34 +0100
commit5b2d2a85b2c74ceabfe5da4dbf2a5c00f0b643e2 (patch)
tree417c15595485378a70e23cf65d55fc4a9ce67d94
parent5c2dfd80a649f84f6fc282abb958f69098ad226c (diff)
doxygen docs: Fix tons of invalid Doxygen commands
Mostly typos
-rw-r--r--src/lib/ecore_evas/Ecore_Evas.h8
-rw-r--r--src/lib/ecore_wayland/session-recovery-client-protocol.h4
-rw-r--r--src/lib/ecore_wl2/Ecore_Wl2.h2
-rw-r--r--src/lib/eeze/Eeze.h2
-rw-r--r--src/lib/eina/eina_freeq.h2
-rw-r--r--src/lib/eina/eina_inline_mempool.x4
-rw-r--r--src/lib/eina/eina_types.h8
-rw-r--r--src/lib/eina/eina_ustrbuf.h2
-rw-r--r--src/lib/eio/Eio_Legacy.h2
-rw-r--r--src/lib/elementary/elm_focus_item.h4
-rw-r--r--src/lib/eo/Eo.h2
-rw-r--r--src/lib/evas/Evas_Legacy.h2
-rw-r--r--src/lib/evas/filters/evas_filter_parser.c2
-rw-r--r--src/lib/evil/evil_time.h4
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
3186 * @param port The port number to start the VNC server. Use @c -1 to set the default VNC port (5900) 3186 * @param port The port number to start the VNC server. Use @c -1 to set the default VNC port (5900)
3187 * @param accept_cb A callback used to accept a new client. If @c NULL all clients will be accepted. 3187 * @param accept_cb A callback used to accept a new client. If @c NULL all clients will be accepted.
3188 * @param disc_cb A callback used to inform that a client has disconnected. It may be @c NULL. 3188 * @param disc_cb A callback used to inform that a client has disconnected. It may be @c NULL.
3189 * @param data Data to pass to @a accept_cb and @disc_cb 3189 * @param data Data to pass to @p accept_cb and @p disc_cb
3190 * @return an Evas_Object that take everything under it to represent the view of the client. 3190 * @return an Evas_Object that take everything under it to represent the view of the client.
3191 * 3191 *
3192 * @see ecore_evas_vnc_stop() 3192 * @see ecore_evas_vnc_stop()
@@ -3809,7 +3809,7 @@ typedef void (*Ecore_Evas_Drag_State_Changed_Cb)(Ecore_Evas *ee, unsigned int se
3809 * @param[in] cb Method to call when the events are received. 3809 * @param[in] cb Method to call when the events are received.
3810 * 3810 *
3811 * Only one such callback can exist for each Ecore_Evas. Calling this method multiple 3811 * Only one such callback can exist for each Ecore_Evas. Calling this method multiple
3812 * times overwrites previous functions. Use a NULL @cb func to stop being notified. 3812 * times overwrites previous functions. Use a NULL @p cb func to stop being notified.
3813 */ 3813 */
3814EAPI void ecore_evas_callback_drop_state_changed_set(Ecore_Evas *ee, Ecore_Evas_Drag_State_Changed_Cb cb); 3814EAPI void ecore_evas_callback_drop_state_changed_set(Ecore_Evas *ee, Ecore_Evas_Drag_State_Changed_Cb cb);
3815 3815
@@ -3832,7 +3832,7 @@ typedef void (*Ecore_Evas_Drag_Motion_Cb)(Ecore_Evas *ee, unsigned int seat, Ein
3832 * @param[in] cb Method to call when the events are received. 3832 * @param[in] cb Method to call when the events are received.
3833 * 3833 *
3834 * Only one such callback can exist for each Ecore_Evas. Calling this method multiple 3834 * Only one such callback can exist for each Ecore_Evas. Calling this method multiple
3835 * times overwrites previous functions. Use a NULL @cb func to stop being notified. 3835 * times overwrites previous functions. Use a NULL @p cb func to stop being notified.
3836 */ 3836 */
3837EAPI void ecore_evas_callback_drop_motion_set(Ecore_Evas *ee, Ecore_Evas_Drag_Motion_Cb cb); 3837EAPI void ecore_evas_callback_drop_motion_set(Ecore_Evas *ee, Ecore_Evas_Drag_Motion_Cb cb);
3838 3838
@@ -3858,7 +3858,7 @@ typedef void (*Ecore_Evas_Drop_Cb)(Ecore_Evas *ee, unsigned int seat, Eina_Posit
3858 * @param[in] cb Method to call when the events are received. 3858 * @param[in] cb Method to call when the events are received.
3859 * 3859 *
3860 * Only one such callback can exist for each Ecore_Evas. Calling this method multiple 3860 * Only one such callback can exist for each Ecore_Evas. Calling this method multiple
3861 * times overwrites previous functions. Use a NULL @cb func to stop being notified. 3861 * times overwrites previous functions. Use a NULL @p cb func to stop being notified.
3862 */ 3862 */
3863EAPI void ecore_evas_callback_drop_drop_set(Ecore_Evas *ee, Ecore_Evas_Drop_Cb cb); 3863EAPI void ecore_evas_callback_drop_drop_set(Ecore_Evas *ee, Ecore_Evas_Drop_Cb cb);
3864 3864
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;
17extern const struct wl_interface zwp_e_session_recovery_interface; 17extern const struct wl_interface zwp_e_session_recovery_interface;
18 18
19struct zwp_e_session_recovery_listener { 19struct zwp_e_session_recovery_listener {
20 /**
21 * uuid - (none)
22 * @uuid: (none)
23 */
24 void (*uuid)(void *data, 20 void (*uuid)(void *data,
25 struct zwp_e_session_recovery *zwp_e_session_recovery, 21 struct zwp_e_session_recovery *zwp_e_session_recovery,
26 const char *uuid); 22 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,
1103 * Set the type of a given window 1103 * Set the type of a given window
1104 * 1104 *
1105 * @param window The window to set the type of 1105 * @param window The window to set the type of
1106 * @type The Ecore_Wl2_Window_Type to set on the window 1106 * @param type The Ecore_Wl2_Window_Type to set on the window
1107 * 1107 *
1108 * @ingroup Ecore_Wl2_Window_Group 1108 * @ingroup Ecore_Wl2_Window_Group
1109 * @since 1.17 1109 * @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 *
569 * @param sysattr The sysattr to set; 569 * @param sysattr The sysattr to set;
570 * @param value The value of sysattr to be set 570 * @param value The value of sysattr to be set
571 * @return @c EINA_TRUE if the sysattr value is set 571 * @return @c EINA_TRUE if the sysattr value is set
572 * @Since 1.12 572 * @since 1.12
573 */ 573 */
574EAPI Eina_Bool eeze_udev_syspath_set_sysattr(const char *syspath, const char *sysattr, double value); 574EAPI Eina_Bool eeze_udev_syspath_set_sysattr(const char *syspath, const char *sysattr, double value);
575 575
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);
258 * @brief Return if there are any items pending a free in the free queue 258 * @brief Return if there are any items pending a free in the free queue
259 * 259 *
260 * @param[in] fq The free queue to query 260 * @param[in] fq The free queue to query
261 * @raturn EINA_TRUE if there are items to free, EINA_FALSE otherwise 261 * @return EINA_TRUE if there are items to free, EINA_FALSE otherwise
262 * 262 *
263 * @since 1.19 263 * @since 1.19
264 */ 264 */
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
58 Eina_Bool (*from)(void *data, void *element); 58 Eina_Bool (*from)(void *data, void *element);
59 /** Function to get an Eina_Iterator that will walk every allocated element 59 /** Function to get an Eina_Iterator that will walk every allocated element
60 * in the pool. 60 * in the pool.
61 * @use eina_mempool_iterator_new 61 * @see eina_mempool_iterator_new
62 */ 62 */
63 Eina_Iterator *(*iterator)(void *data); 63 Eina_Iterator *(*iterator)(void *data);
64 /** Function to allocate memory near already allocated memory. 64 /** Function to allocate memory near already allocated memory.
65 * @since 1.24 65 * @since 1.24
66 * @use eina_mempool_malloc_near 66 * @see eina_mempool_malloc_near
67 */ 67 */
68 void *(*alloc_near)(void *data, void *after, void *before, unsigned int size); 68 void *(*alloc_near)(void *data, void *after, void *before, unsigned int size);
69}; 69};
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 @@
423 423
424/** 424/**
425 * @def EINA_PREFETCH 425 * @def EINA_PREFETCH
426 * @brief Hints that the pointer @parg needs to be pre-fetched into cache 426 * @brief Hints that the pointer @p arg needs to be pre-fetched into cache
427 * 427 *
428 * This hints to the compiler to probably issue a prefetch command for the 428 * This hints to the compiler to probably issue a prefetch command for the
429 * memory address @p arg and ensure it goes into all levels of cache. For 429 * memory address @p arg and ensure it goes into all levels of cache. For
@@ -438,7 +438,7 @@
438 438
439/** 439/**
440 * @def EINA_PREFETCH_WRITE 440 * @def EINA_PREFETCH_WRITE
441 * @brief Hints that the pointer @parg needs to be pre-fetched into cache 441 * @brief Hints that the pointer @p arg needs to be pre-fetched into cache
442 * 442 *
443 * This hints to the compiler to probably issue a prefetch command for the 443 * This hints to the compiler to probably issue a prefetch command for the
444 * memory address @p arg and ensure it goes into all levels of cache. This 444 * memory address @p arg and ensure it goes into all levels of cache. This
@@ -454,7 +454,7 @@
454 454
455/** 455/**
456 * @def EINA_PREFETCH_NOCACHE 456 * @def EINA_PREFETCH_NOCACHE
457 * @brief Hints that the pointer @parg needs to be pre-fetched into cache 457 * @brief Hints that the pointer @p arg needs to be pre-fetched into cache
458 * 458 *
459 * This hints to the compiler to probably issue a prefetch command for the 459 * This hints to the compiler to probably issue a prefetch command for the
460 * memory address @p arg and ensure it goes into just the closest(l1) cache. 460 * memory address @p arg and ensure it goes into just the closest(l1) cache.
@@ -470,7 +470,7 @@
470/** 470/**
471 * @def EINA_PREFETCH_NOCACHE_WRITE 471 * @def EINA_PREFETCH_NOCACHE_WRITE
472 * 472 *
473 * @brief Hints that the pointer @parg needs to be pre-fetched into cache 473 * @brief Hints that the pointer @p arg needs to be pre-fetched into cache
474 * 474 *
475 * This hints to the compiler to probably issue a prefetch command for the 475 * This hints to the compiler to probably issue a prefetch command for the
476 * memory address @p arg and ensure it goes into just the closest(l1) cache. 476 * 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_
325 * @param[in,out] buf The string buffer. 325 * @param[in,out] buf The string buffer.
326 * @param[in] str The string to prepend. 326 * @param[in] str The string to prepend.
327 * @param[in] maxlen The maximum number of Eina_Unicode *s to prepend. 327 * @param[in] maxlen The maximum number of Eina_Unicode *s to prepend.
328 * @return #EINA_TRUE on success, #EINA_FALSE if @str could not be prepended. 328 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be prepended.
329 * 329 *
330 * This macro simply calls eina_ustrbuf_insert_n() with position 0. 330 * This macro simply calls eina_ustrbuf_insert_n() with position 0.
331 */ 331 */
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);
1254 * to check whether a monitor is a fallback monitor before relying on these events. 1254 * to check whether a monitor is a fallback monitor before relying on these events.
1255 * 1255 *
1256 * @since 1.21 1256 * @since 1.21
1257 * @beta
1258 */ 1257 */
1259EAPI Eina_Bool eio_monitor_fallback_check(const Eio_Monitor *monitor); 1258EAPI Eina_Bool eio_monitor_fallback_check(const Eio_Monitor *monitor);
1260 1259
@@ -1272,7 +1271,6 @@ EAPI Eina_Bool eio_monitor_fallback_check(const Eio_Monitor *monitor);
1272 * 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. 1271 * 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.
1273 * 1272 *
1274 * @since 1.23 1273 * @since 1.23
1275 * @beta
1276 */ 1274 */
1277EAPI Eina_Bool eio_monitor_has_context(const Eio_Monitor *monitor, const char *path); 1275EAPI Eina_Bool eio_monitor_has_context(const Eio_Monitor *monitor, const char *path);
1278#endif 1276#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 @@
9 * The focused item can be unfocused with function 9 * The focused item can be unfocused with function
10 * elm_object_item_focus_set(). 10 * elm_object_item_focus_set().
11 * 11 *
12 * see @elm_object_item_focus_set() 12 * @see elm_object_item_focus_set()
13 * see @elm_object_item_focus_get() 13 * @see elm_object_item_focus_get()
14 * 14 *
15 * @ingroup Elm_Focus 15 * @ingroup Elm_Focus
16 * @since 1.10 16 * @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);
1233EAPI Eina_Bool efl_domain_data_return(Efl_Id_Domain domain); 1233EAPI Eina_Bool efl_domain_data_return(Efl_Id_Domain domain);
1234 1234
1235/** 1235/**
1236 * @prief Check if 2 objects are compatible 1236 * @brief Check if 2 objects are compatible
1237 * @param obj The basic object 1237 * @param obj The basic object
1238 * @param obj_target The alternate object that may be referenced by @p obj 1238 * @param obj_target The alternate object that may be referenced by @p obj
1239 * @return EINA_TRUE if compatible, EINA_FALSE if not 1239 * @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;
7900 * @param mx point x after transformation by m 7900 * @param mx point x after transformation by m
7901 * @param my point y after transformation by m 7901 * @param my point y after transformation by m
7902 * @param grab 7902 * @param grab
7903 * @return #EINA_TRUE on success interpolation, @EINA_FALSE otherwise 7903 * @return #EINA_TRUE on success interpolation, #EINA_FALSE otherwise
7904 * @since 1.20 7904 * @since 1.20
7905 */ 7905 */
7906EAPI Eina_Bool evas_map_coords_get(const Evas_Map *m, double x, double y, 7906EAPI 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
1669 @param dst Destination buffer for blending. This must be of same size and colorspace as @a src. 1669 @param dst Destination buffer for blending. This must be of same size and colorspace as @a src.
1670 @param color A color to use for alpha to RGBA conversion for the blend operations. White means no change. 1670 @param color A color to use for alpha to RGBA conversion for the blend operations. White means no change.
1671 See @ref evasfilters_color "colors". This will have no effect on RGBA sources. 1671 See @ref evasfilters_color "colors". This will have no effect on RGBA sources.
1672 @param fillmode Defines whether to stretch or repeat the @a mask if its size that of @src. 1672 @param fillmode Defines whether to stretch or repeat the @a mask if its size that of @p src.
1673 Should be set when masking with external textures. Default is repeat. See @ref evasfilter_fillmode "fillmodes". 1673 Should be set when masking with external textures. Default is repeat. See @ref evasfilter_fillmode "fillmodes".
1674 1674
1675 Note that @a src and @a mask are interchangeable, if they have the same dimensions. 1675 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 @@
22 * 22 *
23 * @param buf The string to convert. 23 * @param buf The string to convert.
24 * @param fmt The representation of time. 24 * @param fmt The representation of time.
25 * @aram tm The time tm structure. 25 * @param tm The time tm structure.
26 * @return The first character not processed in this function call. 26 * @return The first character not processed in this function call.
27 * 27 *
28 * This function converts the string @p s to a time tm structure and 28 * This function converts the string @p s to a time tm structure and
29 * fill the buffer @p tm. The format of the time is specified by 29 * fill the buffer @p tm. The format of the time is specified by
30 * @p format. on success, this function returns the first character 30 * @p format. On success, this function returns the first character
31 * not processed in this function call, @c NULL otherwise. 31 * not processed in this function call, @c NULL otherwise.
32 * 32 *
33 * Conformity: Non applicable. 33 * Conformity: Non applicable.