[EGIT] [apps/terminology] master 03/09: Translated using Weblate (Catalan)
billiob pushed a commit to branch master. http://git.enlightenment.org/apps/terminology.git/commit/?id=a022e949b86908f537da098362e803d627e97207 commit a022e949b86908f537da098362e803d627e97207 Author: Xavi Artigas Date: Tue Sep 15 06:44:11 2020 + Translated using Weblate (Catalan) Currently translated at 94.6% (232 of 245 strings) Translation: Terminology/Terminology Translate-URL: https://hosted.weblate.org/projects/terminology/terminology/ca/ --- po/ca.po | 105 +++ 1 file changed, 52 insertions(+), 53 deletions(-) diff --git a/po/ca.po b/po/ca.po index 522b011..c7c7271 100644 --- a/po/ca.po +++ b/po/ca.po @@ -8,15 +8,17 @@ msgstr "" "Project-Id-Version: enlightenment\n" "Report-Msgid-Bugs-To: \n" "POT-Creation-Date: 2020-04-12 00:15+0200\n" -"PO-Revision-Date: 2015-04-16 07:13+\n" -"Last-Translator: JoanColl \n" -"Language-Team: Catalan \n" +"PO-Revision-Date: 2020-09-15 19:51+\n" +"Last-Translator: Xavi Artigas \n" +"Language-Team: Catalan <https://hosted.weblate.org/projects/terminology/; +"terminology/ca/>\n" "Language: ca\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" +"Plural-Forms: nplurals=2; plural=n != 1;\n" +"X-Generator: Weblate 4.3-dev\n" "X-Launchpad-Export-Date: 2015-05-04 05:16+\n" -"X-Generator: Launchpad (build 17474)\n" #: src/bin/options_helpers.c:193 src/bin/options.c:227 msgid "Helpers" @@ -79,11 +81,11 @@ msgstr "Obre" #: src/bin/termio.c:1182 msgid "Copy relative path" -msgstr "" +msgstr "Copia ruta relativa" #: src/bin/termio.c:1184 msgid "Copy full path" -msgstr "" +msgstr "Copia ruta completa" #: src/bin/termio.c:1189 src/bin/termio.c:2554 src/bin/controls.c:424 msgid "Copy" @@ -91,7 +93,7 @@ msgstr "Còpia" #: src/bin/termio.c:2556 msgid "Open as URL" -msgstr "" +msgstr "Obre com a URL" #: src/bin/termio.c:3975 msgid "Could not allocate termpty" @@ -134,9 +136,8 @@ msgid "Key Bindings" msgstr "Dreceres de teclat" #: src/bin/options_keys.c:457 -#, fuzzy msgid "Reset bindings" -msgstr "Dreceres de teclat" +msgstr "Reinicia dreceres" #: src/bin/options_background.c:163 msgid "None" @@ -160,7 +161,7 @@ msgstr "Fons" #: src/bin/options_background.c:584 msgid "Shine:" -msgstr "" +msgstr "Brillantor:" #: src/bin/options_background.c:608 src/bin/options_behavior.c:656 msgid "Translucent" @@ -188,9 +189,8 @@ msgid "Other" msgstr "Altres" #: src/bin/options_background.c:693 -#, fuzzy msgid "Click on a picture to use it as background" -msgstr "Feu doble clic a una imatge per importar-la" +msgstr "Feu clic a una imatge per utilitzar-la de fons" #: src/bin/options_elm.c:109 src/bin/options.c:228 msgid "Toolkit" @@ -203,25 +203,30 @@ msgid "" "toolkit configuration settings can be accessed by running %s." msgstr "" +"Terminology utilitza la llibreria elementary.La configuració d'aquesta llibreria es pot accedir executant " +"%s." #: src/bin/options_elm.c:134 #, c-format msgid "Launch %s" -msgstr "" +msgstr "Executar %s" #: src/bin/options_elm.c:150 src/bin/win.c:367 src/bin/win.c:387 msgid "Scale" -msgstr "" +msgstr "Escala" #: src/bin/options_elm.c:172 src/bin/win.c:410 msgid "Select preferred size so that this text is readable." -msgstr "" +msgstr "Seleccioneu la mida desitjada per a que aquest text sigui llegible." #: src/bin/options_elm.c:179 msgid "" "The scale configuration can also be changed through elementary's configuration panel." msgstr "" +"La configuració d'escala pot ser modificada a través del panell de " +"configuració de elementary." #: src/bin/options_theme.c:154 src/bin/options.c:222 msgid "Theme" @@ -240,36 +245,35 @@ msgstr "%d lines" #: src/bin/options_behavior.c:105 #, c-format msgid "Scrollback (current memory usage: %'.2f%cB):" -msgstr "" +msgstr "Línies d'historial (Us de memòria actual: %'.2f%cB):" #: src/bin/options_behavior.c:281 -#, fuzzy msgid "Default cursor:" -msgstr "Predeterminat" +msgstr "Cursor predeterminat:" #: src/bin/options_behavior.c:290 msgid "Blinking Block" -msgstr "" +msgstr "Block Parpellejant"
[EGIT] [core/efl] master 05/08: doxygen docs: Fix grouping mess in Eina Simple XML
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=a80b1dca23b06471de6ea86ba1e57a0b62a07b18
commit a80b1dca23b06471de6ea86ba1e57a0b62a07b18
Author: Xavi Artigas
Date: Fri May 8 11:48:32 2020 +0200
doxygen docs: Fix grouping mess in Eina Simple XML
Seriously, who came up with such convoluted doxygen code?
---
src/lib/eina/eina_simple_xml_parser.h | 15 +--
1 file changed, 1 insertion(+), 14 deletions(-)
diff --git a/src/lib/eina/eina_simple_xml_parser.h
b/src/lib/eina/eina_simple_xml_parser.h
index 19c0bca44f..9b92798452 100644
--- a/src/lib/eina/eina_simple_xml_parser.h
+++ b/src/lib/eina/eina_simple_xml_parser.h
@@ -125,16 +125,7 @@
*
* For more information, see
* @ref eina_simple_xml_parser_example_01_page "this example".
- */
-
-/**
- * @addtogroup Eina_Tools_Group Tools
- *
- * @{
- */
-
-/**
- * @defgroup Eina_Simple_XML_Group Simple_XML
+ * @ingroup Eina_Tools_Group Tools
*
* @{
*/
@@ -506,10 +497,6 @@ EAPI void
eina_simple_xml_node_root_free(Eina_Simple_XML_Node_Root *root);
EAPI char * eina_simple_xml_node_dump(Eina_Simple_XML_Node *node, const char
*indent);
-/**
- * @}
- */
-
/**
* @}
*/
--
[EGIT] [core/efl] master 07/08: doxygen docs: Put Eina XAttrs in their own group
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=998dd2f61621fe54da8307ae7e0c1acc90c4879c
commit 998dd2f61621fe54da8307ae7e0c1acc90c4879c
Author: Xavi Artigas
Date: Fri May 8 12:05:38 2020 +0200
doxygen docs: Put Eina XAttrs in their own group
To stop polluting the Eina Tools group.
---
src/lib/eina/eina_xattr.h | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/src/lib/eina/eina_xattr.h b/src/lib/eina/eina_xattr.h
index ff7e10daa1..faf4dc285c 100644
--- a/src/lib/eina/eina_xattr.h
+++ b/src/lib/eina/eina_xattr.h
@@ -24,7 +24,9 @@
#include
/**
- * @addtogroup Eina_Tools_Group Tools
+ * @addtogroup Eina_Xattr_Group Xattrs
+ * @ingroup Eina_Tools_Group
+ * @brief Extended Attributes handling
*
* @{
*/
--
[EGIT] [core/efl] master 04/08: doxygen docs: Complete docs for Eina Module
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=78aa7a7467f55f8b72927f530df0c221126c90c3
commit 78aa7a7467f55f8b72927f530df0c221126c90c3
Author: Xavi Artigas
Date: Fri May 8 11:35:56 2020 +0200
doxygen docs: Complete docs for Eina Module
And fix yet another doxygen grouping mess
---
src/lib/eina/eina_inline_modinfo.x | 27 +++
src/lib/eina/eina_module.h | 28
2 files changed, 19 insertions(+), 36 deletions(-)
diff --git a/src/lib/eina/eina_inline_modinfo.x
b/src/lib/eina/eina_inline_modinfo.x
index 582b7caf5a..a53de0a4a8 100644
--- a/src/lib/eina/eina_inline_modinfo.x
+++ b/src/lib/eina/eina_inline_modinfo.x
@@ -28,46 +28,33 @@
__attribute__((__used__)) __attribute__((unused, aligned(1))) = info;
#define EINA_MODINFO(tag, info) _EINA_MODINFO(tag, info)
-/**
- * @defgroup Eina_Module_Group Module
- *
- * These macros allow you to define module informations like
author/description/version/license.
- * eina_modinfo - shows information about an eina module.
- * eina_modinfo pulls out information from the eina modules given on command
line.
- *
- * $ eina_modinfo module.so
- * version: 0.1
- * description: Entry test
- * license: GPLv2
- * author: Enlightenment Community
- *
- */
-
/**
- * @defgroup Eina_Module_Group Module
+ * @ingroup Eina_Module_Group
*
* This macro is used for defining license.
*
*/
#define EINA_MODULE_LICENSE(_license) EINA_MODINFO(license, _license)
/**
- * @defgroup Eina_Module_Group Module
+ * @ingroup Eina_Module_Group
*
* This macro is used for defining author
* Use "name " or just "name"
* for multiple authors, use multiple lines like below
- *EINA_MODULE_AUTHOR("Author 1 \n
+@code{.c}
+ EINA_MODULE_AUTHOR("Author 1 \n"
"Author 2 ");
+@endcode
*/
#define EINA_MODULE_AUTHOR(_author) EINA_MODINFO(author, _author)
/**
- * @defgroup Eina_Module_Group Module
+ * @ingroup Eina_Module_Group
*
* This macro is used for defining version.
*/
#define EINA_MODULE_VERSION(_ver) EINA_MODINFO(ver, _ver)
/**
- * @defgroup Eina_Module_Group Module
+ * @ingroup Eina_Module_Group
*
* This macro is used for defining description.
* Explain what your module does.
diff --git a/src/lib/eina/eina_module.h b/src/lib/eina/eina_module.h
index 90400546a1..1fbd6153ac 100644
--- a/src/lib/eina/eina_module.h
+++ b/src/lib/eina/eina_module.h
@@ -24,20 +24,10 @@
#include "eina_error.h"
#include "eina_inline_modinfo.x"
-/**
- * @addtogroup Eina_Module_Group Module
- *
- * @brief These functions provide module management.
- */
-
-/**
- * @addtogroup Eina_Tools_Group Tools
- *
- * @{
- */
-
/**
* @defgroup Eina_Module_Group Module
+ * @ingroup Eina_Tools_Group Tools
+ * @brief These functions provide module management.
*
* Eina module provides some helpers over POSIX dlopen(). It is not
* meant to replace, abstract or make a "portable" version of
@@ -59,6 +49,16 @@
* directory listing. See eina_module_arch_list_get(),
* eina_module_list_get() and eina_module_find().
*
+ * #EINA_MODULE_LICENSE, #EINA_MODULE_AUTHOR, #EINA_MODULE_VERSION and
+ * #EINA_MODULE_DESCRIPTION allow you to define module information that can
+ * be retrieved with the @c eina_modinfo tool.
+ @code{.sh}
+ $ eina_modinfo module.so
+ version: 0.1
+ description: Entry test
+ license: GPLv2
+ author: Enlightenment Community
+ @endcode
* @{
*/
@@ -340,8 +340,4 @@ EAPI Eina_Module *
* @}
*/
-/**
- * @}
- */
-
#endif /*EINA_MODULE_H_*/
--
[EGIT] [core/efl] master 02/08: doxygen docs: Complete docs for Eina CPU functions
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=361aa83a170f436c26b61e02babe725eb9db8762
commit 361aa83a170f436c26b61e02babe725eb9db8762
Author: Xavi Artigas
Date: Fri May 8 10:47:26 2020 +0200
doxygen docs: Complete docs for Eina CPU functions
---
src/lib/eina/eina_cpu.h | 30 +++---
1 file changed, 19 insertions(+), 11 deletions(-)
diff --git a/src/lib/eina/eina_cpu.h b/src/lib/eina/eina_cpu.h
index 35172a7a3b..b3b3c04747 100644
--- a/src/lib/eina/eina_cpu.h
+++ b/src/lib/eina/eina_cpu.h
@@ -45,18 +45,18 @@
*/
typedef enum _Eina_Cpu_Features
{
- EINA_CPU_MMX = 0x0001,
- EINA_CPU_SSE = 0x0002,
- EINA_CPU_SSE2= 0x0004,
- EINA_CPU_SSE3= 0x0008,
+ EINA_CPU_MMX = 0x0001, /**< Multimedia Extensions (Intel) */
+ EINA_CPU_SSE = 0x0002, /**< Streaming SIMD Extensions (Intel) */
+ EINA_CPU_SSE2= 0x0004, /**< Streaming SIMD Extensions 2 (Intel) */
+ EINA_CPU_SSE3= 0x0008, /**< Streaming SIMD Extensions 3 (Intel) */
/* TODO 3DNow! */
- EINA_CPU_ALTIVEC = 0x0010,
- EINA_CPU_VIS = 0x0020,
- EINA_CPU_NEON= 0x0040,
- EINA_CPU_SSSE3 = 0x0080,
- EINA_CPU_SSE41 = 0x0100,
- EINA_CPU_SSE42 = 0x0200,
- EINA_CPU_SVE = 0x0400
+ EINA_CPU_ALTIVEC = 0x0010, /**< Single-precision floating point and
integer SIMD (PowerPC) */
+ EINA_CPU_VIS = 0x0020, /**< Visual Instruction Set (Spark) */
+ EINA_CPU_NEON= 0x0040, /**< Advanced SIMD Extension (ARM) */
+ EINA_CPU_SSSE3 = 0x0080, /**< Supplemental Streaming SIMD Extension 3
(Intel) */
+ EINA_CPU_SSE41 = 0x0100, /**< Streaming SIMD Extension 4.1 (Intel) */
+ EINA_CPU_SSE42 = 0x0200, /**< Streaming SIMD Extension 4.2 (Intel) */
+ EINA_CPU_SVE = 0x0400 /**< Scalable Vector Extension (ARM) */
} Eina_Cpu_Features;
/**
@@ -136,10 +136,18 @@ static inline unsigned int eina_ntohl(unsigned int net);
static inline unsigned long long eina_ntohll(unsigned long long net);
#ifndef MIN
+/** Returns the minimum of the two parameters
+ * @warning Beware of side effects, since the returned parameter is evaluated
+ * twice.
+ */
# define MIN(x, y) (((x) > (y)) ? (y) : (x))
#endif
#ifndef MAX
+/** Returns the maximum of the two parameters
+ * @warning Beware of side effects, since the returned parameter is evaluated
+ * twice.
+ */
# define MAX(x, y) (((x) > (y)) ? (x) : (y))
#endif
--
[EGIT] [core/efl] master 06/08: doxygen docs: Complete docs for Eina Thread
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=3cc754440eb6be3eac9c15c2fe7d03fcd8927264
commit 3cc754440eb6be3eac9c15c2fe7d03fcd8927264
Author: Xavi Artigas
Date: Fri May 8 11:54:49 2020 +0200
doxygen docs: Complete docs for Eina Thread
---
src/lib/eina/eina_thread.h | 19 +--
1 file changed, 5 insertions(+), 14 deletions(-)
diff --git a/src/lib/eina/eina_thread.h b/src/lib/eina/eina_thread.h
index 15e522fc4c..93542f29a3 100644
--- a/src/lib/eina/eina_thread.h
+++ b/src/lib/eina/eina_thread.h
@@ -25,14 +25,9 @@
#include
-/**
- * @addtogroup Eina_Tools_Group Tools
- *
- * @{
- */
-
/**
* @defgroup Eina_Thread_Group Thread
+ * @ingroup Eina_Tools_Group
*
* Abstracts platform threads, providing a uniform API. It's modeled
* after POSIX THREADS (pthreads), on Linux they are almost 1:1
@@ -62,10 +57,10 @@ typedef void *(*Eina_Thread_Cb)(void *data, Eina_Thread t);
*/
typedef enum _Eina_Thread_Priority
{
- EINA_THREAD_URGENT,
- EINA_THREAD_NORMAL,
- EINA_THREAD_BACKGROUND,
- EINA_THREAD_IDLE
+ EINA_THREAD_URGENT, /**< Higher than average process priority */
+ EINA_THREAD_NORMAL, /**< Standard process priority */
+ EINA_THREAD_BACKGROUND, /**< Lower than average process priority */
+ EINA_THREAD_IDLE/**< Thread to be executed only when the processor
is idle */
} Eina_Thread_Priority;
/**
@@ -338,10 +333,6 @@ typedef void *(*Eina_Thread_Cancellable_Run_Cb)(void
*data);
*/
EAPI void *eina_thread_cancellable_run(Eina_Thread_Cancellable_Run_Cb cb,
Eina_Free_Cb cleanup_cb, void *data);
-/**
- * @}
- */
-
/**
* @}
*/
--
[EGIT] [core/efl] master 01/08: doxygen docs: Complete docs for Eina_Rectangle
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=88d1c886bd2bc47b5eaeaac4b15ae9434103bdf2
commit 88d1c886bd2bc47b5eaeaac4b15ae9434103bdf2
Author: Xavi Artigas
Date: Fri May 8 10:19:40 2020 +0200
doxygen docs: Complete docs for Eina_Rectangle
---
src/lib/eina/eina_rectangle.h | 36
1 file changed, 28 insertions(+), 8 deletions(-)
diff --git a/src/lib/eina/eina_rectangle.h b/src/lib/eina/eina_rectangle.h
index 4a92940c28..0c0a92bd47 100644
--- a/src/lib/eina/eina_rectangle.h
+++ b/src/lib/eina/eina_rectangle.h
@@ -39,15 +39,24 @@
* @{
*/
+/** A zero-size rectangle. */
#define EINA_RECTANGLE_INIT { 0, 0, 0, 0}
+/** A format string useful for printf-like functions. */
#define EINA_RECTANGLE_FORMAT "dx%d - %dx%d"
+/** Separates the components of the rectangle structure into a comma-separated
list,
+ * so they can be used as parameters. */
#define EINA_RECTANGLE_ARGS(r) (r)->x, (r)->y, (r)->w, (r)->h
+/** Creates an instance of an #Eina_Rect */
#define EINA_RECT(x, y, w, h) ((Eina_Rect) { { (x), (y), (w), (h) } })
+/** A zero-size rectangle that can be used to initialize #Eina_Rect
structures. */
#define EINA_RECT_ZERO() { EINA_RECTANGLE_INIT }
+/** A zero-size rectangle that can be used to initialize #Eina_Rect
structures. */
#define EINA_RECT_EMPTY() ((Eina_Rect) EINA_RECT_ZERO())
+/** Creates an instance of an #Eina_Position2D */
#define EINA_POSITION2D(x, y) ((Eina_Position2D) { (x), (y) })
+/** Creates an instance of an #Eina_Size2D */
#define EINA_SIZE2D(x, y) ((Eina_Size2D) { (x), (y) })
/** @brief A 2D position in pixel coordinates */
@@ -104,15 +113,22 @@ typedef struct _Eina_Rectangle
int h; /**< height of rectangle */
} Eina_Rectangle;
+/**
+ * @typedef Eina_Rect
+ * A convenient rectangle structure which can be accessed in different ways.
+ */
typedef union _Eina_Rect
{
- Eina_Rectangle rect;
+ Eina_Rectangle rect; /**< Embedded simple rectangle structure */
struct {
- Eina_Position2D pos;
- Eina_Size2D size;
+ Eina_Position2D pos; /**< Top-left corner in pixels */
+ Eina_Size2D size; /**< Size in pixels */
};
struct {
- int x, y, w, h;
+ int x; /**< Top-left x coordinate of rectangle */
+ int y; /**< Top-left y coordinate of rectangle */
+ int w; /**< Width of rectangle */
+ int h; /**< Height of rectangle */
};
} Eina_Rect;
@@ -141,10 +157,10 @@ typedef enum {
* @since 1.19
*/
typedef enum {
-EINA_RECTANGLE_OUTSIDE_TOP = 1,
-EINA_RECTANGLE_OUTSIDE_LEFT = 2,
-EINA_RECTANGLE_OUTSIDE_BOTTOM = 4,
-EINA_RECTANGLE_OUTSIDE_RIGHT = 8
+EINA_RECTANGLE_OUTSIDE_TOP = 1,/**< Position is over the rectangle */
+EINA_RECTANGLE_OUTSIDE_LEFT = 2, /**< Position is to the left of the
rectangle */
+EINA_RECTANGLE_OUTSIDE_BOTTOM = 4, /**< Position is below the rectangle */
+EINA_RECTANGLE_OUTSIDE_RIGHT = 8 /**< Position is to the right of the
rectangle */
} Eina_Rectangle_Outside;
@@ -527,6 +543,10 @@ EAPI void
eina_rectangle_pool_release(Eina_Rectangle *rect) EINA
(Rectangle)->h = H;\
}
+/**
+ * @def EINA_RECT_SET
+ * Functionally equivalent to #EINA_RECTANGLE_SET
+ */
#define EINA_RECT_SET(rect, x, y, w, h) do { EINA_RECTANGLE_SET((), x, y,
w, h) } while (0)
--
[EGIT] [core/efl] master 03/08: doxygen docs: Complete docs for Eina Log
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=2aae4a0c859eaec8af46d3d6898e577b0d667f99
commit 2aae4a0c859eaec8af46d3d6898e577b0d667f99
Author: Xavi Artigas
Date: Fri May 8 11:05:50 2020 +0200
doxygen docs: Complete docs for Eina Log
---
src/lib/eina/eina_log.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/lib/eina/eina_log.h b/src/lib/eina/eina_log.h
index 7b4e17e9a9..fd6f6c4252 100644
--- a/src/lib/eina/eina_log.h
+++ b/src/lib/eina/eina_log.h
@@ -482,8 +482,8 @@ typedef void (*Eina_Log_Print_Cb)(const Eina_Log_Domain *d,
*/
typedef enum _Eina_Log_State
{
- EINA_LOG_STATE_START,
- EINA_LOG_STATE_STOP
+ EINA_LOG_STATE_START, /**< Logging is Started */
+ EINA_LOG_STATE_STOP /**< Logging is Stopped */
} Eina_Log_State;
/*
--
[EGIT] [core/efl] master 08/08: doxygen docs: Fix problems in Evas_Canvas
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=19da175f946dc398caf38e013474b1817fc8c23b commit 19da175f946dc398caf38e013474b1817fc8c23b Author: Xavi Artigas Date: Fri May 8 12:30:13 2020 +0200 doxygen docs: Fix problems in Evas_Canvas - Put some methods in a group so they are accessible and can be linked to. - Remove references to Efl_ methods, unavailable in Legacy. - Incorrect param names and typos --- src/lib/evas/Evas_Legacy.h | 12 ++-- src/lib/evas/canvas/evas_canvas_eo.h| 6 ++ src/lib/evas/canvas/evas_canvas_eo.legacy.h | 11 --- 3 files changed, 16 insertions(+), 13 deletions(-) diff --git a/src/lib/evas/Evas_Legacy.h b/src/lib/evas/Evas_Legacy.h index e41edfaad5..cb13afdd0f 100644 --- a/src/lib/evas/Evas_Legacy.h +++ b/src/lib/evas/Evas_Legacy.h @@ -1923,11 +1923,11 @@ EAPI void evas_object_size_hint_display_mode_set(Evas_Object *obj, Evas_Display_ * * These are hints on the display mode @c obj. This is not a size enforcement * in any way, it's just a hint that can be used whenever appropriate. This - * mode can be used object's display mode like commpress or expand. + * mode can be used object's display mode like compress or expand. * * @return Display mode hint. * - * @ingroup Evas_Objects + * @ingroup Evas_Object_Group */ EAPI Evas_Display_Mode evas_object_size_hint_display_mode_get(const Evas_Object *obj); @@ -1952,6 +1952,7 @@ EAPI Evas_Display_Mode evas_object_size_hint_display_mode_get(const Evas_Object * * @param[in] l The number of the layer to place the object on. Must be between #EVAS_LAYER_MIN and #EVAS_LAYER_MAX. + * @ingroup Evas_Object_Group */ EAPI void evas_object_layer_set(Evas_Object *obj, short l); @@ -1963,6 +1964,7 @@ EAPI void evas_object_layer_set(Evas_Object *obj, short l); * * @see evas_object_layer_set() * + * @ingroup Evas_Object_Group */ EAPI short evas_object_layer_get(const Evas_Object *obj); @@ -1980,6 +1982,7 @@ EAPI short evas_object_layer_get(const Evas_Object *obj); * @see evas_object_layer_set() * @see evas_object_below_get() * + * @ingroup Evas_Object_Group */ EAPI Evas_Object *evas_object_below_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT; @@ -1997,6 +2000,7 @@ EAPI Evas_Object *evas_object_below_get(const Evas_Object *obj) EINA_WARN_UNUSED * @see evas_object_layer_set() * @see evas_object_below_get() * + * @ingroup Evas_Object_Group */ EAPI Evas_Object *evas_object_above_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT; @@ -2026,6 +2030,7 @@ EAPI Evas_Object *evas_object_above_get(const Evas_Object *obj) EINA_WARN_UNUSED * * * @param[in] below the object below which to stack + * @ingroup Evas_Object_Group */ EAPI void evas_object_stack_below(Evas_Object *obj, Evas_Object *below) EINA_ARG_NONNULL(2); @@ -2040,6 +2045,7 @@ EAPI void evas_object_stack_below(Evas_Object *obj, Evas_Object *below) EINA_ARG * @see evas_object_stack_below() * @see evas_object_lower() * + * @ingroup Evas_Object_Group * */ EAPI void evas_object_raise(Evas_Object *obj); @@ -2070,6 +2076,7 @@ EAPI void evas_object_raise(Evas_Object *obj); * * * @param[in] above the object above which to stack + * @ingroup Evas_Object_Group */ EAPI void evas_object_stack_above(Evas_Object *obj, Evas_Object *above) EINA_ARG_NONNULL(2); @@ -2084,6 +2091,7 @@ EAPI void evas_object_stack_above(Evas_Object *obj, Evas_Object *above) EINA_ARG * @see evas_object_stack_below() * @see evas_object_raise() * + * @ingroup Evas_Object_Group * */ EAPI void evas_object_lower(Evas_Object *obj); diff --git a/src/lib/evas/canvas/evas_canvas_eo.h b/src/lib/evas/canvas/evas_canvas_eo.h index 74cd5ef05c..370421449c 100644 --- a/src/lib/evas/canvas/evas_canvas_eo.h +++ b/src/lib/evas/canvas/evas_canvas_eo.h @@ -135,9 +135,7 @@ EOAPI void *evas_canvas_data_attach_get(const Eo *obj); * * See also @ref evas_object_focus_set, @ref evas_object_focus_get, @ref * evas_object_key_grab, @ref evas_object_key_ungrab, - * @ref evas_canvas_seat_focus_get, @ref efl_canvas_object_seat_focus_check, - * @ref efl_canvas_object_seat_focus_add, - * @ref efl_canvas_object_seat_focus_del. + * @ref evas_canvas_seat_focus_get * * @param[in] obj The object. * @@ -325,7 +323,7 @@ EOAPI void evas_canvas_pointer_output_xy_get(const Eo *obj, int *x, int *y); * only on the ones at the "top level", with regard to object parenting. * * See also @ref evas_object_layer_get, @ref evas_object_layer_set, @ref - * evas_object_below_get, @ref evas_object_below_set. + * evas_object_below_get. * * @param[in] obj The object. * diff --git a/src/lib/evas/canvas/evas_canvas_eo.legacy.h b/src/lib/evas/canvas/evas_canvas_eo.legacy.h index 3ef5d4c37d..af009aa6a6 100644 --- a/src/lib/evas/canvas/evas_canvas_eo.legacy.h +++ b/src/lib/evas/canvas/evas_canvas_eo.legacy.h @@ -127,10 +127,7 @@
[EGIT] [core/efl] efl-1.24 04/07: doxygen docs: Fix reference to Elm_Start
stefan pushed a commit to branch efl-1.24. http://git.enlightenment.org/core/efl.git/commit/?id=ba508532cc50d195eaeff42cab7d6da7939671d8 commit ba508532cc50d195eaeff42cab7d6da7939671d8 Author: Xavi Artigas Date: Wed Apr 29 16:51:23 2020 +0200 doxygen docs: Fix reference to Elm_Start --- elm_intro.h.in | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/elm_intro.h.in b/elm_intro.h.in index 95bdb577f0..52cf1fb388 100644 --- a/elm_intro.h.in +++ b/elm_intro.h.in @@ -9,10 +9,10 @@ * This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop * applications (yet). Small simple ones with simple needs. * - * It is meant to make the programmers work almost brainless but give them lots + * It is meant to make the programmers work almost brainlessly but give them lots * of flexibility. * - * @li @ref Start - Go here to quickly get started with writing Apps + * @li @ref Elm_Start - Go here to quickly get started with writing Apps * * @section organization Organization * --
[EGIT] [core/efl] efl-1.24 05/07: doxygen docs: add missing example references
stefan pushed a commit to branch efl-1.24. http://git.enlightenment.org/core/efl.git/commit/?id=d6017150b60561bdc1e77254c8aea34ef2132c5f commit d6017150b60561bdc1e77254c8aea34ef2132c5f Author: Xavi Artigas Date: Wed Apr 29 17:14:35 2020 +0200 doxygen docs: add missing example references --- src/lib/eina/eina_error.h | 1 + src/lib/eina/eina_inlist.h | 4 +++- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/src/lib/eina/eina_error.h b/src/lib/eina/eina_error.h index 313548bb66..ba27bc67bc 100644 --- a/src/lib/eina/eina_error.h +++ b/src/lib/eina/eina_error.h @@ -46,6 +46,7 @@ * Here is an example for use: * * @include eina_error_01.c + * @example eina_error_01.c * * Of course, instead of printf(), eina_log_print() can be used to * have beautiful error messages. diff --git a/src/lib/eina/eina_inlist.h b/src/lib/eina/eina_inlist.h index 5adc3104f3..ab575d898c 100644 --- a/src/lib/eina/eina_inlist.h +++ b/src/lib/eina/eina_inlist.h @@ -108,6 +108,7 @@ * * @skip while * @until } + * @example eina_inlist_01.c */ /** @@ -179,6 +180,7 @@ * @until } * * Here is the full source code for this example: @ref eina_inlist_02_c + * @example eina_inlist_02.c */ /** @@ -266,7 +268,7 @@ * * To see the full source code for this example, click here: @ref * eina_inlist_03_c - * + * @example eina_inlist_03.c */ /** --
[EGIT] [core/efl] efl-1.24 07/07: doxygen docs: Add missing group braces
stefan pushed a commit to branch efl-1.24.
http://git.enlightenment.org/core/efl.git/commit/?id=55184ba8326136ea487e00cda090807598d672f8
commit 55184ba8326136ea487e00cda090807598d672f8
Author: Xavi Artigas
Date: Wed Apr 29 17:32:41 2020 +0200
doxygen docs: Add missing group braces
Without them, these Evil docs had no group and therefore didn't appear
anywhere.
---
src/lib/evil/evil_stdio.h | 5 -
src/lib/evil/evil_string.h | 6 +-
2 files changed, 9 insertions(+), 2 deletions(-)
diff --git a/src/lib/evil/evil_stdio.h b/src/lib/evil/evil_stdio.h
index 7b61a33b57..64b09af9bc 100644
--- a/src/lib/evil/evil_stdio.h
+++ b/src/lib/evil/evil_stdio.h
@@ -9,7 +9,7 @@
* @ingroup Evil
*
* This header provides functions ported from Unix in stdio.h.
- *
+ * @{
*/
#define EVIL_PATH_SEP_SWAP(p, s1, s2) \
@@ -56,5 +56,8 @@ EAPI int evil_rename(const char *src, const char *dst);
*/
EAPI int evil_mkdir(const char *dirname, mode_t mode);
+/**
+ * @}
+ */
#endif /* __EVIL_STDIO_H__ */
diff --git a/src/lib/evil/evil_string.h b/src/lib/evil/evil_string.h
index 872834f238..a6ff858eed 100644
--- a/src/lib/evil/evil_string.h
+++ b/src/lib/evil/evil_string.h
@@ -10,7 +10,7 @@
*
* This header provides functions ported from Unix in string.h.
*
- *
+ * @{
*/
@@ -63,4 +63,8 @@ EAPI char *strcasestr(const char *haystack, const char
*needle);
*/
EAPI char *strsep(char **stringp, const char *delim);
+/**
+ * @}
+ */
+
#endif /* __EVIL_STRING_H__ */
--
[EGIT] [core/efl] efl-1.24 03/07: doxygen docs: Replace broken URL with doxygen ref
stefan pushed a commit to branch efl-1.24. http://git.enlightenment.org/core/efl.git/commit/?id=8affc994a369ff46e4be5f597372add8869cb25f commit 8affc994a369ff46e4be5f597372add8869cb25f Author: Xavi Artigas Date: Wed Apr 29 16:26:47 2020 +0200 doxygen docs: Replace broken URL with doxygen ref --- src/lib/evas/Evas.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/lib/evas/Evas.h b/src/lib/evas/Evas.h index b382ca4907..c6699cd171 100644 --- a/src/lib/evas/Evas.h +++ b/src/lib/evas/Evas.h @@ -33,7 +33,7 @@ requirements. Evas can serve as a base for widget sets or toolkits - (e.g. Elementary, http://docs.enlightenment.org/auto/elementary/) by + (e.g. @ref elementary_main) by handling pixel drawing and regional change reporting, but does not manage windows itself, nor deal with input or window update event propagation. In other words, it is intended for use in drawing --
[EGIT] [core/efl] efl-1.24 06/07: doxygen docs: Add tests folder to EXAMPLE_PATH
stefan pushed a commit to branch efl-1.24. http://git.enlightenment.org/core/efl.git/commit/?id=ae6b907ccb16aa1811d592517a9b781b25a1830b commit ae6b907ccb16aa1811d592517a9b781b25a1830b Author: Xavi Artigas Date: Wed Apr 29 17:23:09 2020 +0200 doxygen docs: Add tests folder to EXAMPLE_PATH One Emotion example is located in src/tests instead of src/examples so look for examples in that folder too. --- doc/Doxyfile.in | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 17f86aec5e..5b0711a390 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -681,7 +681,8 @@ EXCLUDE_SYMBOLS= eo_cxx::* # directories that contain example code fragments that are included (see # the \include command). -EXAMPLE_PATH = @top_srcdir@/src/examples +EXAMPLE_PATH = @top_srcdir@/src/examples \ + @top_srcdir@/src/tests # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp --
[EGIT] [core/efl] efl-1.24 01/07: doxygen docs: Fix broken links in main page
stefan pushed a commit to branch efl-1.24. http://git.enlightenment.org/core/efl.git/commit/?id=2d39cb4c7a7e2fe049b84271857ae51e0875a503 commit 2d39cb4c7a7e2fe049b84271857ae51e0875a503 Author: Xavi Artigas Date: Wed Apr 29 15:39:52 2020 +0200 doxygen docs: Fix broken links in main page --- doc/main.dox | 11 +-- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/doc/main.dox b/doc/main.dox index a09e1548ec..fa47155886 100644 --- a/doc/main.dox +++ b/doc/main.dox @@ -23,7 +23,7 @@ * @li @ref eio_main asynchronous input/output * @li @ref eldbus_main D-Bus integration. * @li @ref embryo_main embedded script language. - * @li @ref eo_main generic object system. + * @li @ref eolian_main an EO file parser and code generator. * * Graphics libraries * @@ -35,15 +35,6 @@ * @li @ref ethumb_main to generate thumbnail images of files. * @li @ref evas_main drawing canvas. * - * Operating System specific libraries - * - * @li @ref escape_main playstation3 portability layer. - * @li @ref evil_main microsoft windows portability layer. - * - * Early stage libraries (BETA testing) - * - * @li @ref eolian_main an EO file parser and code generator. - * * If you are looking for methods that do not fit into the above list you can * see the full module listing. */ --
[EGIT] [core/efl] efl-1.24 02/07: doxygen docs: Fix missing links in Ecore_Drm
stefan pushed a commit to branch efl-1.24.
http://git.enlightenment.org/core/efl.git/commit/?id=3a50d86067b9b28f493d01cc4d863fef29385025
commit 3a50d86067b9b28f493d01cc4d863fef29385025
Author: Xavi Artigas
Date: Wed Apr 29 16:17:53 2020 +0200
doxygen docs: Fix missing links in Ecore_Drm
Ecore_Drm_Input had SOME docs, so a group for them is created.
Ecore_Drm_Sprite had NO DOCS at all, so the link is just removed.
This is a deprecated library anyway.
---
src/lib/ecore_drm/Ecore_Drm.h | 8 ++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/src/lib/ecore_drm/Ecore_Drm.h b/src/lib/ecore_drm/Ecore_Drm.h
index 6d87efded5..3896b529d0 100644
--- a/src/lib/ecore_drm/Ecore_Drm.h
+++ b/src/lib/ecore_drm/Ecore_Drm.h
@@ -221,7 +221,6 @@ EAPI extern int ECORE_DRM_EVENT_SEAT_ADD; /**< @since 1.14
*/
* @li @ref Ecore_Drm_Tty_Group
* @li @ref Ecore_Drm_Output_Group
* @li @ref Ecore_Drm_Input_Group
- * @li @ref Ecore_Drm_Sprite_Group
* @li @ref Ecore_Drm_Fb_Group
*
*/
@@ -621,12 +620,17 @@ EAPI unsigned int
ecore_drm_output_crtc_buffer_get(Ecore_Drm_Output *output);
*/
EAPI unsigned int ecore_drm_output_connector_id_get(Ecore_Drm_Output *output);
-/* TODO: Doxy */
+/** @defgroup Ecore_Drm_Input_Group Drm input handling
+ * @{
+ */
EAPI Eina_Bool ecore_drm_inputs_create(Ecore_Drm_Device *dev);
EAPI void ecore_drm_inputs_destroy(Ecore_Drm_Device *dev);
EAPI Eina_Bool ecore_drm_inputs_enable(Ecore_Drm_Input *input);
EAPI void ecore_drm_inputs_disable(Ecore_Drm_Input *input);
EAPI void ecore_drm_inputs_device_axis_size_set(Ecore_Drm_Evdev *dev, int w,
int h);
+/**
+ * @}
+ */
EAPI Eina_Bool ecore_drm_sprites_create(Ecore_Drm_Device *dev);
EAPI void ecore_drm_sprites_destroy(Ecore_Drm_Device *dev);
--
[EGIT] [core/efl] master 01/07: doxygen docs: Fix broken links in main page
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=f39b798dc02556660d33e71f9d65e605e6c1325a commit f39b798dc02556660d33e71f9d65e605e6c1325a Author: Xavi Artigas Date: Wed Apr 29 15:39:52 2020 +0200 doxygen docs: Fix broken links in main page --- doc/main.dox | 11 +-- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/doc/main.dox b/doc/main.dox index a09e1548ec..fa47155886 100644 --- a/doc/main.dox +++ b/doc/main.dox @@ -23,7 +23,7 @@ * @li @ref eio_main asynchronous input/output * @li @ref eldbus_main D-Bus integration. * @li @ref embryo_main embedded script language. - * @li @ref eo_main generic object system. + * @li @ref eolian_main an EO file parser and code generator. * * Graphics libraries * @@ -35,15 +35,6 @@ * @li @ref ethumb_main to generate thumbnail images of files. * @li @ref evas_main drawing canvas. * - * Operating System specific libraries - * - * @li @ref escape_main playstation3 portability layer. - * @li @ref evil_main microsoft windows portability layer. - * - * Early stage libraries (BETA testing) - * - * @li @ref eolian_main an EO file parser and code generator. - * * If you are looking for methods that do not fit into the above list you can * see the full module listing. */ --
[EGIT] [core/efl] master 04/07: doxygen docs: Fix reference to Elm_Start
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=75d561877b169433898c76135ce10168e9ecc8ce commit 75d561877b169433898c76135ce10168e9ecc8ce Author: Xavi Artigas Date: Wed Apr 29 16:51:23 2020 +0200 doxygen docs: Fix reference to Elm_Start --- elm_intro.h.in | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/elm_intro.h.in b/elm_intro.h.in index 95bdb577f0..52cf1fb388 100644 --- a/elm_intro.h.in +++ b/elm_intro.h.in @@ -9,10 +9,10 @@ * This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop * applications (yet). Small simple ones with simple needs. * - * It is meant to make the programmers work almost brainless but give them lots + * It is meant to make the programmers work almost brainlessly but give them lots * of flexibility. * - * @li @ref Start - Go here to quickly get started with writing Apps + * @li @ref Elm_Start - Go here to quickly get started with writing Apps * * @section organization Organization * --
[EGIT] [core/efl] master 03/07: doxygen docs: Replace broken URL with doxygen ref
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=39cb46917c8ad26bb03588ee5d85256ac137eb41 commit 39cb46917c8ad26bb03588ee5d85256ac137eb41 Author: Xavi Artigas Date: Wed Apr 29 16:26:47 2020 +0200 doxygen docs: Replace broken URL with doxygen ref --- src/lib/evas/Evas.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/lib/evas/Evas.h b/src/lib/evas/Evas.h index b382ca4907..c6699cd171 100644 --- a/src/lib/evas/Evas.h +++ b/src/lib/evas/Evas.h @@ -33,7 +33,7 @@ requirements. Evas can serve as a base for widget sets or toolkits - (e.g. Elementary, http://docs.enlightenment.org/auto/elementary/) by + (e.g. @ref elementary_main) by handling pixel drawing and regional change reporting, but does not manage windows itself, nor deal with input or window update event propagation. In other words, it is intended for use in drawing --
[EGIT] [core/efl] master 02/07: doxygen docs: Fix missing links in Ecore_Drm
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=203c3963ef476b667f7aa7bb22ccbb06416b6701
commit 203c3963ef476b667f7aa7bb22ccbb06416b6701
Author: Xavi Artigas
Date: Wed Apr 29 16:17:53 2020 +0200
doxygen docs: Fix missing links in Ecore_Drm
Ecore_Drm_Input had SOME docs, so a group for them is created.
Ecore_Drm_Sprite had NO DOCS at all, so the link is just removed.
This is a deprecated library anyway.
---
src/lib/ecore_drm/Ecore_Drm.h | 8 ++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/src/lib/ecore_drm/Ecore_Drm.h b/src/lib/ecore_drm/Ecore_Drm.h
index 6d87efded5..3896b529d0 100644
--- a/src/lib/ecore_drm/Ecore_Drm.h
+++ b/src/lib/ecore_drm/Ecore_Drm.h
@@ -221,7 +221,6 @@ EAPI extern int ECORE_DRM_EVENT_SEAT_ADD; /**< @since 1.14
*/
* @li @ref Ecore_Drm_Tty_Group
* @li @ref Ecore_Drm_Output_Group
* @li @ref Ecore_Drm_Input_Group
- * @li @ref Ecore_Drm_Sprite_Group
* @li @ref Ecore_Drm_Fb_Group
*
*/
@@ -621,12 +620,17 @@ EAPI unsigned int
ecore_drm_output_crtc_buffer_get(Ecore_Drm_Output *output);
*/
EAPI unsigned int ecore_drm_output_connector_id_get(Ecore_Drm_Output *output);
-/* TODO: Doxy */
+/** @defgroup Ecore_Drm_Input_Group Drm input handling
+ * @{
+ */
EAPI Eina_Bool ecore_drm_inputs_create(Ecore_Drm_Device *dev);
EAPI void ecore_drm_inputs_destroy(Ecore_Drm_Device *dev);
EAPI Eina_Bool ecore_drm_inputs_enable(Ecore_Drm_Input *input);
EAPI void ecore_drm_inputs_disable(Ecore_Drm_Input *input);
EAPI void ecore_drm_inputs_device_axis_size_set(Ecore_Drm_Evdev *dev, int w,
int h);
+/**
+ * @}
+ */
EAPI Eina_Bool ecore_drm_sprites_create(Ecore_Drm_Device *dev);
EAPI void ecore_drm_sprites_destroy(Ecore_Drm_Device *dev);
--
[EGIT] [core/efl] master 06/07: doxygen docs: Add tests folder to EXAMPLE_PATH
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=ab554e682111f098ab209836a825eaa9ca46bf03 commit ab554e682111f098ab209836a825eaa9ca46bf03 Author: Xavi Artigas Date: Wed Apr 29 17:23:09 2020 +0200 doxygen docs: Add tests folder to EXAMPLE_PATH One Emotion example is located in src/tests instead of src/examples so look for examples in that folder too. --- doc/Doxyfile.in | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 17f86aec5e..5b0711a390 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -681,7 +681,8 @@ EXCLUDE_SYMBOLS= eo_cxx::* # directories that contain example code fragments that are included (see # the \include command). -EXAMPLE_PATH = @top_srcdir@/src/examples +EXAMPLE_PATH = @top_srcdir@/src/examples \ + @top_srcdir@/src/tests # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp --
[EGIT] [core/efl] master 05/07: doxygen docs: add missing example references
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=e72912393e2d86bac4fbf7129843f3705933193b commit e72912393e2d86bac4fbf7129843f3705933193b Author: Xavi Artigas Date: Wed Apr 29 17:14:35 2020 +0200 doxygen docs: add missing example references --- src/lib/eina/eina_error.h | 1 + src/lib/eina/eina_inlist.h | 4 +++- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/src/lib/eina/eina_error.h b/src/lib/eina/eina_error.h index 313548bb66..ba27bc67bc 100644 --- a/src/lib/eina/eina_error.h +++ b/src/lib/eina/eina_error.h @@ -46,6 +46,7 @@ * Here is an example for use: * * @include eina_error_01.c + * @example eina_error_01.c * * Of course, instead of printf(), eina_log_print() can be used to * have beautiful error messages. diff --git a/src/lib/eina/eina_inlist.h b/src/lib/eina/eina_inlist.h index 5adc3104f3..ab575d898c 100644 --- a/src/lib/eina/eina_inlist.h +++ b/src/lib/eina/eina_inlist.h @@ -108,6 +108,7 @@ * * @skip while * @until } + * @example eina_inlist_01.c */ /** @@ -179,6 +180,7 @@ * @until } * * Here is the full source code for this example: @ref eina_inlist_02_c + * @example eina_inlist_02.c */ /** @@ -266,7 +268,7 @@ * * To see the full source code for this example, click here: @ref * eina_inlist_03_c - * + * @example eina_inlist_03.c */ /** --
[EGIT] [core/efl] master 07/07: doxygen docs: Add missing group braces
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=37e94d635bee2c713b5cdc077bdfe24e2ac1900a
commit 37e94d635bee2c713b5cdc077bdfe24e2ac1900a
Author: Xavi Artigas
Date: Wed Apr 29 17:32:41 2020 +0200
doxygen docs: Add missing group braces
Without them, these Evil docs had no group and therefore didn't appear
anywhere.
---
src/lib/evil/evil_stdio.h | 5 -
src/lib/evil/evil_string.h | 6 +-
2 files changed, 9 insertions(+), 2 deletions(-)
diff --git a/src/lib/evil/evil_stdio.h b/src/lib/evil/evil_stdio.h
index 7b61a33b57..64b09af9bc 100644
--- a/src/lib/evil/evil_stdio.h
+++ b/src/lib/evil/evil_stdio.h
@@ -9,7 +9,7 @@
* @ingroup Evil
*
* This header provides functions ported from Unix in stdio.h.
- *
+ * @{
*/
#define EVIL_PATH_SEP_SWAP(p, s1, s2) \
@@ -56,5 +56,8 @@ EAPI int evil_rename(const char *src, const char *dst);
*/
EAPI int evil_mkdir(const char *dirname, mode_t mode);
+/**
+ * @}
+ */
#endif /* __EVIL_STDIO_H__ */
diff --git a/src/lib/evil/evil_string.h b/src/lib/evil/evil_string.h
index 872834f238..a6ff858eed 100644
--- a/src/lib/evil/evil_string.h
+++ b/src/lib/evil/evil_string.h
@@ -10,7 +10,7 @@
*
* This header provides functions ported from Unix in string.h.
*
- *
+ * @{
*/
@@ -63,4 +63,8 @@ EAPI char *strcasestr(const char *haystack, const char
*needle);
*/
EAPI char *strsep(char **stringp, const char *delim);
+/**
+ * @}
+ */
+
#endif /* __EVIL_STRING_H__ */
--
[EGIT] [core/efl] master 01/02: doxygen docs: Move CnP API out of the Remove Canvas group
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=53004b72a50199e57d6fa8492efcff0ea66cc7f3 commit 53004b72a50199e57d6fa8492efcff0ea66cc7f3 Author: Xavi Artigas Date: Wed Apr 29 08:41:02 2020 +0200 doxygen docs: Move CnP API out of the Remove Canvas group The new CnP API had been wrongly added to the Remote Canvases group. --- src/lib/ecore_evas/Ecore_Evas.h | 9 - 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h index b8d2a878dd..e17208aba2 100644 --- a/src/lib/ecore_evas/Ecore_Evas.h +++ b/src/lib/ecore_evas/Ecore_Evas.h @@ -3585,6 +3585,10 @@ EAPI Evas_Object *ecore_evas_extn_plug_new(Ecore_Evas *ee_target); */ EAPI Eina_Bool ecore_evas_extn_plug_connect(Evas_Object *obj, const char *svcname, int svcnum, Eina_Bool svcsys); +/** + * @} + */ + /** * @brief Retrieves the coordinates of the default mouse pointer. * @@ -3872,11 +3876,6 @@ EAPI void ecore_evas_callback_drop_drop_set(Ecore_Evas *ee, Ecore_Evas_Drop_Cb c */ EAPI Eina_Accessor* ecore_evas_drop_available_types_get(Ecore_Evas *ee, unsigned int seat); - -/** - * @} - */ - /** * @} */ --
[EGIT] [core/efl] master 02/02: doxygen docs: Add @since tags to EE selection API
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=933b2e5a2d8a414cf6b7b15b24375922330a74e8
commit 933b2e5a2d8a414cf6b7b15b24375922330a74e8
Author: Xavi Artigas
Date: Wed Apr 29 09:08:45 2020 +0200
doxygen docs: Add @since tags to EE selection API
This is the first time Ecore_Evas selection API is released so it has
earned some @since 1.24 tags.
Also, put these methods in their own group.
---
src/lib/ecore_evas/Ecore_Evas.h | 51 +++--
1 file changed, 49 insertions(+), 2 deletions(-)
diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h
index e17208aba2..89a9ff843f 100644
--- a/src/lib/ecore_evas/Ecore_Evas.h
+++ b/src/lib/ecore_evas/Ecore_Evas.h
@@ -45,7 +45,7 @@
/* FIXME:
* to do soon:
- * - iconfication api needs to work
+ * - iconification api needs to work
* - maximization api needs to work
*
* later:
@@ -3667,11 +3667,24 @@ EAPI unsigned long ecore_evas_pixmap_colormap_get(const
Ecore_Evas *ee);
*/
EAPI int ecore_evas_pixmap_depth_get(const Ecore_Evas *ee);
+/** @defgroup Ecore_Evas_Selection_Group Ecore_Evas methods to handle selection
+ *
+ * These methods perform Copy and Drag operations.
+ *
+ * @since 1.24
+ *
+ * @{
+ */
+
+/** @brief Data buffer to use in Copy (and Drag) operations
+ *
+ * @since 1.24
+ */
typedef enum {
ECORE_EVAS_SELECTION_BUFFER_SELECTION_BUFFER = 0, /**< Stores selected
/ highlighted selection */
ECORE_EVAS_SELECTION_BUFFER_COPY_AND_PASTE_BUFFER = 1, /**< Stores copied
things (Ctrl + C) */
ECORE_EVAS_SELECTION_BUFFER_DRAG_AND_DROP_BUFFER = 2, /**< Stores dragged
things while drag and drop is happening. */
- ECORE_EVAS_SELECTION_BUFFER_LAST = 3,
+ ECORE_EVAS_SELECTION_BUFFER_LAST = 3, /**< Sentinel value.
Do not use. */
} Ecore_Evas_Selection_Buffer;
/**
@@ -3679,6 +3692,8 @@ typedef enum {
*
* @param[in] ee The Ecore_Evas that handles this selection.
* @param[in] selection The selection buffer that has changed.
+ *
+ * @since 1.24
*/
typedef void (*Ecore_Evas_Selection_Changed_Cb)(Ecore_Evas *ee, unsigned int
seat, Ecore_Evas_Selection_Buffer selection);
@@ -3695,6 +3710,8 @@ typedef void
(*Ecore_Evas_Selection_Changed_Cb)(Ecore_Evas *ee, unsigned int sea
*
* @warning If and when this function is called depends on the underlying
* windowing system.
+ *
+ * @since 1.24
*/
EAPI void ecore_evas_callback_selection_changed_set(Ecore_Evas *ee,
Ecore_Evas_Selection_Changed_Cb cb);
@@ -3708,6 +3725,8 @@ EAPI void
ecore_evas_callback_selection_changed_set(Ecore_Evas *ee, Ecore_Evas_S
*
* @note Only ECORE_EVAS_SELECTION_BUFFER_SELECTION_BUFFER and
ECORE_EVAS_SELECTION_BUFFER_COPY_AND_PASTE_BUFFER
* buffers can be set. Drag and drop operations use a different set of methods.
+ *
+ * @since 1.24
*/
EAPI Eina_Bool ecore_evas_selection_set(Ecore_Evas *ee, unsigned int seat,
Ecore_Evas_Selection_Buffer buffer, Eina_Content *content);
@@ -3723,6 +3742,8 @@ EAPI Eina_Bool ecore_evas_selection_set(Ecore_Evas *ee,
unsigned int seat, Ecore
*
* @note Due to the asynchronous nature of selection buffers, this method
might not return
* the right result when invoked from the selection callback set with
ecore_evas_callback_selection_changed_set.
+ *
+ * @since 1.24
*/
EAPI Eina_Bool ecore_evas_selection_exists(Ecore_Evas *ee, unsigned int seat,
Ecore_Evas_Selection_Buffer buffer);
@@ -3741,6 +3762,8 @@ EAPI Eina_Bool ecore_evas_selection_exists(Ecore_Evas
*ee, unsigned int seat, Ec
*
* This method is time consuming, therefore, it is recommended to verify the
existence of a selection
* using ecore_evas_selection_exists before calling it.
+ *
+ * @since 1.24
*/
EAPI Eina_Future* ecore_evas_selection_get(Ecore_Evas *ee, unsigned int seat,
Ecore_Evas_Selection_Buffer buffer, Eina_Iterator *acceptable_types);
@@ -3753,6 +3776,8 @@ EAPI Eina_Future* ecore_evas_selection_get(Ecore_Evas
*ee, unsigned int seat, Ec
* @param[in] inside @c EINA_TRUE if the pointer just entered this window. @c
EINA_FALSE if it has just exited.
*
* Set this callback using ecore_evas_callback_drop_state_changed_set.
+ *
+ * @since 1.24
*/
typedef void (*Ecore_Evas_Drag_Finished_Cb)(Ecore_Evas *ee, unsigned int seat,
void *data, Eina_Bool accepted);
@@ -3773,6 +3798,8 @@ typedef void (*Ecore_Evas_Drag_Finished_Cb)(Ecore_Evas
*ee, unsigned int seat, v
* @return @c EINA_TRUE if the drag operation has been successfully started.
*
* This method must be called when a drag operation is initiated in order to
provide the necessary information.
+ *
+ * @since 1.24
*/
EAPI Eina_Bool ecore_evas_drag_start(Ecore_Evas *ee, unsigned int seat,
Eina_Content *content, Ecore_Evas *drag_rep,
const char* action,
Ecore_Evas_Drag_Finished_Cb terminate_cb, void *data);
@@ -3784,6 +3811,8 @@ EA
[EGIT] [core/efl] master 02/03: doxygen docs: Put Evas_Canvas legacy methods in the right group
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=0aa18d93cae23853a117e5a08061fa30c778d9f2 commit 0aa18d93cae23853a117e5a08061fa30c778d9f2 Author: Xavi Artigas Date: Mon Apr 27 15:54:10 2020 +0200 doxygen docs: Put Evas_Canvas legacy methods in the right group "Evas_Group" does not exist, and "Evas" is a top-level group without content (only subgroups). So I guess all these methods belong to the "Evas_Canvas" group. This brings even more docs into existence, fixing multiple missing references. --- src/lib/evas/canvas/evas_canvas_eo.legacy.h | 130 ++-- 1 file changed, 65 insertions(+), 65 deletions(-) diff --git a/src/lib/evas/canvas/evas_canvas_eo.legacy.h b/src/lib/evas/canvas/evas_canvas_eo.legacy.h index edd47fd76b..3ef5d4c37d 100644 --- a/src/lib/evas/canvas/evas_canvas_eo.legacy.h +++ b/src/lib/evas/canvas/evas_canvas_eo.legacy.h @@ -22,7 +22,7 @@ typedef Eo Evas_Canvas; * @param[in] obj The object. * @param[in] size The cache size. * - * @ingroup Evas_Group + * @ingroup Evas_Canvas */ EAPI void evas_image_cache_set(Evas_Canvas *obj, int size); @@ -35,7 +35,7 @@ EAPI void evas_image_cache_set(Evas_Canvas *obj, int size); * * @return The cache size. * - * @ingroup Evas_Group + * @ingroup Evas_Canvas */ EAPI int evas_image_cache_get(const Evas_Canvas *obj); @@ -51,7 +51,7 @@ EAPI int evas_image_cache_get(const Evas_Canvas *obj); * * @since 1.2 * - * @ingroup Evas_Group + * @ingroup Evas_Canvas */ EAPI void evas_event_default_flags_set(Evas_Canvas *obj, Evas_Event_Flags flags); @@ -66,7 +66,7 @@ EAPI void evas_event_default_flags_set(Evas_Canvas *obj, Evas_Event_Flags flags) * * @since 1.2 * - * @ingroup Evas_Group + * @ingroup Evas_Canvas */ EAPI Evas_Event_Flags evas_event_default_flags_get(const Evas_Canvas *obj); @@ -76,7 +76,7 @@ EAPI Evas_Event_Flags evas_event_default_flags_get(const Evas_Canvas *obj); * @param[in] obj The object. * @param[in] size The size in bytes. * - * @ingroup Evas_Group + * @ingroup Evas_Canvas */ EAPI void evas_font_cache_set(Evas_Canvas *obj, int size); @@ -87,7 +87,7 @@ EAPI void evas_font_cache_set(Evas_Canvas *obj, int size); * * @return The size in bytes. * - * @ingroup Evas_Group + * @ingroup Evas_Canvas */ EAPI int evas_font_cache_get(const Evas_Canvas *obj); @@ -97,7 +97,7 @@ EAPI int evas_font_cache_get(const Evas_Canvas *obj); * @param[in] obj The object. * @param[in] data The attached pointer. * - * @ingroup Evas_Group + * @ingroup Evas_Canvas */ EAPI void evas_data_attach_set(Evas_Canvas *obj, void *data); @@ -108,7 +108,7 @@ EAPI void evas_data_attach_set(Evas_Canvas *obj, void *data); * * @return The attached pointer. * - * @ingroup Evas_Group + * @ingroup Evas_Canvas */ EAPI void *evas_data_attach_get(const Evas_Canvas *obj); @@ -136,7 +136,7 @@ EAPI void *evas_data_attach_get(const Evas_Canvas *obj); * * @return The object that has focus or @c null if there is not one. * - * @ingroup Evas_Group + * @ingroup Evas_Canvas */ EAPI Efl_Canvas_Object *evas_focus_get(const Evas_Canvas *obj) EINA_WARN_UNUSED_RESULT; @@ -152,7 +152,7 @@ EAPI Efl_Canvas_Object *evas_focus_get(const Evas_Canvas *obj) EINA_WARN_UNUSED_ * * @since 1.19 * - * @ingroup Evas_Group + * @ingroup Evas_Canvas */ EAPI Efl_Canvas_Object *evas_seat_focus_get(const Evas_Canvas *obj, Evas_Device *seat); @@ -172,7 +172,7 @@ EAPI Efl_Canvas_Object *evas_seat_focus_get(const Evas_Canvas *obj, Evas_Device * * @return A pointer to the highest object on it (if any) or @c null otherwise. * - * @ingroup Evas_Group + * @ingroup Evas_Canvas */ EAPI Efl_Canvas_Object *evas_object_top_get(const Evas_Canvas *obj) EINA_WARN_UNUSED_RESULT; @@ -186,7 +186,7 @@ EAPI Efl_Canvas_Object *evas_object_top_get(const Evas_Canvas *obj) EINA_WARN_UN * * @since 1.19 * - * @ingroup Evas_Group + * @ingroup Evas_Canvas */ EAPI void evas_pointer_canvas_xy_by_device_get(const Evas_Canvas *obj, Evas_Device *dev, int *x, int *y); @@ -202,7 +202,7 @@ EAPI void evas_pointer_canvas_xy_by_device_get(const Evas_Canvas *obj, Evas_Devi * @param[out] x The pointer to a Evas_Coord to be filled in. * @param[out] y The pointer to a Evas_Coord to be filled in. * - * @ingroup Evas_Group + * @ingroup Evas_Canvas */ EAPI void evas_pointer_canvas_xy_get(const Evas_Canvas *obj, int *x, int *y); @@ -215,7 +215,7 @@ EAPI void evas_pointer_canvas_xy_get(const Evas_Canvas *obj, int *x, int *y); * * @since 1.2 * - * @ingroup Evas_Group + * @ingroup Evas_Canvas */ EAPI int evas_event_down_count_get(const Evas_Canvas *obj); @@ -237,7 +237,7 @@ EAPI int evas_event_down_count_get(const Evas_Canvas *obj); * * @since 1.1 * - * @ingroup Evas_Group + * @ingroup Evas_Canvas */ EAPI int evas_smart_objects_calculate_count_get(const Evas_Canvas *obj);
[EGIT] [core/efl] master 01/03: doxygen docs: Fix invalid refs to Layout
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=bbba18d406444e28a59de01052cf60661de7a17e commit bbba18d406444e28a59de01052cf60661de7a17e Author: Xavi Artigas Date: Mon Apr 27 15:15:12 2020 +0200 doxygen docs: Fix invalid refs to Layout All widgets copy the same description, including an invalid reference to "Layout", which should be "Elm_Layout". SOME of them had been fixed over the years but this commit fixes all of them. This significantly reduces the number of Doxygen warnings and adds meaningful links to the docs. --- src/lib/elementary/efl_ui_clock.h | 4 ++-- src/lib/elementary/efl_ui_video.h | 6 +++--- src/lib/elementary/elc_ctxpopup.h | 2 +- src/lib/elementary/elc_fileselector.h | 2 +- src/lib/elementary/elc_fileselector_entry.h | 2 +- src/lib/elementary/elc_multibuttonentry.h | 4 ++-- src/lib/elementary/elc_naviframe.h | 2 +- src/lib/elementary/elc_popup.h | 4 ++-- src/lib/elementary/elm_actionslider.h | 4 ++-- src/lib/elementary/elm_bg.h | 2 +- src/lib/elementary/elm_bubble.h | 4 ++-- src/lib/elementary/elm_clock.h | 4 ++-- src/lib/elementary/elm_datetime.h | 4 ++-- src/lib/elementary/elm_dayselector.h| 4 ++-- src/lib/elementary/elm_diskselector.h | 2 +- src/lib/elementary/elm_flipselector.h | 4 ++-- src/lib/elementary/elm_frame.h | 4 ++-- src/lib/elementary/elm_gengrid.h| 4 ++-- src/lib/elementary/elm_genlist.h| 4 ++-- src/lib/elementary/elm_hover.h | 4 ++-- src/lib/elementary/elm_inwin.h | 4 ++-- src/lib/elementary/elm_label.h | 4 ++-- src/lib/elementary/elm_list.h | 4 ++-- src/lib/elementary/elm_panel.h | 4 ++-- src/lib/elementary/elm_panes.h | 4 ++-- src/lib/elementary/elm_progressbar.h| 4 ++-- src/lib/elementary/elm_radio.h | 4 ++-- src/lib/elementary/elm_scroller.h | 2 +- src/lib/elementary/elm_segment_control.h| 4 ++-- src/lib/elementary/elm_separator.h | 4 ++-- src/lib/elementary/elm_slider.h | 4 ++-- src/lib/elementary/elm_slideshow.h | 4 ++-- src/lib/elementary/elm_spinner.h| 4 ++-- src/lib/elementary/elm_widget_layout.h | 2 +- 34 files changed, 61 insertions(+), 61 deletions(-) diff --git a/src/lib/elementary/efl_ui_clock.h b/src/lib/elementary/efl_ui_clock.h index b5352a8b52..95849b1334 100644 --- a/src/lib/elementary/efl_ui_clock.h +++ b/src/lib/elementary/efl_ui_clock.h @@ -115,11 +115,11 @@ * The whole widget is left aligned and its size grows horizontally depending * on the current format and each field's visible/disabled state. * - * This widget inherits from the @ref Layout one, so that all the + * This widget inherits from the @ref Elm_Layout one, so that all the * functions acting on it also work for Clock objects. * * This widget emits the following signals, besides the ones sent from - * @ref Layout: + * @ref Elm_Layout : * @li @b "changed" - whenever Clock field value is changed, this * signal is sent. * @li @b "language,changed" - whenever system locale changes, this diff --git a/src/lib/elementary/efl_ui_video.h b/src/lib/elementary/efl_ui_video.h index c4cfc55815..0db9b57cba 100644 --- a/src/lib/elementary/efl_ui_video.h +++ b/src/lib/elementary/efl_ui_video.h @@ -26,16 +26,16 @@ * linked Efl_Ui_Video so it will use the video decoder, if available. It also * activates the "remember" function on the linked Efl_Ui_Video object. * - * Both widgets inherit from the @ref Layout one, so that all the + * Both widgets inherit from the @ref Elm_Layout one, so that all the * functions acting on it also work for video objects. * * This widget emits the following signals, besides the ones sent from - * @ref Layout: + * @ref Elm_Layout : * @li @c "focused" : When the video has received focus. (since 1.8) * @li @c "unfocused" : When the video has lost focus. (since 1.8) * * The player widget emits the following signals, besides the ones - * sent from @ref Layout: + * sent from @ref Elm_Layout : * - @c "forward,clicked" - the user clicked the forward button. * - @c "info,clicked" - the user clicked the info button. * - @c "next,clicked" - the user clicked the next button. diff --git a/src/lib/elementary/elc_ctxpopup.h b/src/lib/elementary/elc_ctxpopup.h index 6663f7e863..a55319cdcc 100644 --- a/src/lib/elementary/elc_ctxpopup.h +++ b/src/lib/elementary/elc_ctxpopup.h @@ -22,7 +22,7 @@ * functions acting on it also work for context popup objects (since 1.8). * * This widget emits the following signals, besides the ones sent from - * @ref Layout: + * @ref Elm_Layout : * - @c "dism
[EGIT] [core/efl] master 03/03: doxygen docs: Fix most errors on Evas_Legacy.h
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=bc7608da737082347f54cf522ed239f5b39e5f3c
commit bc7608da737082347f54cf522ed239f5b39e5f3c
Author: Xavi Artigas
Date: Mon Apr 27 17:25:27 2020 +0200
doxygen docs: Fix most errors on Evas_Legacy.h
Oh boy... References to Unified API, horribly misshapen groups,
typos, invalid commands, invalid references, and on top of that,
Evas VG.
---
src/lib/evas/Evas_Common.h | 5 +--
src/lib/evas/Evas_Legacy.h | 76 ++
src/lib/evas/Evas_Loader.h | 28 -
3 files changed, 59 insertions(+), 50 deletions(-)
diff --git a/src/lib/evas/Evas_Common.h b/src/lib/evas/Evas_Common.h
index e19fda1d37..1b9572046e 100644
--- a/src/lib/evas/Evas_Common.h
+++ b/src/lib/evas/Evas_Common.h
@@ -1261,9 +1261,10 @@ EAPI const Evas_Device
*evas_device_emulation_source_get(const Evas_Device *dev)
*/
/**
- * @defgroup Evas_Image_Group Image Functions
+ * @defgroup Evas_Image Image Functions
*
- * Functions that deal with images at canvas level.
+ * Functions that deal with images at canvas level. Compare with
+ * @ref Evas_Object_Image functions which deal with images at the object level.
*
* @ingroup Evas_Canvas
*/
diff --git a/src/lib/evas/Evas_Legacy.h b/src/lib/evas/Evas_Legacy.h
index a0499169c4..e41edfaad5 100644
--- a/src/lib/evas/Evas_Legacy.h
+++ b/src/lib/evas/Evas_Legacy.h
@@ -1562,6 +1562,7 @@ EAPI void evas_object_color_get(const Evas_Object *obj,
int *r, int *g, int *b,
*
* @param[in] x in
* @param[in] y in
+ * @ingroup Evas_Object_Group
*/
EAPI void evas_object_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y);
@@ -1571,6 +1572,7 @@ EAPI void evas_object_move(Evas_Object *obj, Evas_Coord
x, Evas_Coord y);
*
* @param[in] w in
* @param[in] h in
+ * @ingroup Evas_Object_Group
*/
EAPI void evas_object_resize(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
@@ -1578,6 +1580,7 @@ EAPI void evas_object_resize(Evas_Object *obj, Evas_Coord
w, Evas_Coord h);
*
* Retrieves whether or not the given Evas object is visible.
*
+ * @ingroup Evas_Object_Group
*/
EAPI Eina_Bool evas_object_visible_get(const Evas_Object *obj);
@@ -1753,7 +1756,7 @@ EAPI void evas_object_size_hint_padding_get(const
Evas_Object *obj, Evas_Coord *
* weight macro) or the complete one of taking each child's weight hint as real
* weights to how much of its size to allocate for them in each axis. A
* container is supposed to, after normalizing the weights of its children
- * (with weight hints), distribut the space it has to layout them by those
+ * (with weight hints), distribute the space it has to layout them by those
* factors -- most weighted children get larger in this process than the least
* ones.
*
@@ -3526,7 +3529,7 @@ EAPI Evas_Object *evas_object_rectangle_add(Evas *e)
EINA_WARN_UNUSED_RESULT EIN
* @defgroup Evas_Object_Vg Vector Graphics Object
* @ingroup Evas
*
- * Evas_Object_Vg is the scene graph for managing vector graphics objects.
+ * @ref Evas_Object_Vg is the scene graph for managing vector graphics objects.
* User can create shape objects as well as fill objects and give them to the
* Evas_Object_Vg for drawing on the screen as well as managing the lifecycle
* of the objects, enabling reuse of shape objects.
@@ -3586,6 +3589,8 @@ EAPI Evas_Object *evas_object_rectangle_add(Evas *e)
EINA_WARN_UNUSED_RESULT EIN
* @endcode
*
* @since 1.14
+ *
+ * @{
*/
/**
@@ -3691,8 +3696,6 @@ EAPI int evas_object_vg_animated_frame_get(const
Evas_Object *obj) EINA_ARG_NONN
* stroke. @ref evas_vg_shape_stroke_cap_set
*
* @since 1.24
- *
- * @ingroup Evas_Vg_Cap
*/
typedef enum Evas_Vg_Cap_Type
{
@@ -3712,12 +3715,10 @@ typedef enum Evas_Vg_Cap_Type
* @ref evas_vg_shape_stroke_join_set
*
* @since 1.24
- *
- * @ingroup Evas_Vg_Join
*/
typedef enum Evas_Vg_Join_Type
{
- EVAS_VG_JOIN_MITER = 0, /**< Used to render mitered line joins. The
intersectioni
+ EVAS_VG_JOIN_MITER = 0, /**< Used to render mitered line joins. The
intersection
* of the strokes is clipped at a line perpendicular
to
* the bisector of the angle between the strokes, at
the
* distance from the intersection of the segments
equal
@@ -3730,15 +3731,13 @@ typedef enum Evas_Vg_Join_Type
* triangular region of the corner with a straight
line
* between the outer corners of each stroke */
EVAS_VG_JOIN_LAST /**< Sentinel value to indicate last enum field
during
- * teration */
+ * iteration */
} Evas_Vg_Join;
/**
* @brief These values determine how the points are interpreted in a stream of
points.
*
* @since 1.24
- *
- * @ingroup Evas_Vg_Path_Command
*/
typedef enum Evas_Vg_Path_Command_Type
{
@
[EGIT] [core/efl] master 03/03: doxygen docs: Add missing Elementary group
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=9b4afc238a60181be545cfd1c5c5e70fe86acbc6 commit 9b4afc238a60181be545cfd1c5c5e70fe86acbc6 Author: Xavi Artigas Date: Mon Apr 27 13:40:27 2020 +0200 doxygen docs: Add missing Elementary group Elementary has a main page (elementary_main) like other libs (Ecore, Evas...) but it was missing a doxygen group like the other libs. This group is not terribly useful but it is manually referenced from dozens of places, resulting in lots of warnings. I thought this solution is simpler than removing all the manual references. --- doc/main.dox | 6 ++ 1 file changed, 6 insertions(+) diff --git a/doc/main.dox b/doc/main.dox index 46f3c4edca..a09e1548ec 100644 --- a/doc/main.dox +++ b/doc/main.dox @@ -261,3 +261,9 @@ * * @brief Physics simulation integration and visual effects. */ + +/** + * @defgroup Elementary Elementary + * + * @brief Widget library (See the @ref elementary_main main page). + */ --
[EGIT] [core/efl] master 01/03: doxygen docs: Put APIs in correct group
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=4d24b29b9dad2f739c1e5b6cc898c37180ce85c4 commit 4d24b29b9dad2f739c1e5b6cc898c37180ce85c4 Author: Xavi Artigas Date: Mon Apr 27 12:05:17 2020 +0200 doxygen docs: Put APIs in correct group "Evas_Object" does not exist as a group, so the docs for these 29 methods did not show in the output. --- src/lib/evas/Evas_Legacy.h | 56 +++--- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/src/lib/evas/Evas_Legacy.h b/src/lib/evas/Evas_Legacy.h index 423e60d193..045ed65e71 100644 --- a/src/lib/evas/Evas_Legacy.h +++ b/src/lib/evas/Evas_Legacy.h @@ -1596,7 +1596,7 @@ EAPI Eina_Bool evas_object_visible_get(const Evas_Object *obj); * @param[in] w Integer to use as the maximum width hint. * @param[in] h Integer to use as the maximum height hint. * - * @ingroup Evas_Object + * @ingroup Evas_Object_Group */ EAPI void evas_object_size_hint_max_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h); @@ -1613,7 +1613,7 @@ EAPI void evas_object_size_hint_max_set(Evas_Object *obj, Evas_Coord w, Evas_Coo * @param[out] w Integer to use as the maximum width hint. * @param[out] h Integer to use as the maximum height hint. * - * @ingroup Evas_Object + * @ingroup Evas_Object_Group */ EAPI void evas_object_size_hint_max_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h); @@ -1631,7 +1631,7 @@ EAPI void evas_object_size_hint_max_get(const Evas_Object *obj, Evas_Coord *w, E * @param[in] w Integer to use as the preferred width hint. * @param[in] h Integer to use as the preferred height hint. * - * @ingroup Evas_Object + * @ingroup Evas_Object_Group */ EAPI void evas_object_size_hint_request_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h); @@ -1648,7 +1648,7 @@ EAPI void evas_object_size_hint_request_set(Evas_Object *obj, Evas_Coord w, Evas * @param[out] w Integer to use as the preferred width hint. * @param[out] h Integer to use as the preferred height hint. * - * @ingroup Evas_Object + * @ingroup Evas_Object_Group */ EAPI void evas_object_size_hint_request_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h); @@ -1666,7 +1666,7 @@ EAPI void evas_object_size_hint_request_get(const Evas_Object *obj, Evas_Coord * * @param[in] w Integer to use as the minimum width hint. * @param[in] h Integer to use as the minimum height hint. * - * @ingroup Evas_Object + * @ingroup Evas_Object_Group */ EAPI void evas_object_size_hint_min_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h); @@ -1681,7 +1681,7 @@ EAPI void evas_object_size_hint_min_set(Evas_Object *obj, Evas_Coord w, Evas_Coo * See also @ref evas_object_clip_set, @ref evas_object_clipees_get and * @ref evas_object_clip_get. * - * @ingroup Evas_Object + * @ingroup Evas_Object_Group */ EAPI void evas_object_clip_unset(Evas_Object *obj); @@ -1698,7 +1698,7 @@ EAPI void evas_object_clip_unset(Evas_Object *obj); * @param[out] w Integer to use as the minimum width hint. * @param[out] h Integer to use as the minimum height hint. * - * @ingroup Evas_Object + * @ingroup Evas_Object_Group */ EAPI void evas_object_size_hint_min_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h); @@ -1716,7 +1716,7 @@ EAPI void evas_object_size_hint_min_get(const Evas_Object *obj, Evas_Coord *w, E * @param[in] t Integer to specify top padding. * @param[in] b Integer to specify bottom padding. * - * @ingroup Evas_Object + * @ingroup Evas_Object_Group */ EAPI void evas_object_size_hint_padding_set(Evas_Object *obj, Evas_Coord l, Evas_Coord r, Evas_Coord t, Evas_Coord b); @@ -1737,7 +1737,7 @@ EAPI void evas_object_size_hint_padding_set(Evas_Object *obj, Evas_Coord l, Evas * @param[out] t Integer to specify top padding. * @param[out] b Integer to specify bottom padding. * - * @ingroup Evas_Object + * @ingroup Evas_Object_Group */ EAPI void evas_object_size_hint_padding_get(const Evas_Object *obj, Evas_Coord *l, Evas_Coord *r, Evas_Coord *t, Evas_Coord *b); @@ -1762,7 +1762,7 @@ EAPI void evas_object_size_hint_padding_get(const Evas_Object *obj, Evas_Coord * * @param[in] x Non-negative double value to use as horizontal weight hint. * @param[in] y Non-negative double value to use as vertical weight hint. * - * @ingroup Evas_Object + * @ingroup Evas_Object_Group */ EAPI void evas_object_size_hint_weight_set(Evas_Object *obj, double x, double y); @@ -1785,7 +1785,7 @@ EAPI void evas_object_size_hint_weight_set(Evas_Object *obj, double x, double y) * @param[out] x Non-negative double value to use as horizontal weight hint. * @param[out] y Non-negative double value to use as vertical weight hint. * - * @ingroup Evas_Object + * @ingroup Evas_Object_Group */ EAPI void evas_object_size_hint_weight_get(const Evas_Object *obj, double *x, double *y); @@ -1816,7 +1816,7 @@
[EGIT] [core/efl] master 02/03: doxygen docs: Match doc with correct enum for Render_Op
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=0e1d931be96eee38f15e8c5219f8df16811d1b71
commit 0e1d931be96eee38f15e8c5219f8df16811d1b71
Author: Xavi Artigas
Date: Mon Apr 27 12:28:57 2020 +0200
doxygen docs: Match doc with correct enum for Render_Op
Docs did not match the intended enum value due to incorrect usage of the
doxygen tags.
Also, Evas_Render_Op was the only member of the top-level Evas group, so
I moved it inside one subgroup, where methods using it reside.
---
src/lib/evas/Evas_Legacy.h | 26 +-
1 file changed, 13 insertions(+), 13 deletions(-)
diff --git a/src/lib/evas/Evas_Legacy.h b/src/lib/evas/Evas_Legacy.h
index 045ed65e71..a0499169c4 100644
--- a/src/lib/evas/Evas_Legacy.h
+++ b/src/lib/evas/Evas_Legacy.h
@@ -2137,28 +2137,28 @@ EAPI Eina_Bool evas_object_clipees_has(const
Evas_Object *obj) EINA_WARN_UNUSED_
/** How the object should be rendered to output.
*
- * @ingroup Evas
+ * @ingroup Evas_Object_Group
*/
typedef enum
{
- EVAS_RENDER_BLEND = 0, /** Default render operation: d = d*(1-sa) + s. The
+ EVAS_RENDER_BLEND = 0, /**< Default render operation: d = d*(1-sa) + s. The
* object will be merged onto the bottom objects using
* simple alpha compositing (a over b). */
- EVAS_RENDER_BLEND_REL = 1, /** DEPRECATED. d = d*(1 - sa) + s*da */
- EVAS_RENDER_COPY = 2, /** Copy mode, d = s. The object's pixels will replace
+ EVAS_RENDER_BLEND_REL = 1, /**< DEPRECATED. d = d*(1 - sa) + s*da */
+ EVAS_RENDER_COPY = 2, /**< Copy mode, d = s. The object's pixels will replace
* everything that was below, effectively hiding them.
*/
- EVAS_RENDER_COPY_REL = 3, /** DEPRECATED. d = s*da */
- EVAS_RENDER_ADD = 4, /** DEPRECATED. d = d + s */
- EVAS_RENDER_ADD_REL = 5, /** DEPRECATED. d = d + s*da */
- EVAS_RENDER_SUB = 6, /** DEPRECATED. d = d - s */
- EVAS_RENDER_SUB_REL = 7, /** DEPRECATED. d = d - s*da */
- EVAS_RENDER_TINT = 8, /** DEPRECATED. d = d*s + d*(1 - sa) + s*(1 - da) */
- EVAS_RENDER_TINT_REL = 9, /** DEPRECATED. d = d*(1 - sa + s) */
- EVAS_RENDER_MASK = 10, /** DEPRECATED. d = d*sa. For masking support, please
+ EVAS_RENDER_COPY_REL = 3, /**< DEPRECATED. d = s*da */
+ EVAS_RENDER_ADD = 4, /**< DEPRECATED. d = d + s */
+ EVAS_RENDER_ADD_REL = 5, /**< DEPRECATED. d = d + s*da */
+ EVAS_RENDER_SUB = 6, /**< DEPRECATED. d = d - s */
+ EVAS_RENDER_SUB_REL = 7, /**< DEPRECATED. d = d - s*da */
+ EVAS_RENDER_TINT = 8, /**< DEPRECATED. d = d*s + d*(1 - sa) + s*(1 - da) */
+ EVAS_RENDER_TINT_REL = 9, /**< DEPRECATED. d = d*(1 - sa + s) */
+ EVAS_RENDER_MASK = 10, /**< DEPRECATED. d = d*sa. For masking support, please
* use Efl.Canvas.Object.clip_set or EDC "clip_to"
instead.
*/
- EVAS_RENDER_MUL = 11 /** DEPRECATED. d = d*s */
+ EVAS_RENDER_MUL = 11 /**< DEPRECATED. d = d*s */
} Evas_Render_Op;
/**
--
[EGIT] [tools/examples] master 01/01: calculator: Adapt to latest Text_Cursor API
xartigas pushed a commit to branch master.
http://git.enlightenment.org/tools/examples.git/commit/?id=df21c3770ee38bd0721a7cf19586b2c0650366a6
commit df21c3770ee38bd0721a7cf19586b2c0650366a6
Author: Xavi Artigas
Date: Mon Apr 27 12:19:03 2020 +0200
calculator: Adapt to latest Text_Cursor API
---
apps/c/calculator/src/calculator.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/apps/c/calculator/src/calculator.c
b/apps/c/calculator/src/calculator.c
index b6bc49e6..a791fb0a 100644
--- a/apps/c/calculator/src/calculator.c
+++ b/apps/c/calculator/src/calculator.c
@@ -54,8 +54,8 @@ _button_pressed_cb(void *data, const Efl_Event *event
EINA_UNUSED)
efl_text_set(_screen, "");
_must_overwrite = EINA_FALSE;
}
-Efl_Text_Cursor *cursor =
efl_text_interactive_main_cursor_get(_screen);
-efl_text_cursor_text_insert(cursor, str);
+Efl_Text_Cursor_Object *cursor =
efl_text_interactive_main_cursor_get(_screen);
+efl_text_cursor_object_text_insert(cursor, str);
}
else
{
--
[EGIT] [core/efl] master 01/01: doxygen docs: Document compositor sync API as deprecated
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=4cf59afcc96e7977d8039be289d42e587c607c0e commit 4cf59afcc96e7977d8039be289d42e587c607c0e Author: Xavi Artigas Date: Mon Apr 27 10:01:09 2020 +0200 doxygen docs: Document compositor sync API as deprecated This is currently a NOP and we should remove this API later on. Meanwhile, turn the note about this API being experimental into a deprecation warning. --- src/lib/ecore_evas/Ecore_Evas.h | 10 -- 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h index 054fa79f1a..b8d2a878dd 100644 --- a/src/lib/ecore_evas/Ecore_Evas.h +++ b/src/lib/ecore_evas/Ecore_Evas.h @@ -202,7 +202,7 @@ EAPI int ecore_evas_shutdown(void); * Turns on client+server synchronized rendering in X11. App comp sync * is disabled by default, but can be turned on optionally. * - * @note This is an experimental functionality and is likely to be removed. + * @warning This is a deprecated API. DO NOT USE. * * @param do_sync True to enable comp syncing, False to disable */ @@ -213,7 +213,7 @@ EAPI voidecore_evas_app_comp_sync_set(Eina_Bool do_sync); * * @return True if app comp sync is enabled. * - * @note This is an experimental functionality and is likely to be removed. + * @warning This is a deprecated API. DO NOT USE. * */ EAPI Eina_Bool ecore_evas_app_comp_sync_get(void); @@ -2891,8 +2891,7 @@ EAPI voidecore_evas_manual_render(Ecore_Evas *ee); * set via the ECORE_EVAS_COMP_NOSYNC / ECORE_EVAS_COMP_SYNC * environmental variables. * - * @note This is an experimental functionality and is likely to be - * removed in future versions of EFL. + * @warning This is a deprecated API. DO NOT USE. */ EAPI voidecore_evas_comp_sync_set(Ecore_Evas *ee, Eina_Bool do_sync); @@ -2902,8 +2901,7 @@ EAPI voidecore_evas_comp_sync_set(Ecore_Evas *ee, Eina_Bool do_sync); * @param ee An @c Ecore_Evas handle * @return True if composition synchronization is enabled, False otherwise * - * @note This is an experimental functionality and is likely to be - * removed in future versions of EFL. + * @warning This is a deprecated API. DO NOT USE. */ EAPI Eina_Bool ecore_evas_comp_sync_get(const Ecore_Evas *ee); --
[EGIT] [core/efl] master 01/01: doxygen docs: Fix all invalid @param names
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=e7f4bc4c2a669973e3796e2f9d3a87c610ded6eb commit e7f4bc4c2a669973e3796e2f9d3a87c610ded6eb Author: Xavi Artigas Date: Mon Apr 20 12:22:44 2020 +0200 doxygen docs: Fix all invalid @param names There were quite a few of these... --- src/lib/ecore/Ecore_Eo.h| 2 +- src/lib/ecore_con/Ecore_Con.h | 4 ++-- src/lib/ecore_drm/Ecore_Drm.h | 4 ++-- src/lib/ecore_drm/ecore_drm_evdev.c | 2 +- src/lib/ecore_drm2/Ecore_Drm2.h | 12 ++-- src/lib/ecore_imf/Ecore_IMF.h | 2 +- src/lib/ecore_wayland/Ecore_Wayland.h | 9 + src/lib/ecore_win32/Ecore_Win32.h | 9 +++-- src/lib/edje/Edje_Common.h | 2 +- src/lib/elementary/elm_datetime.h | 2 +- src/lib/elementary/elm_helper.h | 2 +- src/lib/elementary/elm_scroller_legacy.h| 2 +- src/lib/elementary/elm_win_legacy.h | 2 +- src/lib/elput/Elput.h | 1 - src/lib/emile/emile_base64.h| 6 +++--- src/lib/evas/Evas_Common.h | 4 ++-- src/lib/evas/Evas_Legacy.h | 4 ++-- src/lib/evas/canvas/evas_textblock_legacy.h | 4 ++-- src/lib/evil/evil_mman.h| 2 +- 19 files changed, 36 insertions(+), 39 deletions(-) diff --git a/src/lib/ecore/Ecore_Eo.h b/src/lib/ecore/Ecore_Eo.h index d017ef9cb0..4e94344efe 100644 --- a/src/lib/ecore/Ecore_Eo.h +++ b/src/lib/ecore/Ecore_Eo.h @@ -68,7 +68,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); diff --git a/src/lib/ecore_con/Ecore_Con.h b/src/lib/ecore_con/Ecore_Con.h index d8b9583c3d..3cc1d09417 100644 --- a/src/lib/ecore_con/Ecore_Con.h +++ b/src/lib/ecore_con/Ecore_Con.h @@ -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); diff --git a/src/lib/ecore_drm/Ecore_Drm.h b/src/lib/ecore_drm/Ecore_Drm.h index ad60ca37c9..6d87efded5 100644 --- a/src/lib/ecore_drm/Ecore_Drm.h +++ b/src/lib/ecore_drm/Ecore_Drm.h @@ -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 * diff --git a/src/lib/ecore_drm/ecore_drm_evdev.c b/src/lib/ecore_drm/ecore_drm_evdev.c index 4fa66bc076..c907769be9 100644 --- a/src/lib/ecore_drm/ecore_drm_evdev.c +++ b/src/lib/ecore_drm/ecore_drm_evdev.c @@ -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. * diff --git a/src/lib/ecore_drm2/Ecore_Drm2.h b/src/lib/ecore_drm2/Ecore_Drm2.h index 5c43258177..26e55b670a 100644 --- a/src/lib/ecore_drm2/Ecore_Drm2.h +++ b/src/lib/ecore_drm2/Ecore_Drm2.h @@ -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
[EGIT] [core/efl] master 01/01: doxygen docs: Fix invalid doxygen output
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=047ee79cca39909fbba81b728eb4082280feacf9 commit 047ee79cca39909fbba81b728eb4082280feacf9 Author: Xavi Artigas Date: Wed Apr 15 11:33:15 2020 +0200 doxygen docs: Fix invalid doxygen output This particular line produces mismatched XML and HTML tags: "force a rendering update on ee" --- src/lib/ecore_evas/Ecore_Evas.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h index f53586a866..054fa79f1a 100644 --- a/src/lib/ecore_evas/Ecore_Evas.h +++ b/src/lib/ecore_evas/Ecore_Evas.h @@ -1740,7 +1740,7 @@ EAPI Ecore_Evas *ecore_evas_buffer_allocfunc_new(int w, int h, void *(*alloc * @return A pointer to the internal pixels array of @p ee * * Besides returning a pointer to the actual pixel array of the given - * canvas, this call will force a rendering update on @p ee, + * canvas, this call will force a rendering update on @p ee * first. * * A common use case for this call is to create an image object, from --
[EGIT] [core/efl] master 02/07: doxygen docs: Proper usage of @ingroup and @addtogroup
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=f528001f0dc7c52f54fbabd08c2d4ad8909db768
commit f528001f0dc7c52f54fbabd08c2d4ad8909db768
Author: Xavi Artigas
Date: Tue Apr 14 16:11:04 2020 +0200
doxygen docs: Proper usage of @ingroup and @addtogroup
This patch brings in a lot of docs which were missing before.
Unfortunately, this brings along their warnings so this ends up adding
more warnings than it fixes. Still, a step in the right direction.
@ingroup puts the current block into the specified group, but IT DOES NOT
allow opening groups with @{.
This was used in lots of places, resulting in misplaced or ignored
documentation.
@ingroup should be used only in individual docs. For groups we use
@defgroup and
@addtogroup.
Also,this patch adds some small missing docs.
---
src/lib/ecore/Ecore_Common.h| 4 ++--
src/lib/ecore/Ecore_Eo.h| 8
src/lib/ecore/Ecore_Legacy.h| 16 ++-
src/lib/edje/Edje_Legacy.h | 24 +++
src/lib/evas/Evas_Common.h | 4 +---
src/lib/evas/Evas_Legacy.h | 30 ++---
src/lib/evas/canvas/evas_textblock_legacy.h | 5 ++---
7 files changed, 37 insertions(+), 54 deletions(-)
diff --git a/src/lib/ecore/Ecore_Common.h b/src/lib/ecore/Ecore_Common.h
index 4ee0dd768b..899debc267 100644
--- a/src/lib/ecore/Ecore_Common.h
+++ b/src/lib/ecore/Ecore_Common.h
@@ -4,8 +4,8 @@
#include
/**
- * @ingroup Ecore
* @defgroup Ecore_Init_Group Ecore initialization, shutdown functions and
reset on fork.
+ * @ingroup Ecore
* @{
*/
@@ -2660,8 +2660,8 @@ EAPI double ecore_throttle_get(void);
*/
/**
- * @ingroup Ecore_Main_Loop_Group
* @defgroup Ecore_Poller_Group Ecore Poll functions
+ * @ingroup Ecore_Main_Loop_Group
*
* Ecore poller provides infrastructure for the creation of pollers. Pollers
* are, in essence, callbacks that share a single timer per type. Because not
diff --git a/src/lib/ecore/Ecore_Eo.h b/src/lib/ecore/Ecore_Eo.h
index 02b44f3482..d017ef9cb0 100644
--- a/src/lib/ecore/Ecore_Eo.h
+++ b/src/lib/ecore/Ecore_Eo.h
@@ -5,7 +5,7 @@
#include
/**
- * @ingroup Ecore_Timer_Group
+ * @addtogroup Ecore_Timer_Group
*
* @{
*/
@@ -21,7 +21,7 @@
#include "efl_loop_message_future_handler.eo.h"
/**
- * @ingroup Ecore_MainLoop_Group
+ * @addtogroup Ecore_MainLoop_Group
*
* @{
*/
@@ -93,7 +93,7 @@ EAPI Eo *efl_main_loop_get(void);
*/
/**
- * @ingroup Ecore_Fd_Io_Group
+ * @addtogroup Ecore_Fd_Io_Group
*
* @{
*/
@@ -115,7 +115,7 @@ EAPI Eo *efl_main_loop_get(void);
*/
/**
- * @ingroup Ecore_Model_Group
+ * @addtogroup Ecore_Model_Group
*
* @{
*/
diff --git a/src/lib/ecore/Ecore_Legacy.h b/src/lib/ecore/Ecore_Legacy.h
index d39ecb66f1..e4ed2773c1 100644
--- a/src/lib/ecore/Ecore_Legacy.h
+++ b/src/lib/ecore/Ecore_Legacy.h
@@ -2,7 +2,7 @@
#define _ECORE_LEGACY_H
/**
- * @ingroup Ecore_Poller_Group
+ * @addtogroup Ecore_Poller_Group
*
* @{
*/
@@ -76,8 +76,6 @@ EAPI double ecore_poller_poll_interval_get(Ecore_Poller_Type
type);
* @param[in] interval The tick interval; must be a power of 2 and <= 32768.
*
* @return @c true on success, @c false on failure.
- *
- * @ingroup Ecore_Poller
*/
EAPI Eina_Bool ecore_poller_poller_interval_set(Ecore_Poller *obj, int
interval);
@@ -85,8 +83,6 @@ EAPI Eina_Bool ecore_poller_poller_interval_set(Ecore_Poller
*obj, int interval)
* @brief Polling interval rate of the poller.
*
* @return The tick interval; must be a power of 2 and <= 32768.
- *
- * @ingroup Ecore_Poller
*/
EAPI int ecore_poller_poller_interval_get(const Ecore_Poller *obj);
@@ -95,7 +91,7 @@ EAPI int ecore_poller_poller_interval_get(const Ecore_Poller
*obj);
*/
/**
- * @ingroup Ecore_Animator_Group
+ * @addtogroup Ecore_Animator_Group
*
* @{
*/
@@ -209,7 +205,7 @@ EAPI void ecore_animator_thaw(Ecore_Animator *animator);
*/
/**
- * @ingroup Ecore_Timer_Group
+ * @addtogroup Ecore_Timer_Group
*
* @{
*/
@@ -306,7 +302,7 @@ EAPI void ecore_timer_thaw(Ecore_Timer *timer);
*/
/**
- * @ingroup Ecore_Idle_Group
+ * @addtogroup Ecore_Idle_Group
*
* @{
*/
@@ -391,7 +387,7 @@ EAPI void *ecore_idle_exiter_del(Ecore_Idle_Exiter
*idle_exiter);
*/
/**
- * @ingroup Ecore_Exe_Group
+ * @addtogroup Ecore_Exe_Group
*
* @{
*/
@@ -403,7 +399,7 @@ EAPI void *ecore_idle_exiter_del(Ecore_Idle_Exiter
*idle_exiter);
*/
/**
- * @ingroup Ecore_Job_Group
+ * @addtogroup Ecore_Job_Group
*
* @{
*/
diff --git a/src/lib/edje/Edje_Legacy.h b/src/lib/edje/Edje_Legacy.h
index 962e175160..d91301ce92 100644
--- a/src/lib/edje/Edje_Legacy.h
+++ b/src/lib/edje/Edje_Legacy.h
@@ -464,21 +464,21 @@ EAPI void edje_object_text_change_cb_set(Evas_Object
*obj, Edje_Text_Change_Cb f
[EGIT] [core/efl] master 07/07: doxygen docs: Define a couple missing ELM_WIN types
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=cb92494f6de5cd1596bc834b3adddcf226eec2f3 commit cb92494f6de5cd1596bc834b3adddcf226eec2f3 Author: Xavi Artigas Date: Tue Apr 14 18:44:45 2020 +0200 doxygen docs: Define a couple missing ELM_WIN types --- src/lib/elementary/elm_win_legacy.h | 12 ++-- 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/lib/elementary/elm_win_legacy.h b/src/lib/elementary/elm_win_legacy.h index 613e0eb74b..8b5c796a87 100644 --- a/src/lib/elementary/elm_win_legacy.h +++ b/src/lib/elementary/elm_win_legacy.h @@ -92,13 +92,13 @@ typedef enum * usually used in the EFL. */ /** -* Used to indicate the window is a representation of an object being -* dragged across different windows, or even applications. Typically -* used with elm_win_override_set(). -*/ + * Used to indicate the window is a representation of an object being + * dragged across different windows, or even applications. Typically + * used with elm_win_override_set(). + */ ELM_WIN_DND, - ELM_WIN_INLINED_IMAGE, - ELM_WIN_SOCKET_IMAGE, + ELM_WIN_INLINED_IMAGE, /**< The window is an image. */ + ELM_WIN_SOCKET_IMAGE, /**< The window is an image received through a socket. */ ELM_WIN_FAKE, /**< See elm_win_fake_add(). @since 1.13 */ ELM_WIN_NAVIFRAME_BASIC, /**< Used for naviframe style replacement with --
[EGIT] [core/efl] master 06/07: doxygen docs: Fix Elm_Toolbar groups
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=e594bbc33aac3052dacb263a46359f34d7ab05b2
commit e594bbc33aac3052dacb263a46359f34d7ab05b2
Author: Xavi Artigas
Date: Tue Apr 14 18:24:43 2020 +0200
doxygen docs: Fix Elm_Toolbar groups
---
src/lib/elementary/elm_toolbar_eo.legacy.h | 52 +++---
1 file changed, 26 insertions(+), 26 deletions(-)
diff --git a/src/lib/elementary/elm_toolbar_eo.legacy.h
b/src/lib/elementary/elm_toolbar_eo.legacy.h
index d16a3b2ba5..004ac0e744 100644
--- a/src/lib/elementary/elm_toolbar_eo.legacy.h
+++ b/src/lib/elementary/elm_toolbar_eo.legacy.h
@@ -21,7 +21,7 @@ typedef Eo Elm_Toolbar;
*
* See also @ref elm_toolbar_shrink_mode_set, @ref elm_toolbar_shrink_mode_get.
*
- * @ingroup Elm
+ * @ingroup Elm_Toolbar
*/
typedef enum
{
@@ -48,7 +48,7 @@ typedef enum
*
* @return The selected item or @c null.
*
- * @ingroup Elm_Toolbar_Group
+ * @ingroup Elm_Toolbar
*/
EAPI Elm_Widget_Item *elm_toolbar_selected_item_get(const Elm_Toolbar *obj);
@@ -59,7 +59,7 @@ EAPI Elm_Widget_Item *elm_toolbar_selected_item_get(const
Elm_Toolbar *obj);
*
* @return The first item or @c null.
*
- * @ingroup Elm_Toolbar_Group
+ * @ingroup Elm_Toolbar
*/
EAPI Elm_Widget_Item *elm_toolbar_first_item_get(const Elm_Toolbar *obj);
@@ -70,7 +70,7 @@ EAPI Elm_Widget_Item *elm_toolbar_first_item_get(const
Elm_Toolbar *obj);
*
* @return The last item or @c null.
*
- * @ingroup Elm_Toolbar_Group
+ * @ingroup Elm_Toolbar
*/
EAPI Elm_Widget_Item *elm_toolbar_last_item_get(const Elm_Toolbar *obj);
@@ -81,7 +81,7 @@ EAPI Elm_Widget_Item *elm_toolbar_last_item_get(const
Elm_Toolbar *obj);
*
* @return iterator to widget items
*
- * @ingroup Elm_Toolbar_Group
+ * @ingroup Elm_Toolbar
*/
EAPI Eina_Iterator *elm_toolbar_items_get(const Elm_Toolbar *obj)
EINA_WARN_UNUSED_RESULT;
@@ -94,7 +94,7 @@ EAPI Eina_Iterator *elm_toolbar_items_get(const Elm_Toolbar
*obj) EINA_WARN_UNUS
* @param[in] homogeneous Assume the items within the toolbar are of the same
* size (true = on, false = off). Default is @c false.
*
- * @ingroup Elm_Toolbar_Group
+ * @ingroup Elm_Toolbar
*/
EAPI void elm_toolbar_homogeneous_set(Elm_Toolbar *obj, Eina_Bool homogeneous);
@@ -108,7 +108,7 @@ EAPI void elm_toolbar_homogeneous_set(Elm_Toolbar *obj,
Eina_Bool homogeneous);
* @return Assume the items within the toolbar are of the same size (true = on,
* false = off). Default is @c false.
*
- * @ingroup Elm_Toolbar_Group
+ * @ingroup Elm_Toolbar
*/
EAPI Eina_Bool elm_toolbar_homogeneous_get(const Elm_Toolbar *obj);
@@ -123,7 +123,7 @@ EAPI Eina_Bool elm_toolbar_homogeneous_get(const
Elm_Toolbar *obj);
* @param[in] obj The object.
* @param[in] align The new alignment, a float between 0.0 and 1.0.
*
- * @ingroup Elm_Toolbar_Group
+ * @ingroup Elm_Toolbar
*/
EAPI void elm_toolbar_align_set(Elm_Toolbar *obj, double align);
@@ -139,7 +139,7 @@ EAPI void elm_toolbar_align_set(Elm_Toolbar *obj, double
align);
*
* @return The new alignment, a float between 0.0 and 1.0.
*
- * @ingroup Elm_Toolbar_Group
+ * @ingroup Elm_Toolbar
*/
EAPI double elm_toolbar_align_get(const Elm_Toolbar *obj);
@@ -160,7 +160,7 @@ EAPI double elm_toolbar_align_get(const Elm_Toolbar *obj);
* @param[in] mode The select mode If getting mode fails, it returns
* #ELM_OBJECT_SELECT_MODE_MAX
*
- * @ingroup Elm_Toolbar_Group
+ * @ingroup Elm_Toolbar
*/
EAPI void elm_toolbar_select_mode_set(Elm_Toolbar *obj, Elm_Object_Select_Mode
mode);
@@ -182,7 +182,7 @@ EAPI void elm_toolbar_select_mode_set(Elm_Toolbar *obj,
Elm_Object_Select_Mode m
* @return The select mode If getting mode fails, it returns
* #ELM_OBJECT_SELECT_MODE_MAX
*
- * @ingroup Elm_Toolbar_Group
+ * @ingroup Elm_Toolbar
*/
EAPI Elm_Object_Select_Mode elm_toolbar_select_mode_get(const Elm_Toolbar
*obj);
@@ -194,7 +194,7 @@ EAPI Elm_Object_Select_Mode
elm_toolbar_select_mode_get(const Elm_Toolbar *obj);
* @param[in] obj The object.
* @param[in] icon_size The icon size in pixels
*
- * @ingroup Elm_Toolbar_Group
+ * @ingroup Elm_Toolbar
*/
EAPI void elm_toolbar_icon_size_set(Elm_Toolbar *obj, int icon_size);
@@ -207,7 +207,7 @@ EAPI void elm_toolbar_icon_size_set(Elm_Toolbar *obj, int
icon_size);
*
* @return The icon size in pixels
*
- * @ingroup Elm_Toolbar_Group
+ * @ingroup Elm_Toolbar
*/
EAPI int elm_toolbar_icon_size_get(const Elm_Toolbar *obj);
@@ -232,7 +232,7 @@ EAPI int elm_toolbar_icon_size_get(const Elm_Toolbar *obj);
* @param[in] obj The object.
* @param[in] shrink_mode Toolbar's items display behavior
*
- * @ingroup Elm_Toolbar_Group
+ * @ingroup Elm_Toolbar
*/
EAPI void elm_toolbar_shrink_mode_set(Elm_Toolbar *obj,
Elm_Toolbar_Shrink_Mode shrink_mode);
@@ -258,7 +258,7 @@ EAPI void elm_toolbar_shrink_mode_set(Elm_Toolbar *obj,
Elm_Toolbar_Shrink_Mode
*
* @return Toolbar's items
[EGIT] [core/efl] master 03/07: doxygen docs: Fix misplaced Evas_Font group tags
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=a715631e1dc18d170c95d59fe328788b35d5e40d
commit a715631e1dc18d170c95d59fe328788b35d5e40d
Author: Xavi Artigas
Date: Tue Apr 14 16:53:25 2020 +0200
doxygen docs: Fix misplaced Evas_Font group tags
Putting things in the wrong group really messes up the organization.
---
src/lib/evas/Evas_Common.h | 19 ++-
1 file changed, 10 insertions(+), 9 deletions(-)
diff --git a/src/lib/evas/Evas_Common.h b/src/lib/evas/Evas_Common.h
index d7add005fb..e1b4041f11 100644
--- a/src/lib/evas/Evas_Common.h
+++ b/src/lib/evas/Evas_Common.h
@@ -3320,12 +3320,13 @@ EAPI voidevas_language_reinit(void);
* @defgroup Evas_Font_Path_Group Font Path Functions
*
* Functions that edit the paths being used to load fonts.
+ *
+ * @{
*/
/**
* Removes all font paths loaded into memory by evas_font_path_app_* APIs
* for the application.
- * @ingroup Evas_Font_Path_Group
* @since 1.9
*/
EAPI voidevas_font_path_global_clear(void);
@@ -,7 +3334,6 @@ EAPI void
evas_font_path_global_clear(void);
/**
* Appends a font path to the list of font paths used by the application.
* @param path The new font path.
- * @ingroup Evas_Font_Path_Group
* @since 1.9
*/
EAPI voidevas_font_path_global_append(const char *path)
EINA_ARG_NONNULL(1);
@@ -3341,7 +3341,6 @@ EAPI void
evas_font_path_global_append(const char *path) EINA
/**
* Prepends a font path to the list of font paths used by the application.
* @param path The new font path.
- * @ingroup Evas_Font_Path_Group
* @since 1.9
*/
EAPI voidevas_font_path_global_prepend(const char *path)
EINA_ARG_NONNULL(1);
@@ -3349,20 +3348,26 @@ EAPI void
evas_font_path_global_prepend(const char *path) EIN
/**
* Retrieves the list of font paths used by the application.
* @return The list of font paths used.
- * @ingroup Evas_Font_Path_Group
* @since 1.9
*/
EAPI const Eina_List*evas_font_path_global_list(void)
EINA_WARN_UNUSED_RESULT;
+/**
+ * @}
+ */
+
/**
* Reinitialize FontConfig. If FontConfig has to be reinitialized
* according to changes of system environments (e.g. Changing font config
files), it will be useful.
*
- * @ingroup Evas_Font_Path_Group
* @since 1.14
*/
EAPI voidevas_font_reinit(void);
+/**
+ * @}
+ */
+
// The below type are necessary for legacy API and need to be manually kept in
sync with .eo file.
#ifndef _EFL_INPUT_DEVICE_EO_CLASS_TYPE
#define _EFL_INPUT_DEVICE_EO_CLASS_TYPE
@@ -3395,7 +3400,3 @@ typedef Eo Efl_Gfx_Entity;
#endif
#endif
-
-/**
- * @}
- */
--
[EGIT] [core/efl] master 05/07: doxygen docs: Fix several invalid refs in Elm
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=0da8051ee361212a418346e1e5a32f3097c306cf commit 0da8051ee361212a418346e1e5a32f3097c306cf Author: Xavi Artigas Date: Tue Apr 14 18:13:12 2020 +0200 doxygen docs: Fix several invalid refs in Elm --- src/lib/elementary/elm_bg_legacy.h | 2 +- src/lib/elementary/elm_general.h | 4 ++-- src/lib/elementary/elm_list_eo.h | 6 +++--- src/lib/elementary/elm_list_eo.legacy.h | 6 +++--- src/lib/elementary/elm_slideshow_eo.h| 2 +- src/lib/elementary/elm_slideshow_eo.legacy.h | 2 +- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/src/lib/elementary/elm_bg_legacy.h b/src/lib/elementary/elm_bg_legacy.h index 54f6b6aaf1..abbd0b3d2a 100644 --- a/src/lib/elementary/elm_bg_legacy.h +++ b/src/lib/elementary/elm_bg_legacy.h @@ -133,7 +133,7 @@ EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option); /** * @brief Gets the mode of display of a given background widget's image * - * @return The background option Elm.Bg.Option Default is #Elm_Bg_SCALE. + * @return The background option Elm.Bg.Option Default is #ELM_BG_OPTION_SCALE. * * @see elm_bg_option_set() * diff --git a/src/lib/elementary/elm_general.h b/src/lib/elementary/elm_general.h index 8bc0ba695a..ff23de9f0f 100644 --- a/src/lib/elementary/elm_general.h +++ b/src/lib/elementary/elm_general.h @@ -23,7 +23,7 @@ // Legacy types #include "elm_general.eot.h" -/** Possible values for the #ELM_OBJECT_SELECT_MODE policy. +/** Possible values for the selection policy of some widgets. * * @since 1.7 * @@ -282,7 +282,7 @@ typedef enum * regardless of config settings */ } Elm_Policy_Throttle; -/** Possible values for the #ELM_OBJECT_MULTI_SELECT_MODE policy. +/** Possible values for the multi-selection policy of some widgets. * * @since 1.8 * diff --git a/src/lib/elementary/elm_list_eo.h b/src/lib/elementary/elm_list_eo.h index 4587ed0744..4f1b57e15e 100644 --- a/src/lib/elementary/elm_list_eo.h +++ b/src/lib/elementary/elm_list_eo.h @@ -270,7 +270,7 @@ EOAPI Elm_Widget_Item *elm_obj_list_selected_item_get(const Eo *obj); * * @param[in] obj The object. * - * @return A @c list of list items, #Elm.Widget.Item, or @c NULL on failure. + * @return A @c list of list items, #Elm_Widget_Item, or @c NULL on failure. * * @ingroup Elm_List */ @@ -297,7 +297,7 @@ EOAPI Elm_Widget_Item *elm_obj_list_first_item_get(const Eo *obj); * * @param[in] obj The object. * - * @return An @c list of list items, #Elm.Widget.Item, or @c NULL on failure. + * @return An @c list of list items, #Elm_Widget_Item, or @c NULL on failure. * * @ingroup Elm_List */ @@ -541,7 +541,7 @@ EOAPI void elm_obj_list_clear(Eo *obj); * @param[in] func The function to call when the item is clicked. * @param[in] data The data to associate with the item for related callbacks. * @param[in] cmp_func The comparing function to be used to sort list items by - * #Elm.Widget.Item item handles. This function will receive two items and + * #Elm_Widget_Item item handles. This function will receive two items and * compare them, returning a non-negative integer if the second item should be * place after the first, or negative value if should be placed before. * diff --git a/src/lib/elementary/elm_list_eo.legacy.h b/src/lib/elementary/elm_list_eo.legacy.h index 6885674baf..3a2e019c3a 100644 --- a/src/lib/elementary/elm_list_eo.legacy.h +++ b/src/lib/elementary/elm_list_eo.legacy.h @@ -263,7 +263,7 @@ EAPI Elm_Widget_Item *elm_list_selected_item_get(const Elm_List *obj); * * @param[in] obj The object. * - * @return A @c list of list items, #Elm.Widget.Item, or @c NULL on failure. + * @return A @c list of list items, #Elm_Widget_Item, or @c NULL on failure. * * @ingroup Elm_List_Group */ @@ -290,7 +290,7 @@ EAPI Elm_Widget_Item *elm_list_first_item_get(const Elm_List *obj); * * @param[in] obj The object. * - * @return An @c list of list items, #Elm.Widget.Item, or @c NULL on failure. + * @return An @c list of list items, #Elm_Widget_Item, or @c NULL on failure. * * @ingroup Elm_List_Group */ @@ -534,7 +534,7 @@ EAPI void elm_list_clear(Elm_List *obj); * @param[in] func The function to call when the item is clicked. * @param[in] data The data to associate with the item for related callbacks. * @param[in] cmp_func The comparing function to be used to sort list items by - * #Elm.Widget.Item item handles. This function will receive two items and + * #Elm_Widget_Item item handles. This function will receive two items and * compare them, returning a non-negative integer if the second item should be * place after the first, or negative value if should be placed before. * diff --git a/src/lib/elementary/elm_slideshow_eo.h b/src/lib/elementary/elm_slideshow_eo.h index 00dd7aeeb8..2c9d82cf80 100644 --- a/src/lib/
[EGIT] [core/efl] master 01/07: doxygen docs: Fix double group
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=ca0bb74321fcfc221cdb71ae849898a543cb1eda
commit ca0bb74321fcfc221cdb71ae849898a543cb1eda
Author: Xavi Artigas
Date: Tue Apr 14 12:49:53 2020 +0200
doxygen docs: Fix double group
And missing group title in one of them.
---
src/lib/evas/Evas_Legacy.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/lib/evas/Evas_Legacy.h b/src/lib/evas/Evas_Legacy.h
index 01a7babd6f..4e483321a1 100644
--- a/src/lib/evas/Evas_Legacy.h
+++ b/src/lib/evas/Evas_Legacy.h
@@ -4701,7 +4701,7 @@ EAPI void
evas_vg_gradient_radial_focal_get(Evas_Vg_Gradient_Radial *obj, double
*/
/**
- * @defgroup Evas_Object_Image
+ * @addtogroup Evas_Object_Image
*
* @{
*/
--
[EGIT] [core/efl] master 04/07: doxygen docs: Fix missing docs in Edje
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=34e6fb82c6e54b11b49f80680d7364547f6159ca
commit 34e6fb82c6e54b11b49f80680d7364547f6159ca
Author: Xavi Artigas
Date: Tue Apr 14 17:58:13 2020 +0200
doxygen docs: Fix missing docs in Edje
---
src/lib/edje/Edje_Common.h | 3 +++
src/lib/edje/Edje_Legacy.h | 13 +++--
2 files changed, 10 insertions(+), 6 deletions(-)
diff --git a/src/lib/edje/Edje_Common.h b/src/lib/edje/Edje_Common.h
index 88405624ba..954c1e6770 100644
--- a/src/lib/edje/Edje_Common.h
+++ b/src/lib/edje/Edje_Common.h
@@ -808,6 +808,7 @@ struct _Edje_External_Param_Info
#define EDJE_EXTERNAL_PARAM_INFO_SENTINEL {NULL, 0, 0, {.s = {NULL, NULL,
NULL}}}
+/** Version of the EDJE External ABI used by this library .*/
#define EDJE_EXTERNAL_TYPE_ABI_VERSION (3)
/**
@@ -860,6 +861,7 @@ struct _Edje_External_Type
Edje_External_Param_Info *parameters_info; /**< An array of
#Edje_External_Param_Info describing the different parameters this EXTERNAL may
have. The last element in the array must be #EDJE_EXTERNAL_PARAM_INFO_SENTINEL.
*/
void *data; /**< Private user data that will be passed
to all of the class functions. */
};
+/** Alias for _Edje_External_Type */
typedef struct _Edje_External_Type Edje_External_Type;
/**
@@ -873,6 +875,7 @@ struct _Edje_External_Type_Info
const Edje_External_Type *info; /**< The type definition. */
};
+/** Alias for _Edje_External_Type_Info */
typedef struct _Edje_External_Type_Info Edje_External_Type_Info;
/**
diff --git a/src/lib/edje/Edje_Legacy.h b/src/lib/edje/Edje_Legacy.h
index d91301ce92..24ef3f8b7f 100644
--- a/src/lib/edje/Edje_Legacy.h
+++ b/src/lib/edje/Edje_Legacy.h
@@ -1533,12 +1533,13 @@ EAPI double edje_object_base_scale_get(const
Evas_Object *obj);
* @{
*/
+/** Directions in which a part can be dragged .*/
typedef enum _Edje_Drag_Dir
{
- EDJE_DRAG_DIR_NONE = 0,
- EDJE_DRAG_DIR_X = 1,
- EDJE_DRAG_DIR_Y = 2,
- EDJE_DRAG_DIR_XY = 3
+ EDJE_DRAG_DIR_NONE = 0, /**< Part cannot be dragged. */
+ EDJE_DRAG_DIR_X = 1, /**< Part can be dragged in the horizontal direction.
*/
+ EDJE_DRAG_DIR_Y = 2, /**< Part can be dragged in the vertical direction. */
+ EDJE_DRAG_DIR_XY = 3 /**< Part can be dragged in every direction. */
} Edje_Drag_Dir;
/**
@@ -1628,8 +1629,8 @@ EAPI Eina_Bool edje_object_part_drag_size_get(const
Evas_Object *obj, const char
/**
* @brief Determines dragable directions.
*
- * The dragable directions are defined in the EDC file, inside the @ref
- * dragable section, by the attributes @c x and @c y. See the @ref edcref for
+ * The dragable directions are defined in the EDC file, inside the
+ * "dragable" section, by the attributes @c x and @c y. See the @ref edcref for
* more information.
*
* @param[in] part The part name
--
[EGIT] [website/www-content] master 01/01: Remove useless redirect pages
xartigas pushed a commit to branch master.
http://git.enlightenment.org/website/www-content.git/commit/?id=e4aad6baa3b5e6ec2d5e469adcbf0b9f417b6bfa
commit e4aad6baa3b5e6ec2d5e469adcbf0b9f417b6bfa
Author: Xavi Artigas
Date: Fri Apr 3 13:24:18 2020 +0200
Remove useless redirect pages
Having both a .txt and a .md.txt version of the same file is confusing and
bound to cause troubles.
Fortunately, all remaining duplicates just contain a redirect, which is
useless
because dokuwiki already uses the .md.txt file.
Also, remove half-baked about-draft files.
---
pages/about-draft.md.txt | 1 -
pages/about-draft.txt | 210 --
pages/about-edi.txt | 1 -
pages/about-efl.txt | 1 -
pages/about-enlightenment.txt | 1 -
pages/about-ephoto.txt| 1 -
pages/about-rage.txt | 1 -
pages/about-terminology.txt | 1 -
pages/about.txt | 1 -
pages/develop/guides/csharp/start.txt | 13 ---
pages/develop/tutorials/start.txt | 1 -
11 files changed, 232 deletions(-)
diff --git a/pages/about-draft.md.txt b/pages/about-draft.md.txt
deleted file mode 100644
index 11513a3d6..0
--- a/pages/about-draft.md.txt
+++ /dev/null
@@ -1 +0,0 @@
-This page is redirected to [[:about-draft]].
\ No newline at end of file
diff --git a/pages/about-draft.txt b/pages/about-draft.txt
deleted file mode 100644
index c574d7681..0
--- a/pages/about-draft.txt
+++ /dev/null
@@ -1,210 +0,0 @@
-~~Title: About~~
-
-{{page>incl:start-shortcuts}}
-
- Much more than a Window Manager
-
-Enlightenment was originally developed in the 1990s by Rasterman (Carsten
Haitzler) as a simple Window Manager for
-X11. Since then it's grown into the one million lines of C
-code that form the EFL libraries, as well as a Window Manager and a
-set of applications. There's a vibrant and active community of
-developers and users who work on and use the code every day.
-
-[[about-enlightenment|{{:icon-enlightenment.png|Enlightenment}}]]
-[[about-efl|{{:efl-core.png|EFL}}]]
-[[about-terminology|{{:icon-terminology.png|Terminology}}]]
-[[about-rage|{{:icon-rage.png|Rage}}]]
-[[about-edi|{{:edi-logo.png|EDI}}]]
-[[about-ephoto|{{:ephoto.png?128|Ephoto}}]]
-[[about-enventor|{{:icon-enventor.png|Enventor}}]]
-
-
-
-=== Enlightenment ===
-
-{{:icon-enlightenment.png?nolink |Enlightenment}}
-{{ :shot-enlightenment.png?nolink&320|Enlightenment Sample screenshot}}
-
-As we've said Enlightenment was originally built as a Window Manager.
Everything else snowballed from there. It's the flagship product,
-closely followed by EFL itself. It's a lean, fast,
-modular and very extensible window manager for X11 and Linux.
-
-Enlightenment is classed as a "desktop shell" in that it provides everything
you need to operate your desktop (or laptop) but is not a full application
suite. This covers launching applications, managing their windows and doing
other
-system tasks like suspending, reboots, managing files etc.
-
-We are moving towards using Wayland as the base display system, while
-Enlightenment is being developed to become a full Wayland compositor
-in its own right. This of course takes time and there have been some bumps
along the road. However, one day we will leave X11 behind.
-
-Of course Enlightenment is built on top of EFL, using the libraries we
-wrote for the UI as well as those for the compositor itself. This means that
any improvements to EFL are included in the compositor.
-
-Enlightenment is also the Window Manager and Compositor used by Tizen, due
-in part to its efficiency and features.
-
-See our [[about-enlightenment|About Page]] for more
-details.
-
-
-
-=== EFL ===
-
-{{:efl-core.png?nolink|Enlightenment}}
-
-Our libraries are commonly known as EFL (Enlightenment Foundation
-Libraries). They can be used independently or built on top of one other to
provide useful features and create powerful applications.
-
-The core EFL libraries are much more efficient in terms of speed and size when
compared to GTK+ and Qt equivalents and have a smaller memory footprint.
-
-=== The EFL Model ===
-
-{{:model1.png?nolink}}
-
-EFL operates on the same "main loop" concept adopted by GTK+ and many other
toolkits. Once you initialize an application in enters the Ecore main loop.
-
-The main loop continuously checks for events, handles timers, callbacks and
any other services that have previously been set up until an exit request is
sent. By way of an example if EFL were used to create a video game, the
mainloop would check for user inputs and update the game world accordingly as
you play.
-
-The mainloop is designed efficiently. It will remain idle, consuming virtually
no CPU resources until an event occurs. Events can be based on user input such
as using the mouse or time-based. Ecore
[EGIT] [core/efl] master 01/03: comments: Typos in Efl_Config.h
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=823dd0c375f812663f69ac2329d437264e25ab57 commit 823dd0c375f812663f69ac2329d437264e25ab57 Author: Xavi Artigas Date: Fri Mar 27 13:49:07 2020 +0100 comments: Typos in Efl_Config.h --- src/lib/efl/Efl_Config.h.in | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/lib/efl/Efl_Config.h.in b/src/lib/efl/Efl_Config.h.in index 56732f2c1c..3dbef96659 100644 --- a/src/lib/efl/Efl_Config.h.in +++ b/src/lib/efl/Efl_Config.h.in @@ -1,8 +1,8 @@ #ifndef EFL_CONFIG_H #define EFL_CONFIG_H -/* Add -DEFL_API_OVERRIDE ot your CFLAGS to override the default - * installed api set and then fter that -DEFL_NOLEGACY_API_SUPPORT +/* Add -DEFL_API_OVERRIDE to your CFLAGS to override the default + * installed api set and after that -DEFL_NOLEGACY_API_SUPPORT * as desired */ #ifndef EFL_API_OVERRIDE --
[EGIT] [core/efl] master 02/03: doxygen docs: Add _Eina_Version struct docs
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=3a480503f99346d3a4eee02371407e367c07812b commit 3a480503f99346d3a4eee02371407e367c07812b Author: Xavi Artigas Date: Fri Mar 27 15:29:56 2020 +0100 doxygen docs: Add _Eina_Version struct docs --- src/lib/eina/eina_main.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/lib/eina/eina_main.h b/src/lib/eina/eina_main.h index bac2d854d1..d3ed8895ab 100644 --- a/src/lib/eina/eina_main.h +++ b/src/lib/eina/eina_main.h @@ -53,6 +53,8 @@ #define EINA_VERSION_MINOR EFL_VERSION_MINOR /** + * @struct _Eina_Version + * The version of Eina. * @typedef Eina_Version * The version of Eina. */ --
[EGIT] [core/efl] master 03/03: doxygen docs: some fixes in Evas_Legacy.h
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=b1cc09a86c2ff949e07f6bc7ab1f68160b8d9c6d
commit b1cc09a86c2ff949e07f6bc7ab1f68160b8d9c6d
Author: Xavi Artigas
Date: Wed Apr 1 09:50:27 2020 +0200
doxygen docs: some fixes in Evas_Legacy.h
This brings into the docs hundreds of methods!
due to the ingroup->defgroup mistake, they were out of any scope
and therefore they were silently ignored by doxygen.
Also, document lots of missing "obj" parameters. Not strictly necessary, but
this further reduces the number of doxygen warnings.
---
src/bin/edje/edje_cc_handlers.c | 2 +-
src/lib/evas/Evas_Legacy.h | 101 ++--
2 files changed, 88 insertions(+), 15 deletions(-)
diff --git a/src/bin/edje/edje_cc_handlers.c b/src/bin/edje/edje_cc_handlers.c
index 3c9d997930..ba1edbd8c7 100644
--- a/src/bin/edje/edje_cc_handlers.c
+++ b/src/bin/edje/edje_cc_handlers.c
@@ -10479,7 +10479,7 @@
st_collections_group_parts_part_description_image_scale_hint(void)
The fill method is an optional block that defines the way an IMAGE or
PROXY part is going to be displayed inside its container.
It can be used for tiling (repeating the image) or displaying only
-part of an image. See @ref evas_object_image_fill_set() documentation
+part of an image. See evas_object_image_fill_set() documentation
for more details.
@endblock
diff --git a/src/lib/evas/Evas_Legacy.h b/src/lib/evas/Evas_Legacy.h
index b74eb717d4..01a7babd6f 100644
--- a/src/lib/evas/Evas_Legacy.h
+++ b/src/lib/evas/Evas_Legacy.h
@@ -4701,7 +4701,7 @@ EAPI void
evas_vg_gradient_radial_focal_get(Evas_Vg_Gradient_Radial *obj, double
*/
/**
- * @ingroup Evas_Object_Image
+ * @defgroup Evas_Object_Image
*
* @{
*/
@@ -4992,9 +4992,10 @@ EAPI Eina_Bool
evas_object_image_source_unset(Evas_Object *o
* }
* @endcode
*
+ * @param[in] obj The object
* @param[in] file The image file path.
* @param[in] key The image key in @p file (if its an Eet one), or @c
-NULL, otherwise.
+ *NULL, otherwise.
*/
EAPI void evas_object_image_file_set(Eo *obj, const char *file, const char
*key);
@@ -5008,9 +5009,10 @@ EAPI void evas_object_image_file_set(Eo *obj, const char
*file, const char *key)
* @note Use @c NULL pointers on the file components you're not
* interested in: they'll be ignored by the function.
*
+ * @param[in] obj The object
* @param[out] file The image file path.
* @param[out] key The image key in @p file (if its an Eet one), or @c
-NULL, otherwise.
+ * NULL, otherwise.
*/
EAPI void evas_object_image_file_get(const Eo *obj, const char **file, const
char **key);
@@ -5025,9 +5027,10 @@ EAPI void evas_object_image_file_get(const Eo *obj,
const char **file, const cha
*
* @since 1.8
*
+ * @param[in] obj The object
* @param[in] f The mmaped file
* @param[in] key The image key in @p file (if its an Eet one), or @c
-NULL, otherwise.
+ *NULL, otherwise.
*/
EAPI void evas_object_image_mmap_set(Eo *obj, const Eina_File *f, const char
*key);
@@ -5042,9 +5045,10 @@ EAPI void evas_object_image_mmap_set(Eo *obj, const
Eina_File *f, const char *ke
*
* @since 1.10
*
+ * @param[in] obj The object
* @param[out] f The mmaped file
* @param[out] key The image key in @p file (if its an Eet one), or @c
-NULL, otherwise.
+ * NULL, otherwise.
*/
EAPI void evas_object_image_mmap_get(const Eo *obj, const Eina_File **f, const
char **key);
@@ -5068,10 +5072,11 @@ EAPI void evas_object_image_mmap_get(const Eo *obj,
const Eina_File **f, const c
* compress is hint for the compression modes (Eet ones) or for the
compression flags (Png one)
* (1 == compress, 0 = don't compress).
*
+ * @param[in] obj The object
* @param[in] file The filename to be used to save the image (extension
-obligatory).
+ * obligatory).
* @param[in] key The image key in the file (if an Eet one), or @c NULL,
-otherwise.
+ *otherwise.
* @param[in] flags String containing the flags to be used (@c NULL for
none).
*/
@@ -5081,6 +5086,7 @@ EAPI Eina_Bool evas_object_image_save(const Eo *obj,
const char *file, const cha
*
* Check if an image object can be animated (have multiple frames)
*
+ * @param[in] obj The object
* @return whether obj support animation
*
* This returns if the image file of an image object is capable of animation
@@ -5144,6 +5150,7 @@ EAPI Eina_Bool evas_object_image_animated_get(const Eo
*obj);
* @ref evas_object_image_animated_frame_duration_get.
* @ref evas_object_image_animated_frame_get.
*
+ * @param[in] obj The object
* @param[in] frame_index The index of current frame.
*
* @since 1.1
@@ -5162,6 +5169,7 @@ EAPI void
evas_object_image_animated_frame_set(Evas_Object *obj, int frame_i
[EGIT] [website/www-content] master 01/01: Fix some typos in efl-debug, ASAN section.
xartigas pushed a commit to branch master. http://git.enlightenment.org/website/www-content.git/commit/?id=05816ed2fdc4bb6257249d912d0ddf395f6c83ea commit 05816ed2fdc4bb6257249d912d0ddf395f6c83ea Author: Xavi Artigas Date: Thu Apr 2 14:00:57 2020 +0200 Fix some typos in efl-debug, ASAN section. --- pages/contrib/efl-debug.txt | 16 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/pages/contrib/efl-debug.txt b/pages/contrib/efl-debug.txt index de6e3e011..dce43f542 100644 --- a/pages/contrib/efl-debug.txt +++ b/pages/contrib/efl-debug.txt @@ -296,18 +296,18 @@ In general it's a good idea to spend some quality time with GDB and do all this. === Asan === This is almost as good as Valgrind below, but drastically faster. -It's atually usable to build thing with Asan enabled and use them all -day long. You'll probably find it ueses about 2-3x the CPU and seems to +It's actually usable to build things with Asan enabled and use them all +day long. You'll probably find it uses about 2-3x the CPU and seems to use a lot of RAM (virtual size will be huge but overall footprint will be fine if you have *Gb or more of RAM). For a decently powerful desktop you should be able to use this as a daily driver especially when you are hunting bugs. Asan would definitely be the preferred deep-debugging -method and you should build at least EFL and the apps) (Enlightenment, +method and you should build at least EFL and the apps (Enlightenment, Terminology etc.) with Asan enabled to make it work correctly. To use Asan you will need to compile libraries and binaries with it -enabled and have a compiler capable of asan. Given the move to meson, -this is quite easy now. You will need this in your environmnet before +enabled and have a compiler capable of Asan. Given the move to meson, +this is quite easy now. You will need this in your environment before you compile and for when you run the application (it needs to be set before the process executes): @@ -332,14 +332,14 @@ meson -Db_sanitize=address [other meson options here] . build So just add -Db_sanitize=address as an option in addition to any other -options you may pass and that build will enable asan for what is being +options you may pass and that build will enable Asan for what is being built. What this does is instruct the compiler to add extra checking -code when compiling that does much of what valgrind does at runtime. +code when compiling that does much of what Valgrind does at runtime. The added instructions generated by the compiler sanitize addresses before they are used and adds pointer tracking logic as well. That's why this needs to be done at compile time, but since it is done at compile time, the resulting binaries are relatively fast (compared to -using valgrind). +using Valgrind). Once you did the above just compile as normal: --
[EGIT] [website/www-content] master 01/01: Remove duplicated file
xartigas pushed a commit to branch master. http://git.enlightenment.org/website/www-content.git/commit/?id=e2504e2b7bbe0316a88eb91ab6f81b298f97f578 commit e2504e2b7bbe0316a88eb91ab6f81b298f97f578 Author: Xavi Artigas Date: Thu Apr 2 13:54:02 2020 +0200 Remove duplicated file All relevant changes present in efl-debug.md.txt were already in efl-debug.txt. Having two files is confusing (only one is accessible through DokuWiki). --- pages/contrib/docs/documentation-guide.md.txt | 2 +- pages/contrib/efl-debug.md.txt| 692 -- pages/contrib/navigation.txt | 2 +- pages/contrib/report-bug.md.txt | 4 +- pages/develop/apps_efl_debugging.txt | 2 +- 5 files changed, 5 insertions(+), 697 deletions(-) diff --git a/pages/contrib/docs/documentation-guide.md.txt b/pages/contrib/docs/documentation-guide.md.txt index 19152e404..d4d27ac68 100644 --- a/pages/contrib/docs/documentation-guide.md.txt +++ b/pages/contrib/docs/documentation-guide.md.txt @@ -250,7 +250,7 @@ The format of a sidebar is shown below: ``` * [[/contrib/start]] * [[/contrib/report-bug.md]] - * [[/contrib/efl-debug.md]] + * [[/contrib/efl-debug]] * [[/contrib/enlightenment-debug.md]] * [[/contrib/devs/ | EFL Developer guide]] * [[/contrib/devs/git-guide.md]] diff --git a/pages/contrib/efl-debug.md.txt b/pages/contrib/efl-debug.md.txt deleted file mode 100644 index 903dd4c71..0 --- a/pages/contrib/efl-debug.md.txt +++ /dev/null @@ -1,692 +0,0 @@ -~~Title: Debugging EFL~~ - -# Debugging EFL # - -The following is designed as a quick reference guide for debugging the Enlightenment Foundation Libraries (EFL); it is not exhaustive, and will require previous knowledge of programming and debugging tools. - -## Compilation ## - -You will need to build EFL, Enlightenment and any othe related software to be tested with debugging compile flags. [The Get Source documentation](/docs/distros/start) will have section on this for your build environment. Remember to have ``-g`` as a ``CFLAGS`` option to ensure binaries and libraries have all the debug information required. If you didn't build with debugging, simply build again with these flags correctly set and debugging can begin. - -## EFL Logs ## - -Sometimes you will see logs as follows: - -```bash -CRI<10094>:elementary elm_toolbar.c:1453 _elm_toolbar_elm_widget_theme_apply() Failed to set layout! -*** Backtrace *** -/usr/local/lib/libeina.so.1 0x7f8c2fc0be86 0x7f8c2fbea000 -/usr/local/lib/libeina.so.1 0x7f8c2fc0d1a9 0x7f8c2fbea000 -/usr/local/lib/libelementary.so.1 0x7f8c3028c87d 0x7f8c30072000 -/usr/local/lib/libelementary.so.1 0x7f8c302aa086 0x7f8c30072000 -/usr/local/lib/libelementary.so.1 0x7f8c30288d58 0x7f8c30072000 -/usr/local/lib/libelementary.so.1 0x7f8c3028618c 0x7f8c30072000 -/usr/local/lib/libelementary.so.1 0x7f8c3028f087 0x7f8c30072000 -/usr/local/bin/terminology 0x416d58 0x40 -/usr/local/lib/libevas.so.1 0x7f8c2f3daca6 0x7f8c2f34a000 -/usr/local/lib/libeo.so.1 0x7f8c2e5ed37b 0x7f8c2e5e -/usr/local/lib/libeo.so.1 0x7f8c2e5ebbcb 0x7f8c2e5e -/usr/local/lib/libevas.so.1 0x7f8c2f3dceaa 0x7f8c2f34a000 -/usr/local/lib/libedje.so.1 0x7f8c2e87d5e1 0x7f8c2e7f8000 -/usr/local/lib/libedje.so.1 0x7f8c2e8837a7 0x7f8c2e7f8000 -/usr/local/lib/libedje.so.1 0x7f8c2e87e90f 0x7f8c2e7f8000 -/usr/local/lib/libedje.so.1 0x7f8c2e87eab7 0x7f8c2e7f8000 -/usr/local/lib/libecore.so.10x7f8c2f122d0b 0x7f8c2f11 -/usr/local/lib/libecore.so.10x7f8c2f11d775 0x7f8c2f11 -/usr/local/lib/libecore.so.10x7f8c2f1251f8 0x7f8c2f11 -/usr/local/lib/libecore.so.10x7f8c2f1253d7 0x7f8c2f11 -/usr/local/bin/terminology 0x4138b7 0x40 -/usr/local/bin/terminology 0x40c74c 0x40 -/usr/lib/libc.so.6 0x7f8c2c675800 0x7f8c2c655000 -``` - -This log shows EFL logging a critical error. There are various levels of error: critical, error, warning and debug are the main ones, but by default you should normally only see ``CRI`` (critical) and ``ERR`` error levels. - -Following the error, which includes the name of the source file and the line number on which the error was encountered, is a full backtrace. This is not generally human readable, because making it so is relatively costly so is not done at runtime. A utility to parse the backtrace for readability is provided: ``eina_btlog``. Simply do the following: - -```bash -cat > mybacktrace.txt -# copy and paste the above lines following *** Backtrace *** that start with file paths -# now hit CTRL+D to end input -cat mybacktrace.txt | eina_btlog -``` - -This tool will output a colorized log, as below, that humans can easily read. This is the log a developer needs in order to identify the full path used to trigger the issue, with functions called from the bottom to the top of the stack - so t
[EGIT] [core/efl] master 01/01: exactness docs: Add docs, fix docs, remove docs
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=0122865ee18b13292267e246a66dfb862be96143
commit 0122865ee18b13292267e246a66dfb862be96143
Author: Xavi Artigas
Date: Wed Apr 1 18:40:40 2020 +0200
exactness docs: Add docs, fix docs, remove docs
Summary:
The Exactness tool needed usage instructions... and quite some more
fixes. There was copypasta all around.
Depends on D11634
Test Plan: Build and Enjoy
Reviewers: bu5hm4n, stefan_schmidt
Reviewed By: stefan_schmidt
Subscribers: cedric, #reviewers, #committers
Tags: #efl
Differential Revision: https://phab.enlightenment.org/D11637
---
src/bin/exactness/exactness.c | 59 ++-
src/bin/exactness/exactness_play.in | 37 --
src/bin/exactness/exactness_record.in | 37 +++---
src/bin/exactness/inspect.c | 7 +++--
4 files changed, 96 insertions(+), 44 deletions(-)
diff --git a/src/bin/exactness/exactness.c b/src/bin/exactness/exactness.c
index 6599ef7741..c99fceeb99 100644
--- a/src/bin/exactness/exactness.c
+++ b/src/bin/exactness/exactness.c
@@ -417,22 +417,51 @@ _errors_sort_cb(List_Entry *a, List_Entry *b)
static const Ecore_Getopt optdesc = {
"exactness",
- "%prog [options] <-r|-p|-i|-s> ",
+ "%prog [options] <-p|-i|-s> ",
PACKAGE_VERSION,
- "(C) 2013 Enlightenment",
+ "(C) 2013-2020 Enlightenment",
"BSD",
- "A pixel perfect test suite for EFL based applications.",
+ "A pixel-perfect test suite for EFL-based applications.\n"
+ "\n"
+ "This binary allows running the individual tools `exactness_record` and\n"
+ "`exactness_play` in batch for a set of tests specified in a test list
file.\n"
+ "\n"
+ "To obtain the reference templates (the \"golden\" files):\n"
+ "1.For each tested application, run `exactness_record` to launch the\n"
+ " application and record actions like keystrokes and mouse clicks.\n"
+ " This produces a test file with `.exu` extension.\n"
+ "2.Run `exactness` in init mode (-i) to execute the stored actions in all\n"
+ " the tests in the test list file and obtain screenshots.\n"
+ " The screenshots are embedded into the test `.exu` file.\n"
+ "\n"
+ "To check if the application currently matches the reference templates:\n"
+ "1.Run `exactness` in play mode (-p) to execute the stored actions in all\n"
+ " the tests in the test list file and compare the obtained screenshots\n"
+ " with the stored versions (the reference templates).\n"
+ " If mismatches are detected an error report is produced, including\n"
+ " a graphical diff of the screenshots.\n"
+ "\n"
+ "The test list file contains one line per test. Each line starts with the\n"
+ "test file name (without the `.exu` extension), a space and then the
command\n"
+ "to execute, including parameters if any. # indicates a comment.\n"
+ "Example:\n"
+ "separator elementary_test -to Separator",
0,
{
-ECORE_GETOPT_APPEND('b', "base-dir", "The location of the exu files.",
ECORE_GETOPT_TYPE_STR),
-ECORE_GETOPT_STORE_STR('o', "output", "The location of the images."),
+ECORE_GETOPT_APPEND('b', "base-dir", "The location of the exu files.
Defaults to `./recordings/`.",
+ ECORE_GETOPT_TYPE_STR),
+ECORE_GETOPT_STORE_STR('o', "output", "The location of the images.
Defaults to `./`."),
ECORE_GETOPT_STORE_STR('w', "wrap", "Use a custom command to launch the
tests (e.g valgrind)."),
-ECORE_GETOPT_STORE_USHORT('j', "jobs", "The number of jobs to run in
parallel."),
-ECORE_GETOPT_STORE_TRUE('p', "play", "Run in play mode."),
-ECORE_GETOPT_STORE_TRUE('i', "init", "Run in init mode."),
-ECORE_GETOPT_STORE_TRUE('s', "simulation", "Run in simulation mode."),
-ECORE_GETOPT_STORE_TRUE(0, "scan-objects", "Extract information of all the
objects at every shot."),
-ECORE_GETOPT_STORE_TRUE(0, "disable-screenshots", "Disable screenshots."),
+ECORE_GETOPT_STORE_USHORT('j', "jobs", "The number of jobs to run in
parallel. Defaults to 1."),
+ECORE_GETOPT_STORE_TRUE('p', "play", "Run in play mode. Actions are
executed and obtained "
+ "screenshots are compared to the stored version (golden templates)."),
+ECORE_GETOPT_STORE_TRUE('i', "init", "Run in init
[EGIT] [core/efl] master 01/02: doxygen docs: Add missing docs for core Eina types
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=0fa18c086632ec2a37c94fa6529a00d9be3202cb commit 0fa18c086632ec2a37c94fa6529a00d9be3202cb Author: Xavi Artigas Date: Fri Mar 27 11:40:57 2020 +0100 doxygen docs: Add missing docs for core Eina types Things like EINA_LIKELY or EAPI were undocumented... --- src/lib/eina/Eina.h | 2 +- src/lib/eina/eina_types.h | 47 ++- 2 files changed, 39 insertions(+), 10 deletions(-) diff --git a/src/lib/eina/Eina.h b/src/lib/eina/Eina.h index 5169c99f03..d7b4c1911a 100644 --- a/src/lib/eina/Eina.h +++ b/src/lib/eina/Eina.h @@ -138,7 +138,7 @@ * * * @defgroup Eina_Core_Group Core - * @brief Initialization and shut down and types Etc. + * @brief Initialization, shut down and core types. * @ingroup Eina * * @defgroup Eina_Data_Types_Group Data Types diff --git a/src/lib/eina/eina_types.h b/src/lib/eina/eina_types.h index 06ce47ecdc..1f0a1053a1 100644 --- a/src/lib/eina/eina_types.h +++ b/src/lib/eina/eina_types.h @@ -63,11 +63,21 @@ * @brief Used to export functions (by changing visibility). */ # define EAPI +/** + * @def EAPI_WEAK + * @brief Weak symbol, primarily useful in defining library functions which + * can be overridden in user code. + * Note: Not supported on all platforms. + */ # define EAPI_WEAK # endif #endif -/* Weak symbols part of EFL API - Note: not weak on all platforms */ +/** + * @def EWAPI + * @brief Weak symbols part of the EFL API. + * Note: Not supported on all platforms. + */ #define EWAPI EAPI EAPI_WEAK #ifdef _WIN32 @@ -85,8 +95,8 @@ # endif # else /** - * @def EAPI - * @brief Used to export functions (by changing visibility). + * @def EXPORTAPI + * @brief An alias for #EAPI. */ # define EXPORTAPI # endif @@ -98,6 +108,11 @@ # if defined(__OPENBSD__) && (INTPTR_MAX == INT32_MAX) # define __WORDSIZE 32 # else +/** + * @def __WORDSIZE + * @brief Architecture's word size (32 or 64 bits). Defined by Eina if + * its definition cannot be found in the system's headers. + */ # define __WORDSIZE 64 # endif #endif @@ -318,7 +333,8 @@ /** * @def EINA_UNUSED - * Used to warn when an argument of the function is not used. + * Used to indicate that a function parameter is purposely unused. + * This silences some compiler's warning about unused parameters. */ # define EINA_UNUSED @@ -363,21 +379,30 @@ /** * @def EINA_PRINTF - * @param[in] fmt The format to be used. - * @param[in] arg The argument to be used. + * @brief Indicates that this function accepts a printf-style format string. + * This allows some compilers to perform additional checks on the parameters + * passed to the function. + * @param[in] fmt The 1-based index of the parameter specifying the format string. + * @param[in] arg The 1-based index of the first data parameter. */ # define EINA_PRINTF(fmt, arg) /** * @def EINA_SCANF - * @param[in] fmt The format to be used. - * @param[in] arg The argument to be used. + * @brief Indicates that this function accepts a scanf-style format string. + * This allows some compilers to perform additional checks on the parameters + * passed to the function. + * @param[in] fmt The 1-based index of the parameter specifying the format string. + * @param[in] arg The 1-based index of the first data parameter. */ # define EINA_SCANF(fmt, arg) /** * @def EINA_FORMAT - * @param[in] fmt The format to be used. + * @brief Indicates that the output of this function can be used as a format string + * in printf-style functions. Some compilers will check that the return value of + * this function is consistent with the @p fmt parameter. + * @param[in] fmt The 1-based index of the parameter specifying the format string. */ # define EINA_FORMAT(fmt) @@ -395,12 +420,16 @@ /** * @def EINA_UNLIKELY + * @brief Indicates that the expression is likely to be @c FALSE. Some compilers and + * processor architectures can then optimize the more likely path. * @param[in] exp The expression to be used. */ # define EINA_UNLIKELY(exp) exp /** * @def EINA_LIKELY + * @brief Indicates that the expression is likely to be @c TRUE. Some compilers and + * processor architectures can then optimize the more likely path. * @param[in] exp The expression to be used. */ # define EINA_LIKELY(exp) exp --
[EGIT] [core/efl] master 02/02: Eina: Remove eina_prime_table
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=80acb338984e4fa20de8833ddd4184fea520bfaa
commit 80acb338984e4fa20de8833ddd4184fea520bfaa
Author: Xavi Artigas
Date: Fri Mar 27 11:46:24 2020 +0100
Eina: Remove eina_prime_table
This has been present since ancient times and no current uses have been
detected.
It's an array containing SOME prime numbers without a terminator, so the
caller
needs to know the array length in advance.
This does not look very useful (or usable) and therefore it has been
decided in
public IRC session to send this thing to hell.
Witnesses: raster stefan_schmidt bu5hm4n
---
src/lib/eina/eina_types.h | 2 --
src/lib/eina/eina_value.c | 7 ---
2 files changed, 9 deletions(-)
diff --git a/src/lib/eina/eina_types.h b/src/lib/eina/eina_types.h
index 1f0a1053a1..b93e99f483 100644
--- a/src/lib/eina/eina_types.h
+++ b/src/lib/eina/eina_types.h
@@ -538,8 +538,6 @@ typedef unsigned char Eina_Bool;
*/
#define EINA_TRUE ((Eina_Bool)1)
-EAPI extern const unsigned int eina_prime_table[];
-
/**
* @typedef Eina_Compare_Cb
* Function used in functions using sorting. It compares @p data1 and
diff --git a/src/lib/eina/eina_value.c b/src/lib/eina/eina_value.c
index 0596b70e9f..c18f369006 100644
--- a/src/lib/eina/eina_value.c
+++ b/src/lib/eina/eina_value.c
@@ -5620,13 +5620,6 @@ EAPI const Eina_Value_Blob_Operations
*EINA_VALUE_BLOB_OPERATIONS_MALLOC = NULL;
EAPI const Eina_Value_Struct_Operations
*EINA_VALUE_STRUCT_OPERATIONS_BINSEARCH = NULL;
EAPI const Eina_Value_Struct_Operations
*EINA_VALUE_STRUCT_OPERATIONS_STRINGSHARE = NULL;
-EAPI const unsigned int eina_prime_table[] =
-{
- 17, 31, 61, 127, 257, 509, 1021,
- 2053, 4093, 8191, 16381, 32771, 65537, 131071, 262147, 524287, 1048573,
- 2097143, 4194301, 8388617, 16777213
-};
-
EAPI Eina_Value *
eina_value_new(const Eina_Value_Type *type)
{
--
[EGIT] [core/efl] master 03/03: doxygen docs: Fix warnings in elm_config.h
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=19c57d38dbfb24058a4c7f5e044c86c2af301df6 commit 19c57d38dbfb24058a4c7f5e044c86c2af301df6 Author: Xavi Artigas Date: Thu Mar 26 14:26:48 2020 +0100 doxygen docs: Fix warnings in elm_config.h --- src/lib/elementary/elementary_config.h | 4 src/lib/elementary/elm_config.h| 16 +++- 2 files changed, 11 insertions(+), 9 deletions(-) diff --git a/src/lib/elementary/elementary_config.h b/src/lib/elementary/elementary_config.h index 6074510b0d..16127cc934 100644 --- a/src/lib/elementary/elementary_config.h +++ b/src/lib/elementary/elementary_config.h @@ -7,6 +7,10 @@ * @brief Definition of special values for user configuration. */ +/** + * @def ELM_CONFIG_ICON_THEME_ELEMENTARY + * Name to use in elm_config_icon_theme_set() to use Elementary's own icon set. + */ #define ELM_CONFIG_ICON_THEME_ELEMENTARY "_Elementary_Icon_Theme" #if defined(EFL_BUILD) || defined(ELM_INTERNAL_API_ARGESFSDFEFC) diff --git a/src/lib/elementary/elm_config.h b/src/lib/elementary/elm_config.h index f42fee4a87..b4708221a0 100644 --- a/src/lib/elementary/elm_config.h +++ b/src/lib/elementary/elm_config.h @@ -3,7 +3,7 @@ * @ingroup Elementary * * Elementary configuration is formed by a set options bounded to a - * given @ref Profile profile, like @ref Theme theme, @ref Fingers + * given @ref Elm_Profile, like @ref Elm_Theme, @ref Elm_Fingers * "finger size", etc. These are functions with which one synchronizes * changes made to those values to the configuration storing files, de * facto. You most probably don't want to use the functions in this @@ -596,7 +596,7 @@ EAPI Eina_Bool elm_config_scroll_animation_disabled_get(void); * This option disables timed animations during scrolling and forces scroll actions * to be performed immediately. * - * @param disable The state of this option + * @param enable The state of this option * * @see elm_config_scroll_animation_disabled_get() * @@ -763,7 +763,7 @@ EAPI double elm_config_scroll_thumbscroll_momentum_animation_duration_min_ /** * Set the min limit for the momentum animation duration(unit:second) * - * @param the thumb scroll momentum animation duration min limit + * @param min the thumb scroll momentum animation duration min limit * * @see elm_config_scroll_thumbscroll_acceleration_weight_set() * @ingroup Elm_Scrolling @@ -782,7 +782,7 @@ EAPI double elm_config_scroll_thumbscroll_momentum_animation_duration_max_ /** * Set the max limit for the momentum animation duration(unit:second) * - * @param the thumb scroll momentum animation duration max limit + * @param max the thumb scroll momentum animation duration max limit * * @see elm_config_scroll_thumbscroll_momentum_animation_duration_max_limit_get() * @ingroup Elm_Scrolling @@ -931,7 +931,6 @@ EAPI void elm_config_focus_autoscroll_mode_set(Elm_Focus_Autoscroll_Mode /** * Sets the slider's indicator visible mode. * - * @param obj The slider object. * @param mode Elm_Slider_Indicator_Visible_Mode. * viewport. * @@ -943,7 +942,6 @@ EAPI void elm_config_slider_indicator_visible_mode_set(Elm_Slider_Indicator_Visi /** * Get the slider's indicator visible mode. * - * @param obj The slider object. * @return @c ELM_SLIDER_INDICATOR_VISIBLE_MODE_DEFAULT if not set anything by the user. * @c ELM_SLIDER_INDICATOR_VISIBLE_MODE_ALWAYS, ELM_SLIDER_INDICATOR_VISIBLE_MODE_ON_FOCUS, *ELM_SLIDER_INDICATOR_VISIBLE_MODE_NONE if any of the above is set by user. @@ -1097,7 +1095,7 @@ EAPI void elm_config_scale_set(double scale); * Get the icon theme the user has set. * * This gets the global icon theme currently set or the default value - * ELM_CONFIG_ICON_THEME_ELEMENTARY. + * #ELM_CONFIG_ICON_THEME_ELEMENTARY. * * @return the icon theme to use * @ingroup Elm_Icon @@ -1110,9 +1108,9 @@ EAPI const char *elm_config_icon_theme_get(void); * * This method will set the icon theme for all elm_icon_standard_set calls. * Valid parameters are the name of an installed freedesktop.org icon theme - * or ELM_CONFIG_ICON_THEME_ELEMENTARY for the built in theme. + * or #ELM_CONFIG_ICON_THEME_ELEMENTARY for the built in theme. * - * @param the name of a freedesktop.org icon theme or ELM_CONFIG_ICON_THEME_ELEMENTARY + * @param theme the name of a freedesktop.org icon theme or #ELM_CONFIG_ICON_THEME_ELEMENTARY * @ingroup Elm_Icon * @since 1.18 */ --
[EGIT] [core/efl] master 02/03: doxygen docs: Fix warnings in Ecore_Common.h
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=420439617632c41581e20aa1afa60020dbb7f082
commit 420439617632c41581e20aa1afa60020dbb7f082
Author: Xavi Artigas
Date: Thu Mar 26 13:46:46 2020 +0100
doxygen docs: Fix warnings in Ecore_Common.h
---
src/lib/ecore/Ecore_Common.h | 10 +++---
src/lib/ecore/Ecore_Legacy.h | 4
src/lib/ecore/ecore_exe_eo.h | 4
3 files changed, 11 insertions(+), 7 deletions(-)
diff --git a/src/lib/ecore/Ecore_Common.h b/src/lib/ecore/Ecore_Common.h
index 1455644fb5..4ee0dd768b 100644
--- a/src/lib/ecore/Ecore_Common.h
+++ b/src/lib/ecore/Ecore_Common.h
@@ -2732,16 +2732,12 @@ EAPI double ecore_throttle_get(void);
* @{
*/
-/**
- * @enum _Ecore_Animator_Source
- * Defines the timing sources for animators.
- */
-enum _Ecore_Animator_Source/* Timing sources for animators */
+/** Defines the timing sources for animators. */
+typedef enum
{
ECORE_ANIMATOR_SOURCE_TIMER, /**< The default system clock/timer based
animator that ticks every "frametime" seconds */
ECORE_ANIMATOR_SOURCE_CUSTOM /**< A custom animator trigger that you need
to call ecore_animator_custom_tick() to make it tick */
-};
-typedef enum _Ecore_Animator_Source Ecore_Animator_Source;
+} Ecore_Animator_Source;
/**
* @typedef Ecore_Timeline_Cb Ecore_Timeline_Cb
diff --git a/src/lib/ecore/Ecore_Legacy.h b/src/lib/ecore/Ecore_Legacy.h
index 9c951f5a93..d39ecb66f1 100644
--- a/src/lib/ecore/Ecore_Legacy.h
+++ b/src/lib/ecore/Ecore_Legacy.h
@@ -100,6 +100,10 @@ EAPI int ecore_poller_poller_interval_get(const
Ecore_Poller *obj);
* @{
*/
+/**
+ * @struct Ecore_Animator
+ * Opaque handle to manage Ecore Animator objects.
+ */
typedef struct _Ecore_Animator Ecore_Animator;
/**
diff --git a/src/lib/ecore/ecore_exe_eo.h b/src/lib/ecore/ecore_exe_eo.h
index fa8ecb026a..70b2c12ee0 100644
--- a/src/lib/ecore/ecore_exe_eo.h
+++ b/src/lib/ecore/ecore_exe_eo.h
@@ -4,6 +4,10 @@
#ifndef _ECORE_EXE_EO_CLASS_TYPE
#define _ECORE_EXE_EO_CLASS_TYPE
+/**
+ * @struct Ecore_Exe
+ * Opaque handle to manage Ecore Exe objects.
+ */
typedef Eo Ecore_Exe;
#endif
--
[EGIT] [core/efl] master 01/03: doxygen docs: Fix several warnings in Eina files
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=50f83d5d3ae71bfc0350c472fcdf9bc794bda8ee commit 50f83d5d3ae71bfc0350c472fcdf9bc794bda8ee Author: Xavi Artigas Date: Tue Mar 24 16:49:04 2020 +0100 doxygen docs: Fix several warnings in Eina files --- src/lib/eina/eina_accessor.h | 4 ++-- src/lib/eina/eina_debug.h | 4 ++-- src/lib/eina/eina_error.h | 2 +- src/lib/eina/eina_hash.h | 2 +- src/lib/eina/eina_iterator.h | 8 src/lib/eina/eina_list.h | 4 ++-- src/lib/eina/eina_lock.h | 4 ++-- src/lib/eina/eina_matrix.h| 10 +- src/lib/eina/eina_rectangle.h | 2 +- src/lib/eina/eina_slice.h | 2 +- src/lib/eina/eina_value.h | 10 +- 11 files changed, 26 insertions(+), 26 deletions(-) diff --git a/src/lib/eina/eina_accessor.h b/src/lib/eina/eina_accessor.h index ccfccceba3..5e61dc7810 100644 --- a/src/lib/eina/eina_accessor.h +++ b/src/lib/eina/eina_accessor.h @@ -388,7 +388,7 @@ EAPI Eina_Accessor* eina_carray_length_ptr_accessor_new(void** array, unsigned i * @def EINA_C_ARRAY_ACCESSOR_NEW * @brief Creates an Eina_Accessor that wraps a plain fixed size C array * - * @param[in] array The array + * @param[in] Array The array * @return The accessor that will give access to the passed array * * You can create it like this: @@ -403,7 +403,7 @@ EAPI Eina_Accessor* eina_carray_length_ptr_accessor_new(void** array, unsigned i * @def EINA_C_ARRAY_ACCESSOR_NEW * @brief Creates an Eina_Accessor that wraps a plain fixed size C array * - * @param[in] array The array + * @param[in] Array The array * @return The accessor that will give access to the passed array * * You can create it like this: diff --git a/src/lib/eina/eina_debug.h b/src/lib/eina/eina_debug.h index 0bc6e5f406..dbc36caf5d 100644 --- a/src/lib/eina/eina_debug.h +++ b/src/lib/eina/eina_debug.h @@ -108,7 +108,7 @@ typedef Eina_Bool (*Eina_Debug_Timer_Cb)(void *); typedef struct _Eina_Debug_Timer Eina_Debug_Timer; /** - * @typedef Eina_Debug_Packet_Header + * @struct Eina_Debug_Packet_Header * * Header of Eina Debug packet */ @@ -143,7 +143,7 @@ typedef struct } /** - * @typedef Eina_Debug_Opcode + * @struct Eina_Debug_Opcode * * Structure to describe information for an opcode. It is used to register new * opcodes. diff --git a/src/lib/eina/eina_error.h b/src/lib/eina/eina_error.h index e2dfd122ae..313548bb66 100644 --- a/src/lib/eina/eina_error.h +++ b/src/lib/eina/eina_error.h @@ -107,7 +107,7 @@ typedef Eina_Bool Eina_Success_Flag; #define EINA_ERROR_NO_ERROR ((Eina_Error)0) /** - * @var EINA_ERROR_OUT_OF_MEMORY + * @var Eina_Error EINA_ERROR_OUT_OF_MEMORY * @brief The error identifier corresponding to lack of memory. * * @deprecated since 1.19, same as @c ENOMEM from @c errno.h diff --git a/src/lib/eina/eina_hash.h b/src/lib/eina/eina_hash.h index e7a122994d..6661b9f42e 100644 --- a/src/lib/eina/eina_hash.h +++ b/src/lib/eina/eina_hash.h @@ -320,7 +320,7 @@ typedef unsigned int (*Eina_Key_Length)(const void *key); typedef int (*Eina_Key_Cmp)(const void *key1, int key1_length, const void *key2, int key2_length); /** * @def EINA_KEY_CMP - * @param[in]Function The function used to compare hash key. + * @param[in] Function The function used to compare hash key. */ #define EINA_KEY_CMP(Function)((Eina_Key_Cmp)Function) diff --git a/src/lib/eina/eina_iterator.h b/src/lib/eina/eina_iterator.h index 4f05bda5b9..092a89cfa2 100644 --- a/src/lib/eina/eina_iterator.h +++ b/src/lib/eina/eina_iterator.h @@ -322,7 +322,7 @@ EAPI Eina_Iterator *eina_carray_length_iterator_new(void** array, unsigned int s * @brief Creates an Eina_Iterator that iterates through a * NUL-terminated C array. * - * @param[in] array The NUL-terminated array + * @param[in] Array The NUL-terminated array * @return The iterator that will walk over the array. * * You can create it like this: @@ -370,10 +370,10 @@ EAPI Eina_Iterator *eina_multi_iterator_internal_new(Eina_Iterator *it, ...) EIN * @brief Calls the process method on each node of iterator, producing new "processed" * nodes and returning a new iterator which contains them. * - * @param[in] original Iterator containing the nodes to process. + * @param[in] iterator Iterator containing the nodes to process. * @param[in] process Method to call on each node. * @param[in] free_cb Method called when all nodes have been processed. It receives "data" as a parameter. - * @param[in] data Additional data passed to the process method. + * @param[in] fdata Additional data passed to the process method. * * Processes every node in the input iterator and returns a new iterator containing * the processed nodes. This is akin to a Map function: @@ -388,7 +388,7 @@ EAPI Eina_Iterator* eina_iterator_processed_new(Eina_Iterator *iterator, Eina_Pr * @brief Creates an Eina_Iterator that itera
[EGIT] [core/efl] master 03/03: doxygen docs: Fix warnings in Ecore_Wl2.h and associates
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=bb519386fd89aa0ab6930c4de26826c0764bfce9 commit bb519386fd89aa0ab6930c4de26826c0764bfce9 Author: Xavi Artigas Date: Tue Mar 24 13:42:08 2020 +0100 doxygen docs: Fix warnings in Ecore_Wl2.h and associates --- src/lib/ecore_wl2/Ecore_Wl2.h | 15 +++ src/lib/ecore_wl2/ecore_wl2_internal.h | 10 +- 2 files changed, 12 insertions(+), 13 deletions(-) diff --git a/src/lib/ecore_wl2/Ecore_Wl2.h b/src/lib/ecore_wl2/Ecore_Wl2.h index 85bfd134e8..4bee824e66 100644 --- a/src/lib/ecore_wl2/Ecore_Wl2.h +++ b/src/lib/ecore_wl2/Ecore_Wl2.h @@ -890,7 +890,7 @@ EAPI void ecore_wl2_window_alpha_set(Ecore_Wl2_Window *window, Eina_Bool alpha); /** * Set the opaque region of the Ecore_Wl2_Window * - * @param win The window + * @param window The window * @param x The left point of the region. * @param y The top point of the region. * @param w The width of the region. @@ -904,7 +904,7 @@ EAPI void ecore_wl2_window_opaque_region_set(Ecore_Wl2_Window *window, int x, in /** * Get the opaque region of the Ecore_Wl2_Window * - * @param win The window + * @param window The window * @param x The left point of the region. * @param y The top point of the region. * @param w The width of the region. @@ -986,7 +986,7 @@ EAPI Eina_Bool ecore_wl2_window_fullscreen_get(Ecore_Wl2_Window *window); * Set the fullscreen state of a given window * * @param window The window to set the fullscreen state of - * @param maximized EINA_TRUE to set fullscreen, EINA_FALSE to unset + * @param fullscreen EINA_TRUE to set fullscreen, EINA_FALSE to unset * * @ingroup Ecore_Wl2_Window_Group * @since 1.17 @@ -1268,7 +1268,7 @@ EAPI Ecore_Wl2_Input *ecore_wl2_window_popup_input_get(Ecore_Wl2_Window *window) /** * Check if a window has a shell surface - without one it can't be visible. * - * @param The window to check + * @param win The window to check * * @return Returns true if the window has an associated shell surface. * @@ -1515,7 +1515,7 @@ EAPI void ecore_wl2_input_cursor_from_name_set(Ecore_Wl2_Input *input, const cha /** * Gets default input of a given display * - * @param display The display + * @param ewd The display * * @ingroup Ecore_Wl2_Input_Group * @since 1.24 @@ -1608,10 +1608,9 @@ EAPI void ecore_wl2_window_commit(Ecore_Wl2_Window *window, Eina_Bool flush); EAPI Ecore_Wl2_Frame_Cb_Handle *ecore_wl2_window_frame_callback_add(Ecore_Wl2_Window *window, Ecore_Wl2_Frame_Cb cb, void *data); /** - * delete a callback that fires when the window's surface_frame callback fires + * Delete a callback that fires when the window's surface_frame callback fires * - * @param window The window to add a callback on - * @param cb The callback handle + * @param handle The callback handle obtained through ecore_wl2_window_frame_callback_add(). * * @since 1.21 */ diff --git a/src/lib/ecore_wl2/ecore_wl2_internal.h b/src/lib/ecore_wl2/ecore_wl2_internal.h index 98dd5c1b5a..eb292ea67d 100644 --- a/src/lib/ecore_wl2/ecore_wl2_internal.h +++ b/src/lib/ecore_wl2/ecore_wl2_internal.h @@ -103,7 +103,7 @@ EAPI void ecore_wl2_window_buffer_transform_set(Ecore_Wl2_Window *window, int tr /** * Iconify a window * - * @param win The window to iconifiy + * @param window The window to iconifiy * @param iconified The new iconified state to set * * @ingroup Ecore_Wl2_Window_Group @@ -366,9 +366,9 @@ EAPI void ecore_wl2_offer_finish(Ecore_Wl2_Offer *offer); * Create and return 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 window. * - * The @param win must be visible, otherwise there will be no surface created + * @param window The window. It must be visible, otherwise there will be no surface created * for it yet. * * @return the allocated and initialized Ecore_Wl2_Subsurface object, or @@ -431,8 +431,8 @@ EAPI void ecore_wl2_subsurface_position_get(Ecore_Wl2_Subsurface *subsurface, in /** * Place subsurface on layer above a reference surface * - * Moves the @param subsurface to just above the reference @param - * surface, changing the z-order. The reference @param surface must + * Moves the subsurface to just above the reference surface, + * changing the z-order. The reference surface must * be either a sibling or parent surface, else a protocol error will * be generated. * --
[EGIT] [core/efl] master 01/03: doxygen docs: Fix warnings in Edje_Edit.h
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=c48d4d431f3b6274eaa805ac7ab4c9e6e9501450 commit c48d4d431f3b6274eaa805ac7ab4c9e6e9501450 Author: Xavi Artigas Date: Tue Mar 24 11:58:38 2020 +0100 doxygen docs: Fix warnings in Edje_Edit.h And since we're at it, fix some typos too. --- src/lib/edje/Edje_Edit.h | 122 --- 1 file changed, 53 insertions(+), 69 deletions(-) diff --git a/src/lib/edje/Edje_Edit.h b/src/lib/edje/Edje_Edit.h index b08a85246d..4de878fe43 100644 --- a/src/lib/edje/Edje_Edit.h +++ b/src/lib/edje/Edje_Edit.h @@ -1165,7 +1165,7 @@ EAPI Eina_Bool edje_edit_color_class_name_set(Evas_Object *obj, const char *name * @brief Gets the description of a color class. * * @param obj Object being edited. - * @param name Color class to get the description of. + * @param class_name Color class to get the description of. * * @return The description of the color class or @c NULL if not found * @since 1.14 @@ -1176,7 +1176,7 @@ EAPI Eina_Stringshare *edje_edit_color_class_description_get(Evas_Object *obj, c * @brief Changes the description of a color class. * * @param obj Object being edited. - * @param name Color class to edit. + * @param class_name Color class to edit. * @param desc New description for the color class * * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise. @@ -1904,7 +1904,7 @@ EAPI Eina_Bool edje_edit_part_anti_alias_get(Evas_Object *obj, const char *part) * * @param obj Object being edited. * @param part The part to set if the anti-aliasing is accepted. - * @param mouse_events @c EINA_TRUE if part should to draw anti-aliased, @c EINA_FALSE otherwise. + * @param anti_alias @c EINA_TRUE if part should be drawn anti-aliased, @c EINA_FALSE otherwise. * * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise. */ @@ -2074,7 +2074,7 @@ EAPI Eina_Bool edje_edit_part_mask_flags_set(Evas_Object *obj, const char *part, * @param obj Object being edited. * @param part Part name to get it's pointer_mode. * - * @return Ponter Mode of the part. + * @return Pointer Mode of the part. * @since 1.11 */ EAPI Evas_Object_Pointer_Mode edje_edit_part_pointer_mode_get(Evas_Object *obj, const char *part); @@ -2082,7 +2082,7 @@ EAPI Evas_Object_Pointer_Mode edje_edit_part_pointer_mode_get(Evas_Object *obj, /** * @brief Gets pointer_mode of a part. * - * Note that Ponter Mode can be: + * Note that Pointer Mode can be: * - EVAS_OBJECT_POINTER_MODE_AUTOGRAB - default, X11-like * - EVAS_OBJECT_POINTER_MODE_NOGRAB - pointer always bound to the object right below it * - EVAS_OBJECT_POINTER_MODE_NOGRAB_NO_REPEAT_UPDOWN - useful on object with "repeat events" enabled, @since 1.2 @@ -2108,7 +2108,7 @@ EAPI Eina_Bool edje_edit_part_pointer_mode_set(Evas_Object *obj, const char *par * @param obj Object being edited. * @param part Part name to get it's cursor_mode. * - * @return Ponter Mode of the part. + * @return Pointer Mode of the part. * @since 1.11 */ EAPI unsigned char edje_edit_part_cursor_mode_get(Evas_Object *obj, const char *part); @@ -2156,7 +2156,7 @@ EAPI Eina_Bool edje_edit_part_scale_set(Evas_Object *obj, const char *part, Eina EAPI Eina_Bool edje_edit_part_scale_get(Evas_Object *obj, const char *part); /** - * @brief Gets horizontal dragable state for part. + * @brief Gets horizontal draggable state for part. * * @param obj Object being edited. * @param part Part to get if can be dragged horizontally. @@ -2166,7 +2166,7 @@ EAPI Eina_Bool edje_edit_part_scale_get(Evas_Object *obj, const char *part); EAPI int edje_edit_part_drag_x_get(Evas_Object *obj, const char *part); /** - * @brief Sets horizontal dragable state for part. + * @brief Sets horizontal draggable state for part. * * @param obj Object being edited. * @param part Part to set if should be dragged horizontally. @@ -2177,7 +2177,7 @@ EAPI int edje_edit_part_drag_x_get(Evas_Object *obj, const char *part); EAPI Eina_Bool edje_edit_part_drag_x_set(Evas_Object *obj, const char *part, int drag); /** - * @brief Gets vertical dragable state for part. + * @brief Gets vertical draggable state for part. * * @param obj Object being edited. * @param part Part to get if can be dragged vertically. @@ -2187,7 +2187,7 @@ EAPI Eina_Bool edje_edit_part_drag_x_set(Evas_Object *obj, const char *part, int EAPI int edje_edit_part_drag_y_get(Evas_Object *obj, const char *part); /** - * @brief Sets vertical dragable state for part. + * @brief Sets vertical draggable state for part. * * @param obj Object being edited. * @param part Part to set if should be dragged vertically. @@ -2198,7 +2198,7 @@ EAPI int edje_edit_part_drag_y_get(Evas_Object *obj, const char *part); EAPI Eina_Bool edje_edit_part_drag_y_set(Evas_Object *obj, const char *part, int drag); /** - * @brief Gets horizontal dra
[EGIT] [core/efl] master 02/03: doxygen docs: Fix warnings in Ecore_Evas.h
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=065d429a67258c9b0f2c7dc1ffa36278a74a0981 commit 065d429a67258c9b0f2c7dc1ffa36278a74a0981 Author: Xavi Artigas Date: Tue Mar 24 13:00:35 2020 +0100 doxygen docs: Fix warnings in Ecore_Evas.h And a couple associated places. --- src/examples/ecore/ecore_evas_extn_socket_example.c | 2 +- src/lib/ecore/Ecore.h | 11 ++- src/lib/ecore_evas/Ecore_Evas.h | 14 +- 3 files changed, 12 insertions(+), 15 deletions(-) diff --git a/src/examples/ecore/ecore_evas_extn_socket_example.c b/src/examples/ecore/ecore_evas_extn_socket_example.c index aff4975b88..21255485d0 100644 --- a/src/examples/ecore/ecore_evas_extn_socket_example.c +++ b/src/examples/ecore/ecore_evas_extn_socket_example.c @@ -20,7 +20,7 @@ #include #include -// procotol version - change this as needed +// protocol version - change this as needed #define MSG_DOMAIN_CONTROL_OBJECT 0x1004 #define MSG_ID_BG_COLOR 0x1005 #define MSG_ID_TEXT 0x1006 diff --git a/src/lib/ecore/Ecore.h b/src/lib/ecore/Ecore.h index cd401617fa..294fe0e5a2 100644 --- a/src/lib/ecore/Ecore.h +++ b/src/lib/ecore/Ecore.h @@ -45,15 +45,16 @@ * this is very simple. You simply have to compile your application * with the appropriate compiler flags that the @p pkg-config script * outputs. Note that each module is separate in pkg-config. For - * example using @ref Ecore_Evas_Group: + * example using @c Ecore_Evas: + * * Compiling C or C++ files into object files: - * @verbatim + * @code * gcc -c -o main.o main.c `pkg-config --cflags ecore ecore-evas` - * @endverbatim + * @endcode * Linking object files into a binary executable: - * @verbatim + * @code * gcc -o my_application main.o `pkg-config --libs ecore ecore-evas` - * @endverbatim + * @endcode * See @ref pkgconfig * * @section ecore_main_next_steps Next Steps diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h index d484bb1b95..f53586a866 100644 --- a/src/lib/ecore_evas/Ecore_Evas.h +++ b/src/lib/ecore_evas/Ecore_Evas.h @@ -1003,8 +1003,8 @@ EAPI int ecore_evas_aux_hint_id_get(const Ecore_Evas *ee, const cha * @see eecore_evas_callback_msg_handle_set() * * This is a list of examples of these functions: - * @li @ref ecore_evas_extn_socket_example - * @li @ref ecore_evas_extn_plug_example + * @li ecore_evas_extn_socket_example + * @li ecore_evas_extn_plug_example */ EAPI void ecore_evas_msg_parent_send(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size); @@ -1637,7 +1637,7 @@ EAPI Ecore_Cocoa_Window *ecore_evas_cocoa_window_get(const Ecore_Evas *ee); /** * @brief Create an Ecore_Evas window using the drm engine. * - * @param disp_name Name of the Wayland display to connect to. + * @param device Name of the Wayland display to connect to. * @param parent (Unused) * @param x Horizontal position of the Ecore_Evas window. * @param y Vertical position of the Ecore_Evas window. @@ -1657,7 +1657,7 @@ EAPI Ecore_Evas *ecore_evas_drm_new(const char *device, unsigned int parent, /** * @brief Create an Ecore_Evas window using the drm engine with GL support. * - * @param disp_name Name of the Wayland display to connect to. + * @param device Name of the Wayland display to connect to. * @param parent (Unused) * @param x Horizontal position of the Ecore_Evas window. * @param y Vertical position of the Ecore_Evas window. @@ -2033,10 +2033,7 @@ EAPI Ecore_Evas *ecore_evas_cocoa_new(Ecore_Cocoa_Window *parent, * @brief Creates a new @c Ecore_Evas canvas bound to the Evas * @b psl1ght engine. * - * @param parent ID of the parent window this Ecore_Evas window belongs - *to, or 0 if this is a top-level window. - * @param x Horizontal position of window, in pixels - * @param y Vertical position of window, in pixels + * @param name Deprecated. * @param w Width of the canvas, in pixels. * @param h Height of the canvas, in pixels. * @@ -3203,7 +3200,6 @@ EAPI Evas_Object *ecore_evas_vnc_start(Ecore_Evas *ee, const char *addr, int por /** * @brief Sets a callback for building new Evas. * - * @param ee The Ecore_Evas to set callbacks on * @param func The function to call * * A call to this function will set a callback on an Ecore_Evas, causing --
[EGIT] [core/efl] master 02/02: doxygen docs: Fix warnings in textblock
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=a1c7384da9dede4a63616fe9ba1824bea0a2da6d commit a1c7384da9dede4a63616fe9ba1824bea0a2da6d Author: Xavi Artigas Date: Mon Mar 23 12:14:07 2020 +0100 doxygen docs: Fix warnings in textblock --- src/lib/evas/canvas/evas_object_textblock.c | 20 ++-- src/lib/evas/canvas/evas_textblock_legacy.h | 6 +- 2 files changed, 11 insertions(+), 15 deletions(-) diff --git a/src/lib/evas/canvas/evas_object_textblock.c b/src/lib/evas/canvas/evas_object_textblock.c index b52f97cf01..efd2833b67 100644 --- a/src/lib/evas/canvas/evas_object_textblock.c +++ b/src/lib/evas/canvas/evas_object_textblock.c @@ -2630,9 +2630,9 @@ _format_command(Evas_Object *eo_obj, Evas_Object_Textblock_Format *fmt, const ch * @li "right" - Puts the text at the right of the line * @li "start" - Respects LTR/RTL settings. It is same with "auto" * @li "end" - Puts the text at the opposite side of LTR/RTL settings - * @li - A number between 0.0 and 1.0 where 0.0 represents + * @li \ - A number between 0.0 and 1.0 where 0.0 represents * "left" and 1.0 represents "right" - * @li % - A percentage between 0% and 100% where 0% + * @li \% - A percentage between 0% and 100% where 0% * represents "left" and 100% represents "right" * @code * align= @@ -2707,9 +2707,9 @@ _format_command(Evas_Object *eo_obj, Evas_Object_Textblock_Format *fmt, const ch * @li "bottom" - Puts the text at the bottom of the line * @li "baseline" - Baseline * @li "base" - Alias for "baseline" - * @li - A number between 0.0 and 1.0 where 0.0 represents + * @li \ - A number between 0.0 and 1.0 where 0.0 represents * "top" and 1.0 represents "bottom" - * @li % - A percentage between 0% and 100% where 0% + * @li \% - A percentage between 0% and 100% where 0% * represents "top" and 100% represents "bottom" * @code * valign= @@ -2832,9 +2832,9 @@ _format_command(Evas_Object *eo_obj, Evas_Object_Textblock_Format *fmt, const ch * * Sets the left margin of the text. The value can be a number, an * increment, decrement or "reset": - * @li + - Increments existing left margin by - * @li - - Decrements existing left margin by - * @li - Sets left margin to + * @li +\ - Increments existing left margin by \ + * @li -\ - Decrements existing left margin by \ + * @li \ - Sets left margin to \ * @li "reset" - Sets left margin to 0 * @code * left_margin= @@ -2862,9 +2862,9 @@ _format_command(Evas_Object *eo_obj, Evas_Object_Textblock_Format *fmt, const ch * * Sets the right margin of the text. The value can be a number, an * increment, decrement or "reset": - * @li + - Increments existing right margin by - * @li - - Decrements existing right margin by - * @li - Sets left margin to + * @li +\ - Increments existing right margin by \ + * @li -\ - Decrements existing right margin by \ + * @li \ - Sets left margin to \ * @li "reset" - Sets left margin to 0 * @code * right_margin= diff --git a/src/lib/evas/canvas/evas_textblock_legacy.h b/src/lib/evas/canvas/evas_textblock_legacy.h index b852c0d61b..d52d78e15f 100644 --- a/src/lib/evas/canvas/evas_textblock_legacy.h +++ b/src/lib/evas/canvas/evas_textblock_legacy.h @@ -562,7 +562,7 @@ EAPI Eina_List *evas_textblock_cursor_range_geomet /** * Get the simple geometry of a range. - * The simple geometry is the geomtry in which rectangles in middle + * The simple geometry is the geometry in which rectangles in middle * lines of range are merged into one big rectangle. * @since 1.13 * @@ -573,10 +573,6 @@ EAPI Eina_List *evas_textblock_cursor_range_geomet EAPI Eina_Iterator *evas_textblock_cursor_range_simple_geometry_get(const Evas_Textblock_Cursor *cur1, const Evas_Textblock_Cursor *cur2) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2); /** - * Get the geometry of ? - * - * @param cur one side of the range. - * @param cur2 other side of the range. */ EAPI Eina_Bool evas_textblock_cursor_format_item_geometry_get(const Evas_Textblock_Cursor *cur, Evas_Coord *cx, Evas_Coord *cy, Evas_Coord *cw, Evas_Coord *ch) EINA_ARG_NONNULL(1); --
[EGIT] [core/efl] master 01/02: doxygen docs: Fix Exactness warnings
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=21e78743a49b30a98dae71520b8a34377d0c162a
commit 21e78743a49b30a98dae71520b8a34377d0c162a
Author: Xavi Artigas
Date: Mon Mar 23 11:20:12 2020 +0100
doxygen docs: Fix Exactness warnings
---
src/lib/exactness/Exactness.h | 30 +++---
1 file changed, 19 insertions(+), 11 deletions(-)
diff --git a/src/lib/exactness/Exactness.h b/src/lib/exactness/Exactness.h
index 33c448cf58..ce80b984f2 100644
--- a/src/lib/exactness/Exactness.h
+++ b/src/lib/exactness/Exactness.h
@@ -41,7 +41,7 @@
*/
/**
- * @typedef Exactness_Action_Type
+ * @enum Exactness_Action_Type
* The type values for an Exactness action.
*/
typedef enum
@@ -64,7 +64,7 @@ typedef enum
} Exactness_Action_Type;
/**
- * @typedef Exactness_Action_Mouse_Wheel
+ * @struct Exactness_Action_Mouse_Wheel
* The type for the Exactness Mouse Wheel action.
*/
typedef struct
@@ -74,7 +74,7 @@ typedef struct
} Exactness_Action_Mouse_Wheel;
/**
- * @typedef Exactness_Action_Key_Down_Up
+ * @struct Exactness_Action_Key_Down_Up
* The type for the Exactness Key Down Up action.
*/
typedef struct
@@ -87,7 +87,7 @@ typedef struct
} Exactness_Action_Key_Down_Up;
/**
- * @typedef Exactness_Action_Multi_Event
+ * @struct Exactness_Action_Multi_Event
* The type for the Exactness Multi Event action.
*/
typedef struct
@@ -107,7 +107,7 @@ typedef struct
} Exactness_Action_Multi_Event;
/**
- * @typedef Exactness_Action_Multi_Move
+ * @struct Exactness_Action_Multi_Move
* The type for the Exactness Multi Move action.
*/
typedef struct
@@ -125,7 +125,7 @@ typedef struct
} Exactness_Action_Multi_Move;
/**
- * @typedef Exactness_Action_Efl_Event
+ * @struct Exactness_Action_Efl_Event
* The type for the Exactness EFL Event action.
*/
typedef struct
@@ -135,7 +135,7 @@ typedef struct
} Exactness_Action_Efl_Event;
/**
- * @typedef Exactness_Action_Click_On
+ * @struct Exactness_Action_Click_On
* The type for the Exactness Click on (widget) action.
*/
typedef struct
@@ -144,7 +144,7 @@ typedef struct
} Exactness_Action_Click_On;
/**
- * @typedef Exactness_Action
+ * @struct Exactness_Action
* The type for the Exactness action.
*/
typedef struct
@@ -156,7 +156,7 @@ typedef struct
} Exactness_Action;
/**
- * @typedef Exactness_Object
+ * @struct Exactness_Object
* The type for the Exactness object.
*/
typedef struct
@@ -175,7 +175,7 @@ typedef struct
} Exactness_Object;
/**
- * @typedef Exactness_Objects
+ * @struct Exactness_Objects
* The type for the Exactness objects list.
*/
typedef struct
@@ -186,7 +186,7 @@ typedef struct
} Exactness_Objects;
/**
- * @typedef Exactness_Image
+ * @struct Exactness_Image
* The type for the Exactness Image.
*/
typedef struct
@@ -196,6 +196,10 @@ typedef struct
void *pixels; /**< Pixels of the image */
} Exactness_Image;
+/**
+ * @struct Exactness_Source_Code
+ * Description of the source code used to generate the tested application.
+ */
typedef struct
{
char *language; /**< String describing the language of the content e.g
"C"...*/
@@ -203,6 +207,10 @@ typedef struct
char *command; /**< Command needed to generate the application from the
content */
} Exactness_Source_Code;
+/**
+ * @struct Exactness_Unit
+ * An Exactness test unit, including the list of tested actions and produced
images.
+ */
typedef struct
{
Eina_List *actions; /**< List of Exactness_Action */
--
[EGIT] [core/efl] master 01/03: doxygen docs: Put quadtrees in their own group
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=eb2971fd4cf23c34a9f95048a7b40471b7b52e09
commit eb2971fd4cf23c34a9f95048a7b40471b7b52e09
Author: Xavi Artigas
Date: Fri Mar 13 11:00:59 2020 +0100
doxygen docs: Put quadtrees in their own group
To clean up the Eina Data Types page
---
src/lib/eina/eina_quadtree.h | 12
1 file changed, 12 insertions(+)
diff --git a/src/lib/eina/eina_quadtree.h b/src/lib/eina/eina_quadtree.h
index ad23bc3343..5598f10d52 100644
--- a/src/lib/eina/eina_quadtree.h
+++ b/src/lib/eina/eina_quadtree.h
@@ -29,6 +29,14 @@
* @{
*/
+/**
+ * @defgroup Eina_Quadtree_Group Quadtrees
+ *
+ * @brief Quadtree operations.
+ *
+ * @{
+ */
+
/**
* @typedef Eina_QuadTree
*
@@ -194,6 +202,10 @@ EAPI Eina_Inlist *eina_quadtree_collide(Eina_QuadTree *q,
int x, int y, int w, i
*/
EAPI void *eina_quadtree_object(Eina_Inlist *list);
+/**
+ * @}
+ */
+
/**
* @}
*/
--
[EGIT] [core/efl] master 03/03: doxygen docs: Fix Eina Promises doc structure and links
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=c4fad77ae3d1e2acbc8d0876edb614d861051dc8
commit c4fad77ae3d1e2acbc8d0876edb614d861051dc8
Author: Xavi Artigas
Date: Tue Mar 17 19:21:41 2020 +0100
doxygen docs: Fix Eina Promises doc structure and links
Man, this was a tough one!
The content still needs work, but the structure makes a bit more sense now,
and there are no broken links, typos or doxygen warnings anymore.
---
src/lib/eina/eina_promise.c | 4 +-
src/lib/eina/eina_promise.h | 506 +---
2 files changed, 286 insertions(+), 224 deletions(-)
diff --git a/src/lib/eina/eina_promise.c b/src/lib/eina/eina_promise.c
index 98ef61e03d..4255f7b41c 100644
--- a/src/lib/eina/eina_promise.c
+++ b/src/lib/eina/eina_promise.c
@@ -139,7 +139,9 @@ static const Eina_Value_Struct_Desc RACE_STRUCT_DESC = {
.size = sizeof(Eina_Future_Race_Result)
};
+/** @cond local */
EAPI const Eina_Value_Struct_Desc *EINA_PROMISE_RACE_STRUCT_DESC =
_STRUCT_DESC;
+/** @endcond */
static inline void
__eina_promise_value_dbg(const char *msg,
@@ -245,7 +247,7 @@ _promise_convert_to(const Eina_Value_Type *type
EINA_UNUSED, const Eina_Value_Ty
return EINA_FALSE;
}
-static const Eina_Value_Type EINA_VALUE_TYPE_PROMISE = {
+const Eina_Value_Type EINA_VALUE_TYPE_PROMISE = {
.version = EINA_VALUE_TYPE_VERSION,
.value_size = sizeof(Eina_Promise *),
.name = "Eina_Promise",
diff --git a/src/lib/eina/eina_promise.h b/src/lib/eina/eina_promise.h
index 548d162aa0..7bd120ec0f 100644
--- a/src/lib/eina/eina_promise.h
+++ b/src/lib/eina/eina_promise.h
@@ -9,26 +9,64 @@ extern "C" {
#include "eina_types.h"
#include "eina_value.h"
-/**
+/** @file */
+
+/** @struct Eina_Promise
* @ingroup Eina_Promise
- *
- * @{
+ * An opaque structure representing a piece of data that will be available at
a later point.
+ * @typedef struct _Eina_Promise Eina_Promise
+ * Convenience wrapper.
*/
-typedef struct _Eina_Future_Desc Eina_Future_Desc;
typedef struct _Eina_Promise Eina_Promise;
+
+/** @struct Eina_Future
+ * @ingroup Eina_Future
+ * An opaque structure representing a callback to be called when a promise is
fulfilled.
+ * @typedef struct _Eina_Future Eina_Future
+ * Convenience wrapper.
+ */
typedef struct _Eina_Future Eina_Future;
+
+/** @typedef struct _Eina_Future_Desc Eina_Future_Desc
+ * @ingroup Eina_Future
+ * Convenience wrapper over #_Eina_Future_Desc. */
+typedef struct _Eina_Future_Desc Eina_Future_Desc;
+
+/** @typedef struct _Eina_Future_Race_Result Eina_Future_Race_Result
+ * @ingroup Eina_Future
+ * Convenience wrapper over #_Eina_Future_Race_Result. */
+typedef struct _Eina_Future_Race_Result Eina_Future_Race_Result;
+
+/**
+ * @defgroup Eina_Future_Callbacks Eina Future Callbacks
+ * @ingroup Eina_Future
+ * @brief Methods and structures dealing with #Eina_Future callbacks
+ * @{
+ */
+
+/** @typedef struct _Eina_Future_Cb_Easy_Desc Eina_Future_Cb_Easy_Desc
+ * Convenience wrapper over #_Eina_Future_Cb_Easy_Desc. */
typedef struct _Eina_Future_Cb_Easy_Desc Eina_Future_Cb_Easy_Desc;
+
+/** @typedef struct _Eina_Future_Cb_Console_Desc Eina_Future_Cb_Console_Desc
+ * Convenience wrapper over _Eina_Future_Cb_Console_Desc. */
typedef struct _Eina_Future_Cb_Console_Desc Eina_Future_Cb_Console_Desc;
+
+/** @typedef struct _Eina_Future_Scheduler Eina_Future_Scheduler
+ * Convenience wrapper over _Eina_Future_Scheduler. */
typedef struct _Eina_Future_Scheduler Eina_Future_Scheduler;
+
+/** @typedef struct _Eina_Future_Schedule_Entry Eina_Future_Schedule_Entry
+ * Convenience wrapper over _Eina_Future_Schedule_Entry. */
typedef struct _Eina_Future_Schedule_Entry Eina_Future_Schedule_Entry;
-typedef struct _Eina_Future_Race_Result Eina_Future_Race_Result;
+
+/** @typedef struct _Eina_Future_Cb_Log_Desc Eina_Future_Cb_Log_Desc
+ * Convenience wrapper over _Eina_Future_Cb_Log_Desc. */
typedef struct _Eina_Future_Cb_Log_Desc Eina_Future_Cb_Log_Desc;
/**
- * @defgroup Eina_Future_Callbacks Efl Future Callbacks
- * @ingroup eina_future
- * @typedef Eina_Future_Cb Eina_Future_Cb
- *
+ * @typedef Eina_Future_Cb
+
* A callback used to inform that a future was resolved.
* Usually this callback is called from a clean context, that is, from the
* main loop or some platform defined safe context. However there are
@@ -43,18 +81,18 @@ typedef struct _Eina_Future_Cb_Log_Desc
Eina_Future_Cb_Log_Desc;
*
* @param[in] data The data provided by the user
*
- * @param[in] value An Eina_Value which contains the operation result. Before
using
+ * @param[in] value An #Eina_Value which contains the operation result. Before
using
* the @p value, its type must be checked in order to avoid errors. This is
needed because
- * if an operation fails the Eina_Value type will be EINA_VALUE_TYPE_ERROR
+ * if an operation fails the #Eina_Value type will be #EINA_VALUE_
[EGIT] [core/efl] master 02/03: doxygen docs: Create Eina Vector2 group in the right place
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=d1c74afc40ef3e4c050c05b47aeefd48d23f42f4
commit d1c74afc40ef3e4c050c05b47aeefd48d23f42f4
Author: Xavi Artigas
Date: Fri Mar 13 11:03:21 2020 +0100
doxygen docs: Create Eina Vector2 group in the right place
A couple members were outside the group and appeared in the
Eina Data Types page instead.
---
src/lib/eina/eina_vector.h | 8
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/src/lib/eina/eina_vector.h b/src/lib/eina/eina_vector.h
index 13617c22e0..998879b099 100644
--- a/src/lib/eina/eina_vector.h
+++ b/src/lib/eina/eina_vector.h
@@ -32,16 +32,16 @@
* @{
*/
-typedef struct _Eina_Vector2 Eina_Vector2;
-typedef struct _Eina_Vector3 Eina_Vector3;
-
-#define EINA_VECTOR2(x, y) ((Eina_Vector2) {(x), (y)})
/**
* @defgroup Eina_Vector2 Floating point vectors in 2D
* @brief 2D vector definition and operations
* @{
*/
+typedef struct _Eina_Vector2 Eina_Vector2;
+typedef struct _Eina_Vector3 Eina_Vector3;
+
+#define EINA_VECTOR2(x, y) ((Eina_Vector2) {(x), (y)})
struct _Eina_Vector2
{
double x;
--
[EGIT] [core/efl] master 01/01: Spotlight: Remove jump_setup from ctors list
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=eb23ead06403e578383c5807f2a83b90c372e05d
commit eb23ead06403e578383c5807f2a83b90c372e05d
Author: Xavi Artigas
Date: Tue Mar 17 11:56:37 2020 +0100
Spotlight: Remove jump_setup from ctors list
This feature has not been used yet and it is making mono_gen abort,
breaking build
(probably because this property has setter but no getter).
---
src/lib/elementary/efl_ui_spotlight_animation_manager.eo | 4
1 file changed, 4 deletions(-)
diff --git a/src/lib/elementary/efl_ui_spotlight_animation_manager.eo
b/src/lib/elementary/efl_ui_spotlight_animation_manager.eo
index da402113c6..014141b28d 100644
--- a/src/lib/elementary/efl_ui_spotlight_animation_manager.eo
+++ b/src/lib/elementary/efl_ui_spotlight_animation_manager.eo
@@ -59,13 +59,9 @@ class @beta Efl.Ui.Spotlight.Animation_Manager extends
Efl.Ui.Spotlight.Manager
Can be the same as $in.]]
}
set {
-
}
}
}
- constructors {
- .jump_setup;
- }
implements {
Efl.Ui.Spotlight.Manager.bind;
Efl.Ui.Spotlight.Manager.content_add;
--
[EGIT] [core/efl] master 01/01: docs: Improve Spotlight.Animation_Manager docs
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=84e561f4dddfa5896304197e0e54ba6b701d7e73
commit 84e561f4dddfa5896304197e0e54ba6b701d7e73
Author: Xavi Artigas
Date: Tue Mar 17 11:39:41 2020 +0100
docs: Improve Spotlight.Animation_Manager docs
---
.../efl_ui_spotlight_animation_manager.eo | 55 +-
1 file changed, 33 insertions(+), 22 deletions(-)
diff --git a/src/lib/elementary/efl_ui_spotlight_animation_manager.eo
b/src/lib/elementary/efl_ui_spotlight_animation_manager.eo
index c82d9666a0..da402113c6 100644
--- a/src/lib/elementary/efl_ui_spotlight_animation_manager.eo
+++ b/src/lib/elementary/efl_ui_spotlight_animation_manager.eo
@@ -1,51 +1,62 @@
class @beta Efl.Ui.Spotlight.Animation_Manager extends Efl.Ui.Spotlight.Manager
{
- [[A spotlight manager that uses animation objects to react to different
@Efl.Ui.Spotlight.Manager.switch_to situations.
+ [[A spotlight manager that uses animation objects to react to different
@Efl.Ui.Spotlight.Manager.switch_to
+ situations.
- Animations are played forward when they are on the $to argument, they are
played backward when they are on the $from argument.
+ Animations are played forward when they are on the $to argument and they
are played backward when they are on the
+ $from argument.
Pop animations are always played backwards, Push animations are always
played forward.
- Reason for this is, the reusability. You should be able to pass in 1
animation to all sitatuations, which should cover the turn arround effect that
"moving in" and "moving out" has. This means, when you have a alpha channel
animation, the pop animation can be the same as the jump-in and out animation,
and both will look like fading out.
-
-
+ The reason for this is reusability: you can use the same animation in all
situations and this covers the
+ inverted effect that "moving in" and "moving out" has.
+ For example, when you have an alpha channel animation, the Pop animation
can be the same as the Jump-In and Out
+ animation, and both will look like fading out.
]]
c_prefix: efl_ui_spotlight_manager_animation;
methods {
- @property push_setup{
- [[Animation that is used to animate the $to argument of a switch_to
request when the passed $reason is push.
-
+ @property push_setup {
+ [[Animation that is used to animate the $to argument of a
@Efl.Ui.Spotlight.Manager.switch_to request when
+ the passed $reason is @Efl.Ui.Spotlight.Manager_Switch_Reason.push.
- If these animations are $null, then the $in and $out animation of
@.jump_setup will be taken instead.
+ If these animations are $null, then the $in and $out animation of
@.jump_setup will be used instead.
]]
values {
in : Efl.Canvas.Animation; [[The animation to play, the
implementation will take an additional reference]]
-out : Efl.Canvas.Animation; [[The animation to play, the
implementation will take an additional reference. Can be the same as $in.]]
+out : Efl.Canvas.Animation; [[The animation to play, the
implementation will take an additional reference.
+ Can be the same as $in.]]
}
- set { }
+ set {}
}
- @property pop_setup{
- [[Animation that is used to animate the $from argument of a switch_to
request when the passed $reason is pop.
- Note: this animations is always played backwards, see the class
documentation for the reasoning.
+ @property pop_setup {
+ [[Animation that is used to animate the $from argument of a
@Efl.Ui.Spotlight.Manager.switch_to request when
+ the passed $reason is @Efl.Ui.Spotlight.Manager_Switch_Reason.pop.
- If these animations are $null, then the $in and $out animation of
@.jump_setup will be taken instead.
+ Note: These animations are always played backwards, see the class
documentation for the reasoning.
+
+ If these animations are $null, then the $in and $out animation of
@.jump_setup will be used instead.
]]
values {
in : Efl.Canvas.Animation; [[The animation to play, the
implementation will take an additional reference]]
-out : Efl.Canvas.Animation; [[The animation to play, the
implementation will take an additional reference. Can be the same as $in.]]
+out : Efl.Canvas.Animation; [[The animation to play, the
implementation will take an additional reference.
+ Can be the same as $in.]]
}
- set { }
+ set {}
}
- @property jump_setup{
- [[Set the animation objects you want to play on a jump in or jump out.
- When a switch to request is issued, two arguments
[EGIT] [core/efl] master 01/01: docs: Efl.Ui.Textbox: Clarify when is Efl.Ui.Scrollable enabled
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=e8100fa8b004f6344a765c623e883ccb60bda88c
commit e8100fa8b004f6344a765c623e883ccb60bda88c
Author: Xavi Artigas
Date: Thu Mar 12 18:13:50 2020 +0100
docs: Efl.Ui.Textbox: Clarify when is Efl.Ui.Scrollable enabled
---
src/lib/elementary/efl_ui_textbox.eo | 6 +-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/src/lib/elementary/efl_ui_textbox.eo
b/src/lib/elementary/efl_ui_textbox.eo
index c4833f315d..f82908a0dc 100644
--- a/src/lib/elementary/efl_ui_textbox.eo
+++ b/src/lib/elementary/efl_ui_textbox.eo
@@ -24,7 +24,11 @@ class @beta Efl.Ui.Textbox extends Efl.Ui.Layout_Base
implements Efl.Input.Click
[[Enable or disable scrolling in the widget.
When scrolling is enabled scrollbars will appear if the text does
- not fit the widget size.]]
+ not fit the widget size.
+
+ Direct control of the scroll through the @Efl.Ui.Scrollable
interface
+ is only possible when this property is enabled.
+ ]]
set {}
get {}
values {
--
[EGIT] [core/efl] master 04/04: doxygen docs: Fix illegal references
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=a004befea51e82899654cb583e03108c29a169a2 commit a004befea51e82899654cb583e03108c29a169a2 Author: Xavi Artigas Date: Thu Mar 12 13:52:42 2020 +0100 doxygen docs: Fix illegal references Mostly typos and unescaped # signs --- doc/eo_tutorial.dox | 4 ++-- src/bin/edje/edje_cc_handlers.c | 2 +- src/lib/eina/eina_value.h | 4 ++-- src/lib/evas/filters/evas_filter_parser.c | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/eo_tutorial.dox b/doc/eo_tutorial.dox index d8e7d7fb8d..baeb10d857 100644 --- a/doc/eo_tutorial.dox +++ b/doc/eo_tutorial.dox @@ -120,11 +120,11 @@ * * @section create_class_h_side How to create a class - H side? * - If the object is new, establish the public APIs - * - #define \$(CLASS_NAME) \$(class_name)_class_get(): will be used to access data/inherit from this class... + * - \#define \$(CLASS_NAME) \$(class_name)_class_get(): will be used to access data/inherit from this class... * - const Eo_Class *\$(class_name)_class_get(void) EINA_CONST: declaration of the function that will create the class (not the instance), i.e virtual table... * - extern EAPI Eo_Op \$(CLASS_NAME)_BASE_ID: class id that will be essentially used to identify functions set of this class * - enum of the function ids of the class in the form \$(CLASS_NAME)_SUB_ID: used to identify the function inside the class; function id is unique per class but (class id, function id) is unique per system.. - * - #define \$(CLASS_NAME)_ID(sub_id) (\$(CLASS_NAME)_BASE_ID + sub_id): formula to calculate the system function id + * - \#define \$(CLASS_NAME)_ID(sub_id) (\$(CLASS_NAME)_BASE_ID + sub_id): formula to calculate the system function id * - define of each function consists of: *- the name of the function that will be used in eo_do *- parameters without types diff --git a/src/bin/edje/edje_cc_handlers.c b/src/bin/edje/edje_cc_handlers.c index 431dea7bdb..913a749d54 100644 --- a/src/bin/edje/edje_cc_handlers.c +++ b/src/bin/edje/edje_cc_handlers.c @@ -4562,7 +4562,7 @@ st_collections_group_name(void) This property can be inherited. Defaults: 0 -@warning Your edc file should always wrap this keyword with #ifdef HAVE_SKIP_NAMESPACE_VALIDATION +@warning Your edc file should always wrap this keyword with \#ifdef HAVE_SKIP_NAMESPACE_VALIDATION @since 1.21 @endproperty */ diff --git a/src/lib/eina/eina_value.h b/src/lib/eina/eina_value.h index faca4bfde1..89793992e7 100644 --- a/src/lib/eina/eina_value.h +++ b/src/lib/eina/eina_value.h @@ -3256,7 +3256,7 @@ static inline Eina_Bool eina_value_struct_setup(Eina_Value *value, * * @param[in] value Value object * @return structure description, with all members and size. - * on failure, #NULL is returned. + * on failure, @c NULL is returned. * * @since 1.21 */ @@ -3706,7 +3706,7 @@ EAPI const char *eina_value_type_name_get(const Eina_Value_Type *type) EINA_PURE * @param[in] type Type reference. * @return #EINA_TRUE if valid, #EINA_FALSE otherwise. * - * A type is invalid if it's NULL or if version field is not the same + * A type is invalid if it's @c NULL or if version field is not the same * as runtime #EINA_VALUE_TYPE_VERSION. * * @since 1.2 diff --git a/src/lib/evas/filters/evas_filter_parser.c b/src/lib/evas/filters/evas_filter_parser.c index 43fd1d17d4..eaf39119a8 100644 --- a/src/lib/evas/filters/evas_filter_parser.c +++ b/src/lib/evas/filters/evas_filter_parser.c @@ -1173,7 +1173,7 @@ _blur_instruction_prepare(Evas_Filter_Program *pgm, Evas_Filter_Instruction *ins @param srcSource buffer. This should be an alpha buffer. @param dstDestination buffer. This should be an RGBA buffer (although alpha is supported). Must be of the same size as @a src. @param black The shadows' color. Usually this will be black (@c #000). - @param white The specular light's color. Usually this will be white (@c #FFF). + @param white The specular light's color. Usually this will be white (@c \#FFF). @param fillmode This specifies how to handle @a map when its dimensions don't match those of @a src and @a dst. Default is to @c repeat. See @ref evasfilter_fillmode "fillmodes". @note As of 2014/02/11, the ALPHA to RGBA support is of much better quality than ALPHA only, but @b very slow. RGBA sources are not supported yet. --
[EGIT] [core/efl] master 02/04: doxygen docs: Fix some more Illegal commands
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=883a09a3ae8dfb887812bda5577d25de92a4ec24 commit 883a09a3ae8dfb887812bda5577d25de92a4ec24 Author: Xavi Artigas Date: Thu Mar 12 11:12:29 2020 +0100 doxygen docs: Fix some more Illegal commands Who thought that Italic Links was a good idea? Anyway, Doxygen does not like them. --- src/lib/elementary/elm_diskselector.h | 2 +- src/lib/elementary/elm_entry.h| 2 +- src/lib/elementary/elm_gengrid.h | 2 +- src/lib/elementary/elm_genlist.h | 2 +- src/lib/elementary/elm_list.h | 2 +- src/lib/elementary/elm_map.h | 2 +- src/lib/elementary/elm_photocam.h | 2 +- src/lib/elementary/elm_toolbar.h | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/lib/elementary/elm_diskselector.h b/src/lib/elementary/elm_diskselector.h index a6b40fb984..c8418263e2 100644 --- a/src/lib/elementary/elm_diskselector.h +++ b/src/lib/elementary/elm_diskselector.h @@ -15,7 +15,7 @@ * It can act like a circular list with round mode and labels can be * reduced for a defined length for side items. * - * This widget implements the @b @ref elm-scrollable-interface + * This widget implements the @ref elm-scrollable-interface * interface, so that all (non-deprecated) functions for the base @ref * Scroller widget also work for diskselectors. * diff --git a/src/lib/elementary/elm_entry.h b/src/lib/elementary/elm_entry.h index ba41964082..3e187b93cd 100644 --- a/src/lib/elementary/elm_entry.h +++ b/src/lib/elementary/elm_entry.h @@ -30,7 +30,7 @@ * This widget inherits from the @ref Elm_Layout one, so that all the * functions acting on it also work for entry objects (since 1.8). * - * This widget implements the @b @ref elm-scrollable-interface + * This widget implements the @ref elm-scrollable-interface * interface, so that all (non-deprecated) functions for the base * @ref Elm_Scroller widget also work for entries (since 1.8). * diff --git a/src/lib/elementary/elm_gengrid.h b/src/lib/elementary/elm_gengrid.h index 9485b7781e..0e781fa584 100644 --- a/src/lib/elementary/elm_gengrid.h +++ b/src/lib/elementary/elm_gengrid.h @@ -19,7 +19,7 @@ * This widget inherits from the @ref Layout one, so that all the * functions acting on it also work for gengrid objects. * - * This widget implements the @b @ref elm-scrollable-interface + * This widget implements the @ref elm-scrollable-interface * interface, so that all (non-deprecated) functions for the base @ref * Scroller widget also work for gengrids. * diff --git a/src/lib/elementary/elm_genlist.h b/src/lib/elementary/elm_genlist.h index e060a685e7..8a1691c0d9 100644 --- a/src/lib/elementary/elm_genlist.h +++ b/src/lib/elementary/elm_genlist.h @@ -22,7 +22,7 @@ * This widget inherits from the @ref Layout one, so that all the * functions acting on it also work for genlist objects. * - * This widget implements the @b @ref elm-scrollable-interface + * This widget implements the @ref elm-scrollable-interface * interface, so that all (non-deprecated) functions for the base @ref * Scroller widget also work for genlists. * diff --git a/src/lib/elementary/elm_list.h b/src/lib/elementary/elm_list.h index 72f5a1084f..07147b4cf7 100644 --- a/src/lib/elementary/elm_list.h +++ b/src/lib/elementary/elm_list.h @@ -75,7 +75,7 @@ * @li @ref elm_object_item_del * @li @ref elm_object_item_signal_emit * - * This widget implements the @b @ref elm-scrollable-interface + * This widget implements the @ref elm-scrollable-interface * interface, so that all (non-deprecated) functions for the base @ref * Scroller widget also work for lists. * diff --git a/src/lib/elementary/elm_map.h b/src/lib/elementary/elm_map.h index bf257309ef..011e84182f 100644 --- a/src/lib/elementary/elm_map.h +++ b/src/lib/elementary/elm_map.h @@ -18,7 +18,7 @@ * @li group of markers and * @li routes. * - * This widget implements the @b @ref elm-scrollable-interface + * This widget implements the @ref elm-scrollable-interface * interface, so that all (non-deprecated) functions for the base @ref * Scroller widget also work for map objects. * diff --git a/src/lib/elementary/elm_photocam.h b/src/lib/elementary/elm_photocam.h index 7286366711..a1ad4fd2d0 100644 --- a/src/lib/elementary/elm_photocam.h +++ b/src/lib/elementary/elm_photocam.h @@ -42,7 +42,7 @@ * @li @c "focused" - When the photocam has received focus. (since 1.8) * @li @c "unfocused" - When the photocam has lost focus. (since 1.8) * - * This widget implements the @b @ref elm-scrollable-interface + * This widget implements the @ref elm-scrollable-interface * interface, so that all (non-deprecated) functions for the base @ref * Scroller widget also work for photocam objects. * diff --git a/src/lib/elementary/elm_toolbar.h b/src/lib/elementary/elm_toolbar.h index 5dcfaa838f..fc88da16ad 100644 --- a/src/lib/elem
[EGIT] [core/efl] master 03/04: doxygen docs: Do not parse file Eo.h
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=500b9f611ba17724b041771c2d028de9dfa92e23 commit 500b9f611ba17724b041771c2d028de9dfa92e23 Author: Xavi Artigas Date: Thu Mar 12 13:18:02 2020 +0100 doxygen docs: Do not parse file Eo.h Doxygen is used to build Legacy documentation, which is unrelated to Eo.h This fixes quite a few "explicit link request could not be resolved" problems produced by Eo.h which was missing the rest of the Unified Efl headers. --- doc/Doxyfile.in | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 0a62bfdec7..17f86aec5e 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -666,7 +666,8 @@ EXCLUDE_PATTERNS = *_private* \ */efl_*.eo.c \ */efl_*.eo.h \ */efl_*.eot.h \ - */Efl_* + */Efl_* \ + */Eo.h # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the --
[EGIT] [core/efl] master 01/04: doxygen docs: Fix some more invalid commands
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=7273229e3c31dfde4ea64d2f0cc8cda4c8c53d2a commit 7273229e3c31dfde4ea64d2f0cc8cda4c8c53d2a Author: Xavi Artigas Date: Thu Mar 12 11:02:11 2020 +0100 doxygen docs: Fix some more invalid commands --- src/lib/evas/canvas/evas_canvas_eo.h | 2 +- src/lib/evas/filters/evas_filter_parser.c | 42 +++ 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/src/lib/evas/canvas/evas_canvas_eo.h b/src/lib/evas/canvas/evas_canvas_eo.h index 938d59fcee..74cd5ef05c 100644 --- a/src/lib/evas/canvas/evas_canvas_eo.h +++ b/src/lib/evas/canvas/evas_canvas_eo.h @@ -808,7 +808,7 @@ EOAPI int evas_canvas_coord_world_x_to_screen(const Eo *obj, int x) EINA_WARN_UN * @param[in] obj The object. * * @return A newly allocated list of updated rectangles of the canvas - * (@Eina.Rect structs). Free this list with @ref evas_render_updates_free. + * (@ref Eina_Rect structs). Free this list with @ref evas_render_updates_free. * * @ingroup Evas_Canvas */ diff --git a/src/lib/evas/filters/evas_filter_parser.c b/src/lib/evas/filters/evas_filter_parser.c index 38d68224d9..43fd1d17d4 100644 --- a/src/lib/evas/filters/evas_filter_parser.c +++ b/src/lib/evas/filters/evas_filter_parser.c @@ -60,7 +60,7 @@ as possible. Note: Lua has been used since 1.10. The previous filters syntax is not -garanteed to be compatible with 1.10 and newer versions. +guaranteed to be compatible with 1.10 and newer versions. Here are the available commands: @@ -136,28 +136,28 @@ will be opaque (alpha = @c 0xFF), unless R=G=B=0 (invisible). These colors are not premultiplied. - Hexademical values: @c '#RRGGBB', @c '#RRGGBBAA', @c '#RGB', @c '#RGBA' + Hexadecimal values: @c '\#RRGGBB', @c '\#RRGGBBAA', @c '\#RGB', @c '\#RGBA' The following string values are also accepted: -'white' == '#FF' -'black' == '#00' -'red' == '#FF' -'green' == '#008000' -'blue' == '#FF' -'darkblue' == '#A0' -'yellow' == '#00' -'magenta' == '#FF00FF' -'cyan' == '#00' -'orange' == '#FFA500' -'purple' == '#800080' -'brown' == '#A52A2A' -'maroon' == '#80' -'lime' == '#00FF00' -'gray' == '#808080' -'grey' == '#808080' -'silver' == '#C0C0C0' -'olive' == '#808000' -'invisible', 'transparent' == '#' -- (alpha is zero) +'white' == '\#FF' +'black' == '\#00' +'red' == '\#FF' +'green' == '\#008000' +'blue' == '\#FF' +'darkblue' == '\#A0' +'yellow' == '\#00' +'magenta' == '\#FF00FF' +'cyan' == '\#00' +'orange' == '\#FFA500' +'purple' == '\#800080' +'brown' == '\#A52A2A' +'maroon' == '\#80' +'lime' == '\#00FF00' +'gray' == '\#808080' +'grey' == '\#808080' +'silver' == '\#C0C0C0' +'olive' == '\#808000' +'invisible', 'transparent' == '\#' -- (alpha is zero) @c fillmode --
[EGIT] [core/efl] master 01/02: doxygen docs: Adapt to Doxygen syntax
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=5c2dfd80a649f84f6fc282abb958f69098ad226c
commit 5c2dfd80a649f84f6fc282abb958f69098ad226c
Author: Xavi Artigas
Date: Tue Mar 10 09:41:14 2020 +0100
doxygen docs: Adapt to Doxygen syntax
I don't know where did these comments come from, but it was not Doxygen.
---
.../ivi-application-client-protocol.h | 42 --
src/lib/ecore_wayland/xdg-shell-client-protocol.h | 42 ++
2 files changed, 25 insertions(+), 59 deletions(-)
diff --git a/src/lib/ecore_wayland/ivi-application-client-protocol.h
b/src/lib/ecore_wayland/ivi-application-client-protocol.h
index 84fecd84ef..7f825772df 100644
--- a/src/lib/ecore_wayland/ivi-application-client-protocol.h
+++ b/src/lib/ecore_wayland/ivi-application-client-protocol.h
@@ -44,59 +44,45 @@ extern const struct wl_interface ivi_application_interface;
#ifndef IVI_SURFACE_WARNING_CODE_ENUM
#define IVI_SURFACE_WARNING_CODE_ENUM
/**
- * ivi_surface_warning_code - possible warning codes returned by ivi
- * compositor
- * @IVI_SURFACE_WARNING_CODE_INVALID_WL_SURFACE: wl_surface is invalid
- * @IVI_SURFACE_WARNING_CODE_IVI_ID_IN_USE: ivi_id is in use and can not
- * be shared
+ * @brief Possible warning codes returned by ivi compositor
*
* These define all possible warning codes returned by ivi compositor on
- * server-side warnings. invalid_wl_surface: - wl_surface already has a
- * another role. - wl_surface is destroyed before the ivi_surface is
- * destroyed. ivi_id_in_use: ivi_id is already assigned by another
- * application.
+ * server-side warnings.
*/
enum ivi_surface_warning_code {
-IVI_SURFACE_WARNING_CODE_INVALID_WL_SURFACE = 1,
-IVI_SURFACE_WARNING_CODE_IVI_ID_IN_USE = 2,
+IVI_SURFACE_WARNING_CODE_INVALID_WL_SURFACE = 1, /**< Surface is
invalid. */
+IVI_SURFACE_WARNING_CODE_IVI_ID_IN_USE = 2, /**< ivi_id is in use and
cannot be shared. */
};
#endif /* IVI_SURFACE_WARNING_CODE_ENUM */
/**
- * ivi_surface - application interface to surface in ivi compositor
- * @visibility: visibility of surface in ivi compositor has changed
- * @warning: server-side warning detected
- *
- *
+ * @brief Application interface to surface in ivi compositor
*/
struct ivi_surface_listener {
/**
- * visibility - visibility of surface in ivi compositor has
+ * @brief Visibility of surface in ivi compositor has
* changed
- * @visibility: (none)
*
- * The new visibility state is provided in argument visibility.
- * If visibility is 0, the surface has become invisible. If
- * visibility is not 0, the surface has become visible.
+ * The new visibility state is provided in argument @p visibility.
+ * If @p visibility is 0, the surface has become invisible. If
+ * @p visibility is not 0, the surface has become visible.
*/
void (*visibility)(void *data,
struct ivi_surface *ivi_surface,
int32_t visibility);
/**
- * warning - server-side warning detected
- * @warning_code: (none)
- * @warning_text: (none)
+ * @brief Server-side warning detected
*
* The ivi compositor encountered warning while processing a
* request by this application. The warning is defined by argument
- * warning_code and optional warning_text. If the warning is
- * detected, client shall destroy the ivi_surface object.
+ * @p warning_code and optional @p warning_text. If the warning is
+ * detected, client shall destroy the @p ivi_surface object.
*
* When a warning event is sent, the compositor turns the
- * ivi_surface object inert. The ivi_surface will not deliver
+ * @p ivi_surface object inert. The @p ivi_surface will not deliver
* further events, all requests on it are ignored except 'destroy',
* and the association to the ivi_id is removed. The client should
- * destroy the ivi_surface object. If an inert ivi_surface object
+ * destroy the @p ivi_surface object. If an inert @p ivi_surface object
* is used as an argument to any other object's request, that
* request will [produce a fatal error / produce a warning / be
* ignored].
diff --git a/src/lib/ecore_wayland/xdg-shell-client-protocol.h
b/src/lib/ecore_wayland/xdg-shell-client-protocol.h
index 24b92b01e1..2b20845db5 100644
--- a/src/lib/ecore_wayland/xdg-shell-client-protocol.h
+++ b/src/lib/ecore_wayland/xdg-shell-client-protocol.h
@@ -77,8 +77,7 @@ enum xdg_shell_error {
#endif /* XDG_SHELL_ERROR_ENUM */
/**
- * xdg_shell - create desktop-style surfaces
- * @ping: check if the client is alive
+ * @brief Create desktop-style surfaces
*
* xdg_shell allows c
[EGIT] [core/efl] master 02/02: doxygen docs: Fix tons of invalid Doxygen commands
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=5b2d2a85b2c74ceabfe5da4dbf2a5c00f0b643e2
commit 5b2d2a85b2c74ceabfe5da4dbf2a5c00f0b643e2
Author: Xavi Artigas
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
[EGIT] [core/efl] master 01/04: doxygen docs: remove doubly-defined @examples
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=b828343175bdf6c2d80c3046b8ee3deb6bf81af6 commit b828343175bdf6c2d80c3046b8ee3deb6bf81af6 Author: Xavi Artigas Date: Mon Mar 9 10:24:22 2020 +0100 doxygen docs: remove doubly-defined @examples This index page only contains references (@ref), the actual examples (@example) are defined elsewhere and the double definition was throwing warnings. --- doc/eina_examples.dox | 37 - 1 file changed, 37 deletions(-) diff --git a/doc/eina_examples.dox b/doc/eina_examples.dox index ad7fcc6b2a..1eecc05408 100644 --- a/doc/eina_examples.dox +++ b/doc/eina_examples.dox @@ -49,41 +49,4 @@ * @li @ref tutorial_quadtree_page * @li @ref tutorial_strbuf * @li @ref tutorial_ustringshare_page - * - * @example eina_accessor_01.c - * @example eina_array_01.c - * @example eina_array_02.c - * @example eina_error_01.c - * @example eina_file_01.c - * @example eina_hash_01.c - * @example eina_hash_02.c - * @example eina_hash_03.c - * @example eina_hash_04.c - * @example eina_hash_05.c - * @example eina_hash_06.c - * @example eina_hash_07.c - * @example eina_hash_08.c - * @example eina_inarray_01.c - * @example eina_inarray_02.c - * @example eina_inarray_03.c - * @example eina_inlist_01.c - * @example eina_inlist_02.c - * @example eina_inlist_03.c - * @example eina_iterator_01.c - * @example eina_list_01.c - * @example eina_list_02.c - * @example eina_list_03.c - * @example eina_list_04.c - * @example eina_log_01.c - * @example eina_log_02.c - * @example eina_log_03.c - * @example eina_magic_01.c - * @example eina_simple_xml_parser_01.c - * @example eina_str_01.c - * @example eina_strbuf_01.c - * @example eina_stringshare_01.c - * @example eina_tiler_01.c - * @example eina_value_01.c - * @example eina_value_02.c - * @example eina_value_03.c */ --
[EGIT] [core/efl] master 02/04: doxygen docs: Move smart object methods to proper group
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=0fbeddfc91fe2f512ce985eb83bf4c9719759da7 commit 0fbeddfc91fe2f512ce985eb83bf4c9719759da7 Author: Xavi Artigas Date: Mon Mar 9 11:43:33 2020 +0100 doxygen docs: Move smart object methods to proper group Move smart object methods from @ingroup Evas_Canvas to Evas_Smart_Object_Group Also, remove lots of redundant @ingroup Evas_Smart_Object_Group --- src/lib/evas/Evas_Legacy.h | 44 1 file changed, 44 deletions(-) diff --git a/src/lib/evas/Evas_Legacy.h b/src/lib/evas/Evas_Legacy.h index 387db2748b..78ca7df9ec 100644 --- a/src/lib/evas/Evas_Legacy.h +++ b/src/lib/evas/Evas_Legacy.h @@ -6331,8 +6331,6 @@ EAPI void evas_object_polygon_points_clear(Evas_Object *obj); /** Call user-provided @c calculate smart functions and unset the flag * signalling that the object needs to get recalculated to all smart objects in * the canvas. - * - * @ingroup Evas_Canvas */ EAPI void evas_smart_objects_calculate(Eo *obj); @@ -6342,8 +6340,6 @@ EAPI void evas_smart_objects_calculate(Eo *obj); * @param[in] obj The object. * * @return @c true if currently calculating smart objects. - * - * @ingroup Evas_Canvas */ EAPI Eina_Bool evas_smart_objects_calculating_get(const Eo *obj); @@ -6359,8 +6355,6 @@ EAPI Eina_Bool evas_smart_objects_calculating_get(const Eo *obj); * canvas. It will take care of setting all of its internals to work * as they should, if the user set things properly, as seem on the * #EVAS_SMART_SUBCLASS_NEW, for example. - * - * @ingroup Evas_Smart_Object_Group */ EAPI Evas_Object *evas_object_smart_add(Evas *e, Evas_Smart *s) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2) EINA_MALLOC; @@ -6381,8 +6375,6 @@ EAPI Evas_Object *evas_object_smart_add(Evas *e, Evas_Smart *s) EINA_WARN_UNUSED * * @see evas_object_smart_member_del() * @see evas_object_smart_members_get() - * - * @ingroup Evas_Smart_Object_Group */ EAPI void evas_object_smart_member_add(Evas_Object *obj, Evas_Object *smart_obj) EINA_ARG_NONNULL(1, 2); @@ -6390,7 +6382,6 @@ EAPI void evas_object_smart_member_add(Evas_Object *obj, Evas_Object *sm * Removes a member object from a given smart object. * * @param obj the member object - * @ingroup Evas_Smart_Object_Group * * This removes a member object from a smart object, if it was added * to any. The object will still be on the canvas, but no longer @@ -6437,7 +6428,6 @@ EAPI void evas_object_smart_member_del(Evas_Object *obj) EINA_ARG_NONNUL * @see @ref Evas_Smart_Object_Group_Callbacks for more details. * * @see evas_object_smart_callback_del() - * @ingroup Evas_Smart_Object_Group */ EAPI void evas_object_smart_callback_add(Evas_Object *obj, const char *event, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1, 2, 3); @@ -6454,7 +6444,6 @@ EAPI void evas_object_smart_callback_add(Evas_Object *obj, const char *e * * @see evas_object_smart_callback_add * @since 1.1 - * @ingroup Evas_Smart_Object_Group */ EAPI void evas_object_smart_callback_priority_add(Evas_Object *obj, const char *event, Evas_Callback_Priority priority, Evas_Smart_Cb func, const void *data); @@ -6476,8 +6465,6 @@ EAPI void evas_object_smart_callback_priority_add(Evas_Object *obj, cons * not successful @c NULL will be returned. * * @see evas_object_smart_callback_add() for more details. - * - * @ingroup Evas_Smart_Object_Group */ EAPI void*evas_object_smart_callback_del(Evas_Object *obj, const char *event, Evas_Smart_Cb func) EINA_ARG_NONNULL(1, 2, 3); @@ -6502,7 +6489,6 @@ EAPI void *evas_object_smart_callback_del(Evas_Object *obj, const char *e * * @see evas_object_smart_callback_add() for more details. * @since 1.2 - * @ingroup Evas_Smart_Object_Group * * @note To delete all smart event callbacks which match @p type and @p func, * use evas_object_smart_callback_del(). @@ -6527,8 +6513,6 @@ EAPI void *evas_object_smart_callback_del_full(Evas_Object *obj, const ch * encouraged to properly set the Evas_Smart_Class::callbacks * callbacks description array, so that the users of the smart object * can have introspection on its events API at run time. - * - * @ingroup Evas_Smart_Object_Group */ EAPI void evas_object_smart_callback_call(Evas_Object *obj, const char *event, void *event_info) EINA_ARG_NONNULL(1, 2); @@ -6577,8 +6561,6 @@ EAPI void *evas_object_smart_interface_data_get(const Evas_Object *o * See also @ref evas_object_smart_type_check_ptr. * * @param[in] type The name (type) of the smart class to check for. - * - * @ingroup Evas_Object */ EAPI Eina_Bool evas_object_smart_type_check(const Evas_Object *obj, const char *type) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(2); @@ -6590,8 +6572,6 @@ EAPI Eina_Bool
[EGIT] [core/efl] master 03/04: doxygen docs: Remove invalid comments
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=7096376119c0ca2231099e8b7395d4b8e170c96e
commit 7096376119c0ca2231099e8b7395d4b8e170c96e
Author: Xavi Artigas
Date: Mon Mar 9 11:55:22 2020 +0100
doxygen docs: Remove invalid comments
They contain no information whatsoever and they contain invalid doxygen
commands.
This was probably copied over from some other documentation format.
---
src/lib/ecore_buffer/bq_mgr_protocol.h | 60 --
1 file changed, 60 deletions(-)
diff --git a/src/lib/ecore_buffer/bq_mgr_protocol.h
b/src/lib/ecore_buffer/bq_mgr_protocol.h
index 7cf9ad9380..79d785d8ca 100644
--- a/src/lib/ecore_buffer/bq_mgr_protocol.h
+++ b/src/lib/ecore_buffer/bq_mgr_protocol.h
@@ -75,25 +75,10 @@ bq_mgr_create_provider(struct bq_mgr *bq_mgr, const char
*name)
}
struct bq_consumer_listener {
- /**
-* connected - (none)
-*/
void (*connected)(void *data,
struct bq_consumer *bq_consumer);
- /**
-* disconnected - (none)
-*/
void (*disconnected)(void *data,
struct bq_consumer *bq_consumer);
- /**
-* buffer_attached - (none)
-* @buffer: (none)
-* @engine: (none)
-* @width: (none)
-* @height: (none)
-* @format: (none)
-* @flags: (none)
-*/
void (*buffer_attached)(void *data,
struct bq_consumer *bq_consumer,
struct bq_buffer *buffer,
@@ -102,17 +87,6 @@ struct bq_consumer_listener {
int32_t height,
int32_t format,
uint32_t flags);
- /**
-* set_buffer_id - (none)
-* @buffer: (none)
-* @id: (none)
-* @offset0: (none)
-* @stride0: (none)
-* @offset1: (none)
-* @stride1: (none)
-* @offset2: (none)
-* @stride2: (none)
-*/
void (*set_buffer_id)(void *data,
struct bq_consumer *bq_consumer,
struct bq_buffer *buffer,
@@ -123,17 +97,6 @@ struct bq_consumer_listener {
int32_t stride1,
int32_t offset2,
int32_t stride2);
- /**
-* set_buffer_fd - (none)
-* @buffer: (none)
-* @fd: (none)
-* @offset0: (none)
-* @stride0: (none)
-* @offset1: (none)
-* @stride1: (none)
-* @offset2: (none)
-* @stride2: (none)
-*/
void (*set_buffer_fd)(void *data,
struct bq_consumer *bq_consumer,
struct bq_buffer *buffer,
@@ -144,18 +107,9 @@ struct bq_consumer_listener {
int32_t stride1,
int32_t offset2,
int32_t stride2);
- /**
-* buffer_detached - (none)
-* @buffer: (none)
-*/
void (*buffer_detached)(void *data,
struct bq_consumer *bq_consumer,
struct bq_buffer *buffer);
- /**
-* add_buffer - (none)
-* @buffer: (none)
-* @serial: (none)
-*/
void (*add_buffer)(void *data,
struct bq_consumer *bq_consumer,
struct bq_buffer *buffer,
@@ -206,27 +160,13 @@ enum bq_provider_error {
#endif /* BQ_PROVIDER_ERROR_ENUM */
struct bq_provider_listener {
- /**
-* connected - (none)
-* @queue_size: (none)
-* @width: (none)
-* @height: (none)
-*/
void (*connected)(void *data,
struct bq_provider *bq_provider,
int32_t queue_size,
int32_t width,
int32_t height);
- /**
-* disconnected - (none)
-*/
void (*disconnected)(void *data,
struct bq_provider *bq_provider);
- /**
-* add_buffer - (none)
-* @buffer: (none)
-* @serial: (none)
-*/
void (*add_buffer)(void *data,
struct bq_provider *bq_provider,
struct bq_buffer *buffer,
--
[EGIT] [core/efl] master 04/04: doxygen docs: remove @ender_group and organize eina vectors
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=dc58262158b315e9f4bfe76b7555150e06c3e180
commit dc58262158b315e9f4bfe76b7555150e06c3e180
Author: Xavi Artigas
Date: Mon Mar 9 13:01:11 2020 +0100
doxygen docs: remove @ender_group and organize eina vectors
Mysterious @ender_group is an invalid doxygen command and I could not find
it defined anywhere. I could not infer its purpose either so... removed.
Put the Eina Vector 2D and 3D groups in their proper place so they appear
with the rest of the Eina basic types.
---
src/lib/eina/eina_matrix.h | 3 ---
src/lib/eina/eina_quad.h | 1 -
src/lib/eina/eina_vector.h | 46 --
3 files changed, 24 insertions(+), 26 deletions(-)
diff --git a/src/lib/eina/eina_matrix.h b/src/lib/eina/eina_matrix.h
index 201054974b..533609dcb0 100644
--- a/src/lib/eina/eina_matrix.h
+++ b/src/lib/eina/eina_matrix.h
@@ -22,9 +22,6 @@
/**
* @file
- * @ender_group{Eina_Matrix_Type}
- * @ender_group{Eina_Matrix3_F16p16}
- * @ender_group{Eina_Matrix3}
*/
/**
diff --git a/src/lib/eina/eina_quad.h b/src/lib/eina/eina_quad.h
index c4cdc9fc90..c9257ee164 100644
--- a/src/lib/eina/eina_quad.h
+++ b/src/lib/eina/eina_quad.h
@@ -22,7 +22,6 @@
/**
* @file
- * @ender_group{Eina_Quad}
*/
/**
diff --git a/src/lib/eina/eina_vector.h b/src/lib/eina/eina_vector.h
index e9ee12d732..13617c22e0 100644
--- a/src/lib/eina/eina_vector.h
+++ b/src/lib/eina/eina_vector.h
@@ -24,42 +24,28 @@
/**
* @file
- * @ender_group{Eina_Vector_Type}
- * @ender_group{Eina_Vector2}
- * @ender_group{Eina_Vector3}
*/
-typedef struct _Eina_Vector2 Eina_Vector2;
-typedef struct _Eina_Vector3 Eina_Vector3;
-
-#define EINA_VECTOR2(x, y) ((Eina_Vector2) {(x), (y)})
/**
- * @}
- * @defgroup Eina_Vector2 Vectors in floating point
- * @ingroup Eina_Basic
- * @brief Vector definition and operations
+ * @addtogroup Eina_Data_Types_Group Data Types
+ *
* @{
*/
-struct _Eina_Vector2
-{
- double x;
- double y;
-};
+typedef struct _Eina_Vector2 Eina_Vector2;
+typedef struct _Eina_Vector3 Eina_Vector3;
+#define EINA_VECTOR2(x, y) ((Eina_Vector2) {(x), (y)})
/**
- * @}
- * @defgroup Eina_Vector3 Vectors in floating point
- * @ingroup Eina_Basic
- * @brief Vector definition and operations
+ * @defgroup Eina_Vector2 Floating point vectors in 2D
+ * @brief 2D vector definition and operations
* @{
*/
-struct _Eina_Vector3
+struct _Eina_Vector2
{
double x;
double y;
- double z;
};
/**
@@ -234,6 +220,20 @@ static inline void
eina_vector2_homogeneous_position_transform(Eina_Vector2 *out
*/
static inline void eina_vector2_homogeneous_direction_transform(Eina_Vector2
*out, const Eina_Matrix3 *m, const Eina_Vector2 *v);
+/** @} */
+
+/**
+ * @defgroup Eina_Vector3 Floating point vectors in 3D
+ * @brief 3D vector definition and operations
+ * @{
+ */
+struct _Eina_Vector3
+{
+ double x;
+ double y;
+ double z;
+};
+
/**
* @brief Set parameters to vector.
*
@@ -536,6 +536,8 @@ static inline Eina_Bool
eina_vector3_triangle_equivalent(Eina_Vector3 *v0, Eina_
/** @} */
+/** @} */
+
#include "eina_inline_vector.x"
#endif
--
[EGIT] [core/efl] master 01/01: eina: Docs/Comments: eina_safety_checks: Correct grammar, spelling mistakes and be more clearer
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=0f03165fec90c462caad7f715c71477a82a65fb0 commit 0f03165fec90c462caad7f715c71477a82a65fb0 Author: Xavi Artigas Date: Mon Mar 9 09:58:19 2020 +0100 eina: Docs/Comments: eina_safety_checks: Correct grammar, spelling mistakes and be more clearer Summary: This just corrects the comments grammar, spelling mistakes and is a little bit clearer. Reviewers: segfaultxavi, barbieri Reviewed By: segfaultxavi Tags: #efl Differential Revision: https://phab.enlightenment.org/D11472 --- src/lib/eina/eina_safety_checks.h | 10 +- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/lib/eina/eina_safety_checks.h b/src/lib/eina/eina_safety_checks.h index cf29f27a21..27551290d6 100644 --- a/src/lib/eina/eina_safety_checks.h +++ b/src/lib/eina/eina_safety_checks.h @@ -29,16 +29,16 @@ * @defgroup Eina_Safety_Checks_Group Safety Checks * * @warning @c eina_safety_checks.h should only be included by source - * files, after all other includes and before the source file + * files after all other includes and before the source file * specific includes. By source file specific includes we * mean those that define the functions that are being * checked. The reason for such complexity is the trick to * avoid compiler optimizations. If compilers are told that * some given function will never receive @c NULL - * (EINA_ARG_NONNULL(), then compiler will emit a warning if - * it detects so (good!) but will remove any checks for that + * (EINA_ARG_NONNULL()), then the compiler will emit a warning if + * it detects so (good!) and also will remove any checks for that * condition as it believes it will never happen, removing - * all safety checks! By including @c eina_safety_checks.h it + * all safety checks! By including @c eina_safety_checks.h last it * will redefine EINA_ARG_NONNULL() to void and compiler * warning will not be emitted, but checks will be there. The * files already processed with the old macro @@ -69,7 +69,7 @@ * will log and return instead of abort() your program. * * Since these cases should never happen, one may want to keep safety - * checks enabled during tests but disable then during deploy, not + * checks enabled during tests but disable them during deploy, not * doing any checks at all. This is a common requirement for embedded * systems. When to check or not should be set during compile time * by using @c --disable-safety-checks or @c --enable-safety-checks --
[EGIT] [core/efl] master 01/01: doxygen docs: Miscellaneous typos
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=c6e40641aabfb55b4d93a06054ec68fec07615b8 commit c6e40641aabfb55b4d93a06054ec68fec07615b8 Author: Xavi Artigas Date: Thu Mar 5 09:35:05 2020 +0100 doxygen docs: Miscellaneous typos --- src/lib/eina/eina_types.h | 2 +- src/lib/eo/Eo.h | 2 +- src/lib/evil/evil_mman.h | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/lib/eina/eina_types.h b/src/lib/eina/eina_types.h index 7c5ef004eb..eed37097de 100644 --- a/src/lib/eina/eina_types.h +++ b/src/lib/eina/eina_types.h @@ -468,7 +468,7 @@ # define EINA_PREFETCH_NOCACHE(arg) /** - * @def EINA_PREFETCH_WRITE_NOCACHE + * @def EINA_PREFETCH_NOCACHE_WRITE * * @brief Hints that the pointer @parg needs to be pre-fetched into cache * diff --git a/src/lib/eo/Eo.h b/src/lib/eo/Eo.h index f51acb54f3..c85c2defd7 100644 --- a/src/lib/eo/Eo.h +++ b/src/lib/eo/Eo.h @@ -2283,7 +2283,7 @@ EAPI int efl_callbacks_cmp(const Efl_Callback_Array_Item *a, const Efl_Callback_ EOAPI unsigned int efl_event_callback_count(const Eo *obj, const Efl_Event_Description *desc); /** - * @def Replace the previous Eo pointer with new content. + * @brief Replace the previous Eo pointer with new content. * * @param storage Pointer to the space holding the object to be replaced. * It can not be @c NULL. diff --git a/src/lib/evil/evil_mman.h b/src/lib/evil/evil_mman.h index 747917d204..c9c57aa5e0 100644 --- a/src/lib/evil/evil_mman.h +++ b/src/lib/evil/evil_mman.h @@ -59,7 +59,7 @@ /** - * @file mman.h + * @file evil_mman.h * @brief The file that provides the memory map functions * @defgroup Evil_Mman Functions that manage memory mappping. * @ingroup Evil --
[EGIT] [core/efl] master 13/13: ecore_evas: Use EFL naming convention in cnp & dnd methods
bu5hm4n pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=7a79e15ea3c808b92482dbdecb294c6cf3212f91 commit 7a79e15ea3c808b92482dbdecb294c6cf3212f91 Author: Xavi Artigas Date: Tue Mar 3 13:10:49 2020 +0100 ecore_evas: Use EFL naming convention in cnp & dnd methods Some methods were missing the "Drag" or "Selection" namespaces or the _Cb suffix. Depends on D11219 Reviewed-by: Mike Blumenkrantz Differential Revision: https://phab.enlightenment.org/D11426 --- src/lib/ecore_evas/Ecore_Evas.h | 19 +-- src/lib/ecore_evas/ecore_evas.c | 6 +++--- src/lib/ecore_evas/ecore_evas_fallback_selection.c| 4 ++-- src/lib/ecore_evas/ecore_evas_private.h | 18 +- .../ecore_evas/engines/cocoa/ecore_evas_cocoa.c | 2 +- .../engines/wayland/ecore_evas_wayland_common.c | 6 +++--- .../ecore_evas/engines/win32/ecore_evas_win32.c | 2 +- src/modules/ecore_evas/engines/x/ecore_evas_x.c | 2 +- 8 files changed, 29 insertions(+), 30 deletions(-) diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h index 713ad9748f..e3e8b63000 100644 --- a/src/lib/ecore_evas/Ecore_Evas.h +++ b/src/lib/ecore_evas/Ecore_Evas.h @@ -3756,7 +3756,7 @@ EAPI Eina_Future* ecore_evas_selection_get(Ecore_Evas *ee, unsigned int seat, Ec * * Set this callback using ecore_evas_callback_drop_state_changed_set. */ -typedef void (*Ecore_Evas_Drag_Finished)(Ecore_Evas *ee, unsigned int seat, void *data, Eina_Bool accepted); +typedef void (*Ecore_Evas_Drag_Finished_Cb)(Ecore_Evas *ee, unsigned int seat, void *data, Eina_Bool accepted); /** * @brief Starts a new drag operation. @@ -3776,7 +3776,8 @@ typedef void (*Ecore_Evas_Drag_Finished)(Ecore_Evas *ee, unsigned int seat, void * * This method must be called when a drag operation is initiated in order to provide the necessary information. */ -EAPI Eina_Bool ecore_evas_drag_start(Ecore_Evas *ee, unsigned int seat, Eina_Content *content, Ecore_Evas *drag_rep, const char* action, Ecore_Evas_Drag_Finished terminate_cb, void *data); +EAPI Eina_Bool ecore_evas_drag_start(Ecore_Evas *ee, unsigned int seat, Eina_Content *content, Ecore_Evas *drag_rep, + const char* action, Ecore_Evas_Drag_Finished_Cb terminate_cb, void *data); /** * @brief Cancels an ongoing drag operation. @@ -3798,7 +3799,7 @@ EAPI Eina_Bool ecore_evas_drag_cancel(Ecore_Evas *ee, unsigned int seat); * * Set this callback using ecore_evas_callback_drop_state_changed_set. */ -typedef void (*Ecore_Evas_State_Changed)(Ecore_Evas *ee, unsigned int seat, Eina_Position2D p, Eina_Bool inside); +typedef void (*Ecore_Evas_Drag_State_Changed_Cb)(Ecore_Evas *ee, unsigned int seat, Eina_Position2D p, Eina_Bool inside); /** * @brief Sets the method (callback) to call when the mouse pointer enters or exits the specified window while @@ -3810,7 +3811,7 @@ typedef void (*Ecore_Evas_State_Changed)(Ecore_Evas *ee, unsigned int seat, Eina * 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. */ -EAPI void ecore_evas_callback_drop_state_changed_set(Ecore_Evas *ee, Ecore_Evas_State_Changed cb); +EAPI void ecore_evas_callback_drop_state_changed_set(Ecore_Evas *ee, Ecore_Evas_Drag_State_Changed_Cb cb); /** * @brief This method is called when the mouse pointer moves over the specified window while @@ -3822,7 +3823,7 @@ EAPI void ecore_evas_callback_drop_state_changed_set(Ecore_Evas *ee, Ecore_Evas_ * Set this callback using ecore_evas_callback_drop_motion_set. */ -typedef void (*Ecore_Evas_Motion_Cb)(Ecore_Evas *ee, unsigned int seat, Eina_Position2D p); +typedef void (*Ecore_Evas_Drag_Motion_Cb)(Ecore_Evas *ee, unsigned int seat, Eina_Position2D p); /** * @brief Sets the method (callback) to call when the mouse pointer moves over the specified window while * performing a drag operation. @@ -3833,7 +3834,7 @@ typedef void (*Ecore_Evas_Motion_Cb)(Ecore_Evas *ee, unsigned int seat, Eina_Pos * 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. */ -EAPI void ecore_evas_callback_drop_motion_set(Ecore_Evas *ee, Ecore_Evas_Motion_Cb cb); +EAPI void ecore_evas_callback_drop_motion_set(Ecore_Evas *ee, Ecore_Evas_Drag_Motion_Cb cb); /** * @brief This method is called when the mouse pointer is released over the specified window while @@ -3861,16 +3862,14 @@ typedef void (*Ecore_Evas_Drop_Cb)(Ecore_Evas *ee, unsigned int seat, Eina_Posit */ EAPI void ecore_evas_callback_drop_drop_set(Ecore_Evas *ee, Ecore_Evas_Drop_Cb cb); -// app calls this (from one of the motion cb's, for e
[EGIT] [core/efl] master 12/13: mono-tests: Fix build after DnD changes
bu5hm4n pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=8b25bc41b33cf366ef068b04cc3de55b76310891
commit 8b25bc41b33cf366ef068b04cc3de55b76310891
Author: Xavi Artigas
Date: Tue Jan 28 17:33:42 2020 +
mono-tests: Fix build after DnD changes
The test struct used to check mono bindings struct pack/unpack
is no longer available. Used a different one, and checked the same things.
Reviewed-by: João Paulo Taylor Ienczak Zanette
Differential Revision: https://phab.enlightenment.org/D11219
---
src/tests/efl_mono/Structs.cs | 17 -
1 file changed, 8 insertions(+), 9 deletions(-)
diff --git a/src/tests/efl_mono/Structs.cs b/src/tests/efl_mono/Structs.cs
index 151bc8388d..334057c907 100644
--- a/src/tests/efl_mono/Structs.cs
+++ b/src/tests/efl_mono/Structs.cs
@@ -499,15 +499,14 @@ internal class TestStructTuples
#if EFL_BETA
public static void test_complex_fields_assign_conversion() {
var pos = new Eina.Position2D(1, 2);
-var action = Efl.Ui.SelectionAction.Unknown;
-var format = Efl.Ui.SelectionFormat.None;
-var item = null as Efl.Canvas.Vg.Object;
-
-Efl.Dnd.DragPos attr = (pos, action, format, item);
-Test.AssertEquals(attr.Pos, pos);
-Test.AssertEquals(attr.Action, action);
-Test.AssertEquals(attr.Format, format);
-Test.AssertEquals(attr.Item, item);
+uint seat = 3;
+var types = new System.String[] {"text", "markup"};
+
+Efl.Ui.DropEvent attr = (pos, seat, types);
+Test.AssertEquals(attr.Position, pos);
+Test.AssertEquals(attr.Seat, seat);
+Test.AssertEquals(attr.AvailableTypes.ElementAt(0), types[0]);
+Test.AssertEquals(attr.AvailableTypes.ElementAt(1), types[1]);
}
#endif
}
--
[EGIT] [core/efl] master 11/13: docs: Strengthen docs for Copy and Drag
bu5hm4n pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=645c3d41ebd4b446c45e17a60fddf60302481bcc commit 645c3d41ebd4b446c45e17a60fddf60302481bcc Author: Xavi Artigas Date: Tue Mar 3 11:12:08 2020 +0100 docs: Strengthen docs for Copy and Drag Including Eina.Content And a typo/bugfix in ecore_evas_x. Reviewed-by: Mike Blumenkrantz Differential Revision: https://phab.enlightenment.org/D11204 --- src/lib/ecore_evas/Ecore_Evas.h | 2 - src/lib/eina/eina_abstract_content.h| 68 ++-- src/lib/elementary/efl_ui_dnd.eo| 82 - src/lib/elementary/efl_ui_selection.eo | 74 +++--- src/lib/elementary/efl_ui_textbox.eo| 23 --- src/lib/eo/eina_types.eot | 11 +++- src/modules/ecore_evas/engines/x/ecore_evas_x.c | 2 +- 7 files changed, 163 insertions(+), 99 deletions(-) diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h index ddc3622741..713ad9748f 100644 --- a/src/lib/ecore_evas/Ecore_Evas.h +++ b/src/lib/ecore_evas/Ecore_Evas.h @@ -3695,8 +3695,6 @@ typedef void (*Ecore_Evas_Selection_Changed_Cb)(Ecore_Evas *ee, unsigned int sea * Only one such callback can exist for each Ecore_Evas. Calling this method multiple * times overwrites previous functions. Use a NULL @p func to stop being notified. * - * You will not be notified about selection changes caused by yourself. (TODO: bu5hm4n?) - * * @warning If and when this function is called depends on the underlying * windowing system. */ diff --git a/src/lib/eina/eina_abstract_content.h b/src/lib/eina/eina_abstract_content.h index 1436543f4e..9b723d553f 100644 --- a/src/lib/eina/eina_abstract_content.h +++ b/src/lib/eina/eina_abstract_content.h @@ -4,22 +4,22 @@ /** * @typedef Eina_Content - * Defines a abstract content segment + * Container for any type of content. * - * Each Abstract content contains out of a Eina_Slice of memory. And a type. - * The type are IANA meme types. + * Each Eina_Content is made of an Eina_Slice of memory and an IANA MIME type: + * https://www.iana.org/assignments/media-types/media-types.xhtml * - * @note if the type is a text-style type, the last byte of the slice must be \0 + * @note If the type is any kind of text the last byte of the slice must be \0. * * @since 1.24 */ typedef struct _Eina_Content Eina_Content; /** - * @typedef Eina_Content_Convertion_Callback + * @typedef Eina_Content_Conversion_Callback * - * Callback called when convertion from one type to another type is requested. - * The from and to type is specified when the callback is registered. + * Method called when conversion from one type to another is requested. + * The from and to types are specified when the callback is registered. * The to type is also passed in the callback here. * The type of the from pointer does not need to be checked. */ @@ -38,7 +38,7 @@ EAPI const char* eina_content_as_file(Eina_Content *content); /** * Convert the content of the object to another type. * - * In case the convertion cannot be performaned, NULL is returned. + * In case the conversion cannot be performed, NULL is returned. * * @param[in] content The content to convert. * @param[in] new_type The new type the returned content will have. @@ -57,19 +57,19 @@ EAPI Eina_Content* eina_content_convert(Eina_Content *content, const char *new_t EAPI const char* eina_content_type_get(Eina_Content *content); /** - * Get the type of the passed content. + * Get the Eina_Slice of the passed content. * - * @param[in] content The content to fetch the type from. + * @param[in] content The content to fetch the data from. * - * @return The path to the file. Do not free this. + * @return An Eina_Slice containing the data. Do not free. */ EAPI const Eina_Slice eina_content_data_get(Eina_Content *content); /** - * Create a new content object, with the slice of data with a specific type. + * Create a new content object, with the provided data and type. * - * @param[in] data A slice of memory, the memory is duplicated. - * @param[in] type The type of memory. + * @param[in] data A slice of memory. The memory is copied. + * @param[in] type The type this data represents. * * @return The new content object. The caller owns this object. */ @@ -85,62 +85,62 @@ EAPI void eina_content_free(Eina_Content *content); /** * Register a new conversion callback. * - * @param[in] from The tyoe you convert from. - * @param[in] in The type you convert to. + * @param[in] from The type to convert from. + * @param[in] to The type to convert to. * - * @return True on success false otherwise. + * @return True if the callback was successfully registered. */ EAPI Eina_Bool eina_content_converter_conversion_register(const char *from, const char *to, Eina_Content_Conversion_Callback convertion
[EGIT] [core/efl] master 03/03: doxygen docs: Fix several group problems
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=43f98b2d46eef463a6cbef55c265aaba1fb1345b
commit 43f98b2d46eef463a6cbef55c265aaba1fb1345b
Author: Xavi Artigas
Date: Tue Mar 3 18:46:36 2020 +0100
doxygen docs: Fix several group problems
@ingroup before @addgroup, circular group dependencies...
---
src/lib/eina/eina_hamster.h | 17 +
src/lib/elementary/elm_color_class.h | 1 -
src/lib/embryo/Embryo.h | 144 +--
3 files changed, 73 insertions(+), 89 deletions(-)
diff --git a/src/lib/eina/eina_hamster.h b/src/lib/eina/eina_hamster.h
index e5b7129f04..3d0ce2bcdb 100644
--- a/src/lib/eina/eina_hamster.h
+++ b/src/lib/eina/eina_hamster.h
@@ -20,24 +20,13 @@
#define EINA_HAMSTER_H_
/**
- * @addtogroup Eina_Hamster_Group Hamster
+ * @defgroup Eina_Hamster_Group Hamster
*
* @brief These functions provide hamster calls.
*
* @{
*/
-/**
- * @addtogroup Eina_Core_Group Core
- *
- * @{
- */
-
-/**
- * @defgroup Eina_Hamster_Group Hamster
- */
-
-
/**
* @brief Gets the hamster count.
*
@@ -47,10 +36,6 @@
*/
EAPI int eina_hamster_count(void);
-/**
- * @}
- */
-
/**
* @}
*/
diff --git a/src/lib/elementary/elm_color_class.h
b/src/lib/elementary/elm_color_class.h
index 97a503148d..8d97f2bce8 100644
--- a/src/lib/elementary/elm_color_class.h
+++ b/src/lib/elementary/elm_color_class.h
@@ -3,7 +3,6 @@
/**
* @defgroup Elm_Color_Class_Group Color Class Editor
- * @ingroup Elm_Color_Class_Group
* @brief This group provides a UI for editing color classes in applications.
*
* @{
diff --git a/src/lib/embryo/Embryo.h b/src/lib/embryo/Embryo.h
index 21177bddfc..84e39aca46 100644
--- a/src/lib/embryo/Embryo.h
+++ b/src/lib/embryo/Embryo.h
@@ -521,14 +521,6 @@ EAPI Embryo_Program *embryo_program_load(const char
*file);
* @ingroup Embryo_Program_Creation_Group
*/
EAPI void embryo_program_free(Embryo_Program *ep);
-
-/**
- * Adds a native program call to the given Embryo program.
- * @param ep The given Embryo program.
- * @param name The name for the call used in the script.
- * @param func The function to use when the call is made.
- * @ingroup Embryo_Func_Group
- */
/**
* @defgroup Embryo_Func_Group Function Functions
@@ -536,13 +528,15 @@ EAPI void embryo_program_free(Embryo_Program
*ep);
*
* Functions that deal with Embryo program functions.
*/
-EAPI void embryo_program_native_call_add(Embryo_Program *ep, const
char *name, Embryo_Cell (*func) (Embryo_Program *ep, Embryo_Cell *params));
/**
- * Resets the current virtual machine session of the given program.
- * @param ep The given program.
- * @ingroup Embryo_Program_VM_Group
+ * Adds a native program call to the given Embryo program.
+ * @param ep The given Embryo program.
+ * @param name The name for the call used in the script.
+ * @param func The function to use when the call is made.
+ * @ingroup Embryo_Func_Group
*/
+EAPI void embryo_program_native_call_add(Embryo_Program *ep, const
char *name, Embryo_Cell (*func) (Embryo_Program *ep, Embryo_Cell *params));
/**
* @defgroup Embryo_Program_VM_Group Virtual Machine Functions
@@ -563,6 +557,12 @@ EAPI void
embryo_program_native_call_add(Embryo_Program *ep, const c
* The current virtual machine session can be destroyed by calling
* @ref embryo_program_vm_pop.
*/
+
+/**
+ * Resets the current virtual machine session of the given program.
+ * @param ep The given program.
+ * @ingroup Embryo_Program_VM_Group
+ */
EAPI void embryo_program_vm_reset(Embryo_Program *ep);
/**
@@ -586,13 +586,6 @@ EAPI void
embryo_program_vm_push(Embryo_Program *ep);
* @ingroup Embryo_Program_VM_Group
*/
EAPI void embryo_program_vm_pop(Embryo_Program *ep);
-
-/**
- * Ensures that the given unsigned short integer is in the small
- * endian format.
- * @param v Pointer to the given integer.
- * @ingroup Embryo_Swap_Group
- */
/**
* @defgroup Embryo_Swap_Group Byte Swapping Functions
@@ -603,6 +596,13 @@ EAPI void embryo_program_vm_pop(Embryo_Program
*ep);
* used to ensure that the virtual machine operates correctly on big
* endian machines.
*/
+
+/**
+ * Ensures that the given unsigned short integer is in the small
+ * endian format.
+ * @param v Pointer to the given integer.
+ * @ingroup Embryo_Swap_Group
+ */
EAPI void embryo_swap_16(unsigned short *v);
/**
@@ -622,6 +622,15 @@ EAPI void embryo_swap_32(unsigned int *v);
*/
EAPI Embryo_Function embryo_program_function_find(Embryo_Program *ep, const
char *name);
+/**
+ * @defgroup Embryo_Public_Variable_Group Public Variable Access Functions
+ * @ingroup Embryo
+ *
+ * In an Embryo program, a global variable can be declared public, as
+ * described in @ref Small_Scope_Subsection. The functions here
[EGIT] [core/efl] master 01/03: doxygen docs: fix multiple defined @section's
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=9aecf76824a614a951e0b2eb826457fe9e174d1f
commit 9aecf76824a614a951e0b2eb826457fe9e174d1f
Author: Xavi Artigas
Date: Tue Mar 3 11:09:47 2020 +0100
doxygen docs: fix multiple defined @section's
Section names must be globally unique.
We rarely reference sections so we don't actually need to use @section
and a simple header suffices.
---
doc/ephysics_examples.dox | 48 -
src/bin/edje/edje_cc_handlers.c | 4 ++--
src/lib/emotion/Emotion.h | 2 +-
3 files changed, 27 insertions(+), 27 deletions(-)
diff --git a/doc/ephysics_examples.dox b/doc/ephysics_examples.dox
index cddf3c8bdf..6d99ed78ee 100644
--- a/doc/ephysics_examples.dox
+++ b/doc/ephysics_examples.dox
@@ -196,7 +196,7 @@
/**
* @page test_bouncing_ball_c test_bouncing_ball.c
*
- * @section ephysics-test-h ephysics_test.h
+ * # ephysics_test.h
* @include ephysics_test.h
*
* @section test-bouncing-ball-c test_bouncing_ball.c
@@ -271,7 +271,7 @@
/**
* @page test_bouncing_text_c test_bouncing_text.c
*
- * @section ephysics-test-h ephysics_test.h
+ * # ephysics_test.h
* @include ephysics_test.h
*
* @section test-bouncing_text-c test_bouncing_text.c
@@ -323,7 +323,7 @@
* @skip struct _Camera_Data {
* @until };
*
- * @section add-camera Adding a Camera
+ * # Adding a Camera
*
* To move the camera in this example, we'll use an animator.
*
@@ -355,7 +355,7 @@
* @until ephysics_camera_position_set(camera, x, y
* @skipline }
*
- * @section add-uptfloor Updating the floor
+ * # Updating the floor
*
* Here we'll use 2 floor images to give the impression of an infinite ground.
*
@@ -402,7 +402,7 @@
/**
* @page test_camera_c test_camera.c
*
- * @section ephysics-test-h ephysics_test.h
+ * # ephysics_test.h
* @include ephysics_test.h
*
* @section test-camera-c test_camera.c
@@ -454,7 +454,7 @@
* @skip struct _Track_Data {
* @until };
*
- * @section add-camera Adding a Camera
+ * # Adding a Camera
*
* In this example we'll use 3 kinds of tracking, to change this values we'll
* have an Elementary spinner widget and handle it on this function.
@@ -480,7 +480,7 @@
* @skip ephysics_camera_body_track(camera, body
* @until }
*
- * @section add-uptfloor Updating the floor
+ * # Updating the floor
*
* Here we'll use 2 floor images to give the impression of an infinite ground.
*
@@ -536,7 +536,7 @@
/**
* @page test_camera_track_c test_camera_track.c
*
- * @section ephysics-test-h ephysics_test.h
+ * # ephysics_test.h
* @include ephysics_test.h
*
* @section test-camera-track-c test_camera_track.c
@@ -583,7 +583,7 @@
* @skip struct _Collision_Data {
* @until };
*
- * @section add-callbacks Adding the Callback
+ * # Adding the Callback
*
* Calling ephysics_body_event_callback_add()
* will register a callback to a type of physics body event.
@@ -632,7 +632,7 @@
/**
* @page test_collision_detection_c test_collision_detection.c
*
- * @section ephysics-test-h ephysics_test.h
+ * # ephysics_test.h
* @include ephysics_test.h
*
* @section test-collision_detection-c test_collision_detection.c
@@ -671,7 +671,7 @@
* already covered in
* @ref tutorial_ephysics_bouncing_ball
*
- * @section add-callbacks Adding the balls
+ * # Adding the balls
* @dontinclude test_collision_filter.c
*
* We'll use two arrays (color and size) to distinguish the groups.
@@ -711,7 +711,7 @@
/**
* @page test_collision_filter_c test_collision_filter.c
*
- * @section ephysics-test-h ephysics_test.h
+ * # ephysics_test.h
* @include ephysics_test.h
*
* @section test-collision_filter-c test_collision_filter.c
@@ -748,7 +748,7 @@
* covered in
* @ref tutorial_ephysics_bouncing_ball
*
- * @section add-callbacks Adding Callbacks
+ * # Adding Callbacks
* @dontinclude test_delete.c
*
* Calling ephysics_body_event_callback_add()
@@ -800,7 +800,7 @@
/**
* @page test_delete_c test_delete.c
*
- * @section ephysics-test-h ephysics_test.h
+ * # ephysics_test.h
* @include ephysics_test.h
*
* @section test-delete-c test_delete.c
@@ -858,7 +858,7 @@
/**
* @page test_constraint_c test_constraint.c
*
- * @section ephysics-test-h ephysics_test.h
+ * # ephysics_test.h
* @include ephysics_test.h
*
* @section test-constraint-c test_constraint.c
@@ -932,7 +932,7 @@
/**
* @page test_forces_c test_forces.c
*
- * @section ephysics-test-h ephysics_test.h
+ * # ephysics_test.h
* @include ephysics_test.h
*
* @section test-forces-c test_forces.c
@@ -998,7 +998,7 @@
/**
* @page test_growing_balls_c test_growing_balls.c
*
- * @section ephysics-test-h ephysics_test.h
+ * # ephysics_test.h
* @include ephysics_test.h
*
* @section test-growing-balls-c test_growing_balls.c
@@ -1069,7 +1069,7 @@
/**
* @page test_no_gravity_c test_no_gravity.c
*
- * @section ephysics-test-h
[EGIT] [core/efl] master 02/03: doxygen docs: fix insufficiently namespaced group names
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=c5b1694985bd9cfd74042c05df911ecd7474
commit c5b1694985bd9cfd74042c05df911ecd7474
Author: Xavi Artigas
Date: Tue Mar 3 17:49:23 2020 +0100
doxygen docs: fix insufficiently namespaced group names
These led to clashes, since group names must be globally unique.
---
src/lib/elementary/elm_code_diff_widget.h | 2 +-
src/lib/elementary/elm_code_line.h| 2 +-
src/lib/elementary/elm_code_text.h| 2 +-
3 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/src/lib/elementary/elm_code_diff_widget.h
b/src/lib/elementary/elm_code_diff_widget.h
index 7a6f2d6412..4387f9dbb2 100644
--- a/src/lib/elementary/elm_code_diff_widget.h
+++ b/src/lib/elementary/elm_code_diff_widget.h
@@ -12,7 +12,7 @@ extern "C" {
/**
* @brief UI Loading functions.
- * @defgroup Init Creating a diff widget to render an Elm Code backend
+ * @defgroup Elm_Code_Diff_Init Creating a diff widget to render an Elm Code
backend
* when it's referencing a diff file
*
* @{
diff --git a/src/lib/elementary/elm_code_line.h
b/src/lib/elementary/elm_code_line.h
index 3703a4a4d8..5f42174041 100644
--- a/src/lib/elementary/elm_code_line.h
+++ b/src/lib/elementary/elm_code_line.h
@@ -40,7 +40,7 @@ EAPI void elm_code_line_free(Elm_Code_Line *line);
/**
* @brief Line manipulation functions.
- * @defgroup Content Elementary Code Line
+ * @defgroup Elm_Code_Line_Content Elementary Code Line
* @{
*
* Functions for changing the content of lines in an Elm_Code_File
diff --git a/src/lib/elementary/elm_code_text.h
b/src/lib/elementary/elm_code_text.h
index 97d67653fb..b79d30f3a5 100644
--- a/src/lib/elementary/elm_code_text.h
+++ b/src/lib/elementary/elm_code_text.h
@@ -14,7 +14,7 @@ extern "C" {
/**
* @brief Line text handling functions.
- * @defgroup Text access and manipulation within lines
+ * @defgroup Elm_Code_Text access and manipulation within lines
*
* @{
*
--
[EGIT] [core/efl] master 03/11: doxygen: remove duplicated sections
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=dc9750ae1ce8d570a859f1a8a6040176033e833b
commit dc9750ae1ce8d570a859f1a8a6040176033e833b
Author: Xavi Artigas
Date: Fri Feb 28 11:01:03 2020 +0100
doxygen: remove duplicated sections
Unified widgets simply copied elm's headers, duplicating doxygen sections.
---
src/lib/elementary/efl_ui_calendar_private.h | 15 ---
src/lib/elementary/efl_ui_panel_private.h| 15 ---
2 files changed, 30 deletions(-)
diff --git a/src/lib/elementary/efl_ui_calendar_private.h
b/src/lib/elementary/efl_ui_calendar_private.h
index 3d80b89305..9ee17465e3 100644
--- a/src/lib/elementary/efl_ui_calendar_private.h
+++ b/src/lib/elementary/efl_ui_calendar_private.h
@@ -9,17 +9,6 @@
* IT AT RUNTIME.
*/
-/**
- * @addtogroup Widget
- * @{
- *
- * @section elm-calendar-class The Elementary Calendar Class
- *
- * Elementary, besides having the @ref Calendar widget, exposes its
- * foundation -- the Elementary Calendar Class -- in order to create other
- * widgets which are a calendar with some more logic on top.
- */
-
/**
* Base layout smart data extended with calendar instance data.
*/
@@ -47,10 +36,6 @@ struct _Efl_Ui_Calendar_Data
Eina_Boolweekdays_set : 1;
};
-/**
- * @}
- */
-
#define EFL_UI_CALENDAR_DATA_GET(o, sd) \
Efl_Ui_Calendar_Data * sd = efl_data_scope_get(o, EFL_UI_CALENDAR_CLASS)
diff --git a/src/lib/elementary/efl_ui_panel_private.h
b/src/lib/elementary/efl_ui_panel_private.h
index f1c3b93ae5..0e844181a1 100644
--- a/src/lib/elementary/efl_ui_panel_private.h
+++ b/src/lib/elementary/efl_ui_panel_private.h
@@ -11,17 +11,6 @@
* IT AT RUNTIME.
*/
-/**
- * @addtogroup Widget
- * @{
- *
- * @section elm-panel-class The Elementary Panel Class
- *
- * Elementary, besides having the @ref Panel widget, exposes its
- * foundation -- the Elementary Panel Class -- in order to create other
- * widgets which are a panel with some more logic on top.
- */
-
/**
* Base layout smart data extended with panel instance data.
*/
@@ -50,10 +39,6 @@ struct _Efl_Ui_Panel_Data
Eina_Bool callback_added: 1;
};
-/**
- * @}
- */
-
#define EFL_UI_PANEL_DATA_GET(o, sd) \
Efl_Ui_Panel_Data * sd = efl_data_scope_get(o, EFL_UI_PANEL_CLASS)
--
[EGIT] [core/efl] master 09/11: doxygen: fix invalid anchor names
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=dd7a6c511277e08106e7d88f465b748d6165a61f commit dd7a6c511277e08106e7d88f465b748d6165a61f Author: Xavi Artigas Date: Fri Feb 28 12:07:45 2020 +0100 doxygen: fix invalid anchor names --- src/lib/evas/Evas_GL.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/lib/evas/Evas_GL.h b/src/lib/evas/Evas_GL.h index d06e88a053..0a96f7e13c 100644 --- a/src/lib/evas/Evas_GL.h +++ b/src/lib/evas/Evas_GL.h @@ -5990,7 +5990,7 @@ EvasGLImage *img = glapi->evasglCreateImageForContext void (*glWaitSync) (GLsync sync, GLbitfield flags, uint64_t timeout); /** @} */ /** -* @anchor gles3.1 +* @anchor gles3_1 * @name OpenGL-ES 3.1. * * Evas_GL_API version 5. @@ -6070,7 +6070,7 @@ EvasGLImage *img = glapi->evasglCreateImageForContext /** @} */ /** -* @anchor gles3.2 +* @anchor gles3_2 * @name OpenGL-ES 3.2. * * Evas_GL_API version 6. --
[EGIT] [core/efl] master 05/11: doxygen: fix duplicated toc sections
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=9f4b5458ea3e5824faa9ba73920c5d04b060b265
commit 9f4b5458ea3e5824faa9ba73920c5d04b060b265
Author: Xavi Artigas
Date: Fri Feb 28 11:01:56 2020 +0100
doxygen: fix duplicated toc sections
---
src/lib/ecore/Ecore.h | 2 +-
src/lib/ector/Ector.h | 2 +-
src/lib/edje/Edje.h | 2 +-
src/lib/eet/Eet.h | 2 +-
src/lib/eeze/Eeze.h | 2 +-
src/lib/efreet/Efreet.h | 2 +-
src/lib/eina/Eina.h | 2 +-
src/lib/eio/Eio_Legacy.h| 2 +-
src/lib/eldbus/Eldbus.h | 2 +-
src/lib/embryo/Embryo.h | 2 +-
src/lib/emotion/Emotion.h | 2 +-
src/lib/eo/Eo.h | 2 +-
src/lib/eolian/Eolian.h | 2 +-
src/lib/eolian/Eolian_Aux.h | 2 +-
src/lib/ephysics/EPhysics.h | 2 +-
src/lib/ethumb/Ethumb.h | 2 +-
src/lib/evas/Evas.h | 2 +-
src/lib/evas/Evas_Eo.h | 2 +-
src/lib/evil/evil_main.h| 2 +-
19 files changed, 19 insertions(+), 19 deletions(-)
diff --git a/src/lib/ecore/Ecore.h b/src/lib/ecore/Ecore.h
index 7818faf907..cd401617fa 100644
--- a/src/lib/ecore/Ecore.h
+++ b/src/lib/ecore/Ecore.h
@@ -6,7 +6,7 @@
/**
* @page ecore_main Ecore
* @date 2000 (created)
- * @section toc Table of Contents
+ * @section ecore_toc Table of Contents
* @li @ref ecore_main_intro
* @li @ref ecore_main_compiling
* @li @ref ecore_main_next_steps
diff --git a/src/lib/ector/Ector.h b/src/lib/ector/Ector.h
index 961a42c150..9a7a7d3706 100644
--- a/src/lib/ector/Ector.h
+++ b/src/lib/ector/Ector.h
@@ -41,7 +41,7 @@ extern "C" {
*
* @date 2014 (created)
*
- * @section toc Table of Contents
+ * @section ector_toc Table of Contents
*
* @li @ref ector_main_intro
* @li @ref ector_main_compiling
diff --git a/src/lib/edje/Edje.h b/src/lib/edje/Edje.h
index d8c32dc8c1..65ff5342e4 100644
--- a/src/lib/edje/Edje.h
+++ b/src/lib/edje/Edje.h
@@ -7,7 +7,7 @@ These routines are used for Edje.
@date 2003 (created)
-@section toc Table of Contents
+@section edje_toc Table of Contents
@li @ref edje_main_intro
@li @ref edje_main_work
diff --git a/src/lib/eet/Eet.h b/src/lib/eet/Eet.h
index eb7cb5324f..0d1c0021f8 100644
--- a/src/lib/eet/Eet.h
+++ b/src/lib/eet/Eet.h
@@ -7,7 +7,7 @@
@date 2000 (created)
- @section toc Table of Contents
+ @section eet_toc Table of Contents
@li @ref eet_main_intro
@li @ref eet_main_compiling
diff --git a/src/lib/eeze/Eeze.h b/src/lib/eeze/Eeze.h
index f5dab4230d..d6807262a6 100644
--- a/src/lib/eeze/Eeze.h
+++ b/src/lib/eeze/Eeze.h
@@ -6,7 +6,7 @@
@date 2010 (created)
- @section toc Table of Contents
+ @section eeze_toc Table of Contents
@li @ref eeze_main_intro
@li @ref eeze_main_compiling
diff --git a/src/lib/efreet/Efreet.h b/src/lib/efreet/Efreet.h
index 22d2291f44..51fbfebf6f 100644
--- a/src/lib/efreet/Efreet.h
+++ b/src/lib/efreet/Efreet.h
@@ -11,7 +11,7 @@
/**
* @page efreet_main Efreet
*
- * @section toc Table of Contents
+ * @section efreet_toc Table of Contents
*
* @li @ref efreet_main_intro
* @li @ref efreet_main_compiling
diff --git a/src/lib/eina/Eina.h b/src/lib/eina/Eina.h
index 9e3345e432..d2f5d4543d 100644
--- a/src/lib/eina/Eina.h
+++ b/src/lib/eina/Eina.h
@@ -48,7 +48,7 @@
*
* @date 2008 (created)
*
- * @section toc Table of Contents
+ * @section eina_toc Table of Contents
*
* @li @ref eina_main_intro
* @li @ref eina_main_compiling
diff --git a/src/lib/eio/Eio_Legacy.h b/src/lib/eio/Eio_Legacy.h
index c44340cac0..90c1263856 100644
--- a/src/lib/eio/Eio_Legacy.h
+++ b/src/lib/eio/Eio_Legacy.h
@@ -28,7 +28,7 @@ extern "C" {
*
* @date 2012 (created)
*
- * @section toc Table of Contents
+ * @section eio_toc Table of Contents
*
* @li @ref eio_main_intro
* @li @ref eio_main_compiling
diff --git a/src/lib/eldbus/Eldbus.h b/src/lib/eldbus/Eldbus.h
index 18c3de5d1b..808084231e 100644
--- a/src/lib/eldbus/Eldbus.h
+++ b/src/lib/eldbus/Eldbus.h
@@ -3,7 +3,7 @@
*
* @date 2012 (created)
*
- * @section toc Table of Contents
+ * @section eldbus_toc Table of Contents
*
* @li @ref eldbus_main_intro
* @li @ref eldbus_main_compiling
diff --git a/src/lib/embryo/Embryo.h b/src/lib/embryo/Embryo.h
index 51d626b362..21177bddfc 100644
--- a/src/lib/embryo/Embryo.h
+++ b/src/lib/embryo/Embryo.h
@@ -8,7 +8,7 @@ These routines are used for Embryo.
@date 2004 (created)
@note based on Compuphase (http://www.compuphase.com) PAWN language.
-@section toc Table of Contents
+@section embryo_toc Table of Contents
@li @ref embryo_main_intro
@li @ref embryo_main_compiling
diff --git a/src/lib/emotion/Emotion.h b/src/lib/emotion/Emotion.h
index e67d9a2026..cb566d0a6a 100644
--- a/src/lib/emotion/Emotion.h
+++ b/src/lib/emotion/Emotion.h
@@ -14,7 +14,7 @@
*
* @date 2003 (created)
*
- * @section toc Table of Contents
+ * @section emotion_toc Table of Contents
*
* @li @ref emotion_main_intro
* @li @ref em
[EGIT] [core/efl] master 11/11: docs: Give some doc love to Evas_Object_Vg
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=84a34d2ef62832a8cddff9911821aeca71150721 commit 84a34d2ef62832a8cddff9911821aeca71150721 Author: Xavi Artigas Date: Fri Feb 28 12:36:57 2020 +0100 docs: Give some doc love to Evas_Object_Vg --- src/lib/evas/Evas_Legacy.h | 34 -- 1 file changed, 16 insertions(+), 18 deletions(-) diff --git a/src/lib/evas/Evas_Legacy.h b/src/lib/evas/Evas_Legacy.h index 8a4f3245f4..387db2748b 100644 --- a/src/lib/evas/Evas_Legacy.h +++ b/src/lib/evas/Evas_Legacy.h @@ -3534,31 +3534,29 @@ EAPI Evas_Object *evas_object_rectangle_add(Evas *e) EINA_WARN_UNUSED_RESULT EIN * @defgroup Evas_Object_Vg Vector Graphics Object * @ingroup Evas * - * Evas_Object_Vg is the scene graph for managing vector graphics objects. - * User can create shape objects as well as fill objects and give it to the + * Evas_Object_Vg is the scene graph for managing vector graphics objects. + * User can create shape objects as well as fill objects and give them to the * Evas_Object_Vg for drawing on the screen as well as managing the lifecycle - * of the objects. enabling reuse of shape objects. + * of the objects, enabling reuse of shape objects. * - * As Evas_Object_Vg is a Evas_Object all the operation that applicable to - * a Evas_Object can be performed on it(clipping , map, etc). + * Since Evas_Object_Vg is an Evas_Object all operations applicable to + * an Evas_Object can be performed on it (clipping, mapping, etc). * - * To create any complex vector graphics you can create a hirarchy of shape - * and fill objects and give the hirarchy to Evas_Object which will be + * To create complex vector graphics you can create a hierarchy of shape + * and fill objects and give the hierarchy to Evas_Object which will be * responsible for drawing and showing on the screen. * - * As the shape object and fill object (linear and radial gradient) have + * As the shape object and fill object (linear and radial gradients) have * retain mode API, you only have to create it once and set the properties - * and give it to evas_object_vg. + * and give it to Evas_Object_Vg. * - * Any change in the property of shape/fill object will automaticaly notified - * to the evas_object_vg which will trigger a redrawing to reflect the change. + * Any change in the properties of a shape or fill object are automatically + * notified to Evas_Object_Vg triggering a redraw to reflect the changes. * - * To create a vector path, you can give list of path commands to the shape + * To create a vector path, you can give a list of path commands to the shape * object using efl_gfx_shape_path_set() API. * - * Enabling graphical shapes to be constructed and reused. - * - * Below are the list of feature currently supported by Vector object. + * Below are the list of features currently supported by Vector object. * * @li Drawing SVG Path. * You can construct a path by using api in efl_gfx_utils.h @@ -3568,11 +3566,11 @@ EAPI Evas_Object *evas_object_rectangle_add(Evas *e) EINA_WARN_UNUSED_RESULT EIN * @see Evas_Vg_Gradient_Linear and Evas_Vg_Gradient_Radial * * @li Transformation support for path and gradient fill. You can apply - affin transformation on path object. + affine transforms to path objects. * @see Eina_Matrix. * - * @note Below are the list of interface, classes can be used to draw vector - * graphics using vector object. + * @note Below are the list of interfaces and classes that can be used + * to draw vector graphics using vector objects. * * @li Efl.Gfx.Shape * @li Evas.VG_Shape --
[EGIT] [core/efl] master 10/11: doxygen: fix missing @p tag
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=00ca49422b78e5899c623c3827d4d75682933242 commit 00ca49422b78e5899c623c3827d4d75682933242 Author: Xavi Artigas Date: Fri Feb 28 12:08:51 2020 +0100 doxygen: fix missing @p tag --- src/lib/evil/evil_locale.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/lib/evil/evil_locale.h b/src/lib/evil/evil_locale.h index 4bf14ec499..6b12428428 100644 --- a/src/lib/evil/evil_locale.h +++ b/src/lib/evil/evil_locale.h @@ -39,7 +39,7 @@ * setlocale() function. If @p category is #LC_MESSAGES, then if @p locale * is not @c NULL, errno is set to EINVAL and @c NULL is returned, otherwise * the string _ is returned. This string is a static buffer - * and must not be freed. It will also be rewritten each time @category is + * and must not be freed. It will also be rewritten each time @p category is * #LC_MESSAGES and @p locale is @c NULL. * * Conformity: Non applicable. --
[EGIT] [core/efl] master 07/11: doxygen: fix missing titles in addgroup
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=0a70c70c0c6b07ac5232397d648cd1d06e5d42a2
commit 0a70c70c0c6b07ac5232397d648cd1d06e5d42a2
Author: Xavi Artigas
Date: Fri Feb 28 11:43:52 2020 +0100
doxygen: fix missing titles in addgroup
---
src/lib/elementary/efl_ui_clock.h | 2 +-
src/lib/elementary/elm_code_line.h | 4 ++--
src/lib/elput/Elput.h | 2 +-
src/lib/evas/Evas_Legacy.h | 2 +-
4 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/src/lib/elementary/efl_ui_clock.h
b/src/lib/elementary/efl_ui_clock.h
index c883db2eee..b5352a8b52 100644
--- a/src/lib/elementary/efl_ui_clock.h
+++ b/src/lib/elementary/efl_ui_clock.h
@@ -1,5 +1,5 @@
/**
- * @defgroup efl_ui_clock
+ * @defgroup efl_ui_clock EFL Ui Clock Widget
* @ingroup Elementary
*
* @image html clock_inheritance_tree.png
diff --git a/src/lib/elementary/elm_code_line.h
b/src/lib/elementary/elm_code_line.h
index 8e832ff5ed..3703a4a4d8 100644
--- a/src/lib/elementary/elm_code_line.h
+++ b/src/lib/elementary/elm_code_line.h
@@ -40,7 +40,7 @@ EAPI void elm_code_line_free(Elm_Code_Line *line);
/**
* @brief Line manipulation functions.
- * @defgroup Content
+ * @defgroup Content Elementary Code Line
* @{
*
* Functions for changing the content of lines in an Elm_Code_File
@@ -87,7 +87,7 @@ EAPI void elm_code_line_merge_down(Elm_Code_Line *line);
* @}
*
* @brief Line markup functions.
- * @defgroup Highlighting
+ * @defgroup Highlighting Elementary Code Highlighting
*
* @{
*
diff --git a/src/lib/elput/Elput.h b/src/lib/elput/Elput.h
index 14a706949d..cc0570e8cc 100644
--- a/src/lib/elput/Elput.h
+++ b/src/lib/elput/Elput.h
@@ -183,7 +183,7 @@ EAPI int elput_init(void);
EAPI int elput_shutdown(void);
/**
- * @defgroup Elput_Manager_Group
+ * @defgroup Elput_Manager_Group Elput Manager
*
* Functions that deal with connecting, disconnecting, opening, closing
* of input devices.
diff --git a/src/lib/evas/Evas_Legacy.h b/src/lib/evas/Evas_Legacy.h
index ff92ad8bbe..8a4f3245f4 100644
--- a/src/lib/evas/Evas_Legacy.h
+++ b/src/lib/evas/Evas_Legacy.h
@@ -3531,7 +3531,7 @@ EAPI Evas_Object *evas_object_rectangle_add(Evas *e)
EINA_WARN_UNUSED_RESULT EIN
*/
/**
- * @defgroup Evas_Object_Vg
+ * @defgroup Evas_Object_Vg Vector Graphics Object
* @ingroup Evas
*
* Evas_Object_Vg is the scene graph for managing vector graphics objects.
--
[EGIT] [core/efl] master 08/11: doxygen: fix missing endcond tag
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=9c24c05458a0b9f4aca8897d1608b6fc6a7ab465 commit 9c24c05458a0b9f4aca8897d1608b6fc6a7ab465 Author: Xavi Artigas Date: Fri Feb 28 12:05:26 2020 +0100 doxygen: fix missing endcond tag --- src/lib/emile/emile_base64.c | 4 1 file changed, 4 insertions(+) diff --git a/src/lib/emile/emile_base64.c b/src/lib/emile/emile_base64.c index 2f041fec04..7ff1c130b0 100644 --- a/src/lib/emile/emile_base64.c +++ b/src/lib/emile/emile_base64.c @@ -170,6 +170,10 @@ emile_base64_decode_common(const Eina_Strbuf *in, Eina_Bool is_base64url_decode) return eina_binbuf_manage_new(dest, l, EINA_FALSE); } +/** + * @endcond + */ + /** * Global * **/ --
[EGIT] [core/efl] master 02/11: doxygen: fix missing end group tag
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=ddbe32f2eb5ddae536676e454f7ea95a3885ae6e
commit ddbe32f2eb5ddae536676e454f7ea95a3885ae6e
Author: Xavi Artigas
Date: Fri Feb 28 10:53:49 2020 +0100
doxygen: fix missing end group tag
---
src/lib/ecore_con/ecore_con_url.c | 5 +
src/lib/elua/Elua.h | 4
src/lib/eo/Eo.h | 4
3 files changed, 13 insertions(+)
diff --git a/src/lib/ecore_con/ecore_con_url.c
b/src/lib/ecore_con/ecore_con_url.c
index c92af111c9..ec1e5b1a0c 100644
--- a/src/lib/ecore_con/ecore_con_url.c
+++ b/src/lib/ecore_con/ecore_con_url.c
@@ -1419,3 +1419,8 @@ ecore_con_url_verbose_set(Ecore_Con_Url *url_con,
}
_c->curl_easy_setopt(curl_easy, CURLOPT_VERBOSE, (long)url_con->verbose);
}
+
+/**
+ * @}
+ */
+
diff --git a/src/lib/elua/Elua.h b/src/lib/elua/Elua.h
index d43fcc827c..289f9112d7 100644
--- a/src/lib/elua/Elua.h
+++ b/src/lib/elua/Elua.h
@@ -456,6 +456,10 @@ EAPI Eina_Bool elua_util_script_run(Elua_State *es, int
argc, char **argv,
*/
EAPI int elua_util_error_report(const Elua_State *es, int status);
+/**
+ * @}
+ */
+
#endif
#ifdef __cplusplus
diff --git a/src/lib/eo/Eo.h b/src/lib/eo/Eo.h
index 178372efed..4bf91bb3d5 100644
--- a/src/lib/eo/Eo.h
+++ b/src/lib/eo/Eo.h
@@ -2161,6 +2161,10 @@ typedef void (*efl_key_data_free_func)(void *);
*/
#define efl_wref_del_safe(wref) efl_weak_unref(wref)
+/**
+ * @}
+ */
+
/**
* @addtogroup Efl_Events Eo's Event Handling
* @{
--
[EGIT] [core/efl] master 06/11: doxygen: fix invalid eolian_main_intro ref
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=f8a23b1fcf4a6e955486b9a9fa7ca33ae533e780
commit f8a23b1fcf4a6e955486b9a9fa7ca33ae533e780
Author: Xavi Artigas
Date: Fri Feb 28 11:39:23 2020 +0100
doxygen: fix invalid eolian_main_intro ref
---
src/lib/eolian/Eolian_Aux.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/lib/eolian/Eolian_Aux.h b/src/lib/eolian/Eolian_Aux.h
index dab9e8644b..b98759ef8f 100644
--- a/src/lib/eolian/Eolian_Aux.h
+++ b/src/lib/eolian/Eolian_Aux.h
@@ -42,7 +42,7 @@ extern "C" {
*
* @li @ref eolian_aux_main_intro
*
- * @section eolian_main_intro Introduction
+ * @section eolian_aux_main_intro Introduction
*
* This is the Eolian auxiliary library, providing API to support generators
* and other utilities which do not fit into the primary Eolian library. All
--
[EGIT] [core/efl] master 04/11: doxygen: remove deprecated (and unused) configuration
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=4c10f403bb2656d353e1144ab8e5f2f5411b73c8 commit 4c10f403bb2656d353e1144ab8e5f2f5411b73c8 Author: Xavi Artigas Date: Fri Feb 28 11:01:37 2020 +0100 doxygen: remove deprecated (and unused) configuration --- doc/Doxyfile.in | 12 1 file changed, 12 deletions(-) diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index db4e63cdb2..0a62bfdec7 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -1325,18 +1325,6 @@ GENERATE_XML = NO XML_OUTPUT = xml -# The XML_SCHEMA tag can be used to specify an XML schema, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_SCHEMA = - -# The XML_DTD tag can be used to specify an XML DTD, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_DTD= - # If the XML_PROGRAMLISTING tag is set to YES Doxygen will # dump the program listings (including syntax highlighting # and cross-referencing information) to the XML output. Note that --
[EGIT] [core/efl] master 01/11: doxygen: fix duplicated intro sections
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=6a5c2f9c20011c312760e225a9db4a4f79f7fa1e
commit 6a5c2f9c20011c312760e225a9db4a4f79f7fa1e
Author: Xavi Artigas
Date: Fri Feb 28 10:52:59 2020 +0100
doxygen: fix duplicated intro sections
---
elm_intro.h.in| 2 +-
src/lib/ecore_imf/Ecore_IMF.h | 2 +-
src/lib/edje/edje_lua2.c | 2 +-
src/lib/elua/Elua.h | 4 ++--
4 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/elm_intro.h.in b/elm_intro.h.in
index cf489dbe05..95bdb577f0 100644
--- a/elm_intro.h.in
+++ b/elm_intro.h.in
@@ -4,7 +4,7 @@
* @version @VMAJ@.@VMIN@.@VMIC@
* @date 2008-2014
*
- * @section intro What is Elementary?
+ * @section elm_intro What is Elementary?
*
* This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
* applications (yet). Small simple ones with simple needs.
diff --git a/src/lib/ecore_imf/Ecore_IMF.h b/src/lib/ecore_imf/Ecore_IMF.h
index 4cfb488e56..70b4bc85eb 100644
--- a/src/lib/ecore_imf/Ecore_IMF.h
+++ b/src/lib/ecore_imf/Ecore_IMF.h
@@ -47,7 +47,7 @@ extern "C" {
* @defgroup Ecore_IMF_Context_Group Ecore Input Method Context Functions
* @ingroup Ecore_IMF_Lib_Group
*
- * @section intro Introduction
+ * @section ecore_imf_intro Introduction
*
* Functions that operate on Ecore Input Method Context objects.
diff --git a/src/lib/edje/edje_lua2.c b/src/lib/edje/edje_lua2.c
index b204736439..6032528815 100644
--- a/src/lib/edje/edje_lua2.c
+++ b/src/lib/edje/edje_lua2.c
@@ -18,7 +18,7 @@
/**
@page luaref Edje Lua scripting
- @section intro Introduction
+ @section edje_lua_intro Introduction
Lua is intended for script-only objects at this point (with embryo left
for augmenting standard programs). Since script-only objects effectively
diff --git a/src/lib/elua/Elua.h b/src/lib/elua/Elua.h
index 2d13df5c77..d43fcc827c 100644
--- a/src/lib/elua/Elua.h
+++ b/src/lib/elua/Elua.h
@@ -7,7 +7,7 @@
/**
*
- * @section intro Elua library
+ * @section elua_intro Elua library
*
* The Elua library was created to ease integration of EFL Lua into other EFL
* libraries or applications. Using the Elua library you can easily create a
@@ -53,7 +53,7 @@ extern "C" {
*
* @date 2015 (created)
*
- * @section toc Table of Contents
+ * @section elua_toc Table of Contents
*
* @li @ref elua_main_intro
* @li @ref elua_main_compiling
--
[EGIT] [core/efl] master 01/01: Efl.Ui.Image: Add fallback when icon is not found in default theme
zmike pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=697308a16f77e3e7b7dac6e74293850a3950e3d3
commit 697308a16f77e3e7b7dac6e74293850a3950e3d3
Author: Xavi Artigas
Date: Mon Feb 24 09:02:30 2020 -0500
Efl.Ui.Image: Add fallback when icon is not found in default theme
Summary:
If _icon_standard_set() fails, _icon_freedesktop_set() is tried.
This was causing missing icons in the homescreen example, which uses
application icons which are obviously not present in the default theme.
Thanks to @bu5hm4n!
Test Plan: The homescreen sample application from the examples repository
now correctly shows all missing icons.
Reviewers: bu5hm4n, zmike
Reviewed By: zmike
Subscribers: cedric, #reviewers, #committers, bu5hm4n
Tags: #efl
Differential Revision: https://phab.enlightenment.org/D11381
---
src/lib/elementary/efl_ui_image.c | 5 +
1 file changed, 5 insertions(+)
diff --git a/src/lib/elementary/efl_ui_image.c
b/src/lib/elementary/efl_ui_image.c
index a13f7047fd..578dd5aa52 100644
--- a/src/lib/elementary/efl_ui_image.c
+++ b/src/lib/elementary/efl_ui_image.c
@@ -2151,6 +2151,11 @@ _internal_efl_ui_image_icon_set(Evas_Object *obj, const
char *name, Eina_Bool *f
{
ret = _icon_standard_set(obj, name);
if (ret && fdo) *fdo = EINA_FALSE;
+if (!ret)
+ {
+ ret = _icon_freedesktop_set(obj, name, _icon_size_min_get(obj));
+ if (ret && fdo) *fdo = EINA_TRUE;
+ }
}
else
{
--
[EGIT] [tools/examples] master 01/02: mono-examples: Adapt to latest syntax
xartigas pushed a commit to branch master.
http://git.enlightenment.org/tools/examples.git/commit/?id=5f1be675ee1b75c8059c78437522cdee1cbde085
commit 5f1be675ee1b75c8059c78437522cdee1cbde085
Author: Xavi Artigas
Date: Thu Feb 20 17:09:22 2020 +0100
mono-examples: Adapt to latest syntax
Setter and Getters have disappeared. Now everything is accessed through
properties like:
Text, Disabled, Autohide, Color, Orientation, ContentPadding, Size,
ScrollableText, Align, Name.
Also the Life and Containers examples had several issues.
Text override from custom widgets is still not solved.
---
apps/csharp/calculator/src/calculator.cs | 18 +-
apps/csharp/life/src/life_main.cs | 12 +++
apps/csharp/life/src/life_render.cs| 12 +++
apps/csharp/mvvm-example/src/mvvm_basic.cs | 6 ++--
apps/csharp/texteditor/src/texteditor_main.cs | 30
reference/csharp/core/src/core_event.cs| 8 ++---
reference/csharp/snippets/Efl.Ui.Bg.cs | 2 +-
reference/csharp/snippets/Efl.Ui.Button.cs | 4 +--
reference/csharp/snippets/Efl.Ui.Check.cs | 2 +-
reference/csharp/snippets/Efl.Ui.Popup.cs | 2 +-
reference/csharp/snippets/Efl.Ui.RadioBox.cs | 2 +-
reference/csharp/snippets/Efl.Ui.Scroller.cs | 2 +-
reference/csharp/snippets/Efl.Ui.SpinButton.cs | 2 +-
reference/csharp/snippets/Efl.Ui.Win.cs| 4 +--
reference/csharp/ui/src/focus_main.cs | 24 ++---
reference/csharp/ui/src/ui_container.cs| 34 +-
reference/csharp/ui/src/ui_custom_widget.cs| 16 +
reference/csharp/ui/src/ui_sizing.cs | 14
tutorial/csharp/eo-intro/src/eo_intro_main.cs | 6 ++--
tutorial/csharp/hello-gui/src/gui_main.cs | 18 +-
tutorial/csharp/hello-world/src/hello-world.cs | 6 ++--
unsorted/elementary/efl_ui_slider_mono.cs | 14
unsorted/elementary/efl_ui_unit_converter.cs | 48 +-
unsorted/evas/evas_mono_box.cs | 10 +++---
unsorted/evas/evas_mono_image.cs | 6 ++--
unsorted/evas/evas_mono_image2.cs | 10 +++---
unsorted/evas/evas_mono_rectangle.cs | 4 +--
unsorted/evas/evas_mono_table.cs | 14
unsorted/evas/evas_mono_text.cs| 12 +++
29 files changed, 172 insertions(+), 170 deletions(-)
diff --git a/apps/csharp/calculator/src/calculator.cs
b/apps/csharp/calculator/src/calculator.cs
index 725dacd1..704cb126 100644
--- a/apps/csharp/calculator/src/calculator.cs
+++ b/apps/csharp/calculator/src/calculator.cs
@@ -48,10 +48,10 @@ public class Calculator : Efl.Csharp.Application
{
if (mustOverwrite)
{
- screen.SetText("");
+ screen.Text = "";
mustOverwrite = false;
}
- screen.SetText(screen.GetText() + button.ToString());
+ screen.Text = screen.Text + button.ToString();
}
else
{
@@ -59,7 +59,7 @@ public class Calculator : Efl.Csharp.Application
{
case 'C':
// Clear current input
- screen.SetText("0");
+ screen.Text = "0";
break;
case '+':
case '-':
@@ -70,7 +70,7 @@ public class Calculator : Efl.Csharp.Application
if (operation != '=')
{
Operate();
-screen.SetText(currValue.ToString());
+screen.Text = currValue.ToString();
}
// Store this operation
operation = button;
@@ -90,7 +90,7 @@ public class Calculator : Efl.Csharp.Application
private void ScreenChangedCb(object sender, EventArgs ea)
{
string text = "";
- string str = screen.GetText();
+ string str = screen.Text;
int d;
if (str == "" || str == "-")
{
@@ -106,7 +106,7 @@ public class Calculator : Efl.Csharp.Application
}
catch {}
}
- if (text != str) screen.SetText(text);
+ if (text != str) screen.Text = text;
}
// Creates an Efl.Ui.Button and positions it in the given position inside
the table
@@ -128,7 +128,7 @@ public class Calculator : Efl.Csharp.Application
label.TextHorizontalAlign = 0.5;
label.TextVerticalAlign = 0.5;
label.Color = (r, g, b, 255);
- label.SetText(text);
+ label.Text = text;
label.FontFamily = "Sans";
label.FontSize = 36;
button.Content = label;
@@ -139,7 +139,7 @@ public class Calculator : Efl.Csharp.Application
{
// The window
var win = new Efl.Ui.Win(Efl.App.App
[EGIT] [tools/examples] master 02/02: mono calculator: fix font size of main screen
xartigas pushed a commit to branch master. http://git.enlightenment.org/tools/examples.git/commit/?id=f835d4562212c3eba9025a74845128d451fc commit f835d4562212c3eba9025a74845128d451fc Author: Xavi Artigas Date: Thu Feb 20 18:57:35 2020 +0100 mono calculator: fix font size of main screen Apparently setting editable=false resets the font size. While we investigate that, this is a workaround. --- apps/csharp/calculator/src/calculator.cs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/apps/csharp/calculator/src/calculator.cs b/apps/csharp/calculator/src/calculator.cs index 704cb126..c25cf37b 100644 --- a/apps/csharp/calculator/src/calculator.cs +++ b/apps/csharp/calculator/src/calculator.cs @@ -170,17 +170,17 @@ public class Calculator : Efl.Csharp.Application // Create a big Efl.Ui.Text screen to display the current input screen = new Efl.Ui.Textbox(table); screen.Text = "0"; - screen.FontFamily = "Sans"; - screen.FontSize = 48; screen.Multiline = false; screen.Editable = false; screen.SelectionAllowed = false; - table.PackTable(screen, 0, 0, 4, 1); screen.TextHorizontalAlign = 0.9; screen.TextVerticalAlign = 0.5; screen.TextEffectType = Efl.TextStyleEffectType.Glow; screen.TextGlowColor = (128, 128, 128, 128); + screen.FontFamily = "Sans"; + screen.FontSize = 48; screen.ChangedEvent += ScreenChangedCb; + table.PackTable(screen, 0, 0, 4, 1); } } --
[EGIT] [core/efl] master 01/01: Efl.Ui.Spotlight: Fix indicator initialization
xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=c5dc774fc564539f0d8b5791b2ed4925162706cf
commit c5dc774fc564539f0d8b5791b2ed4925162706cf
Author: Xavi Artigas
Date: Thu Feb 20 09:59:29 2020 +0100
Efl.Ui.Spotlight: Fix indicator initialization
This caused incorrectly-centered indicator icons in the homescreen example.
---
src/lib/elementary/efl_ui_spotlight_icon_indicator.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/lib/elementary/efl_ui_spotlight_icon_indicator.c
b/src/lib/elementary/efl_ui_spotlight_icon_indicator.c
index 731a9a9429..a4aa12ce25 100644
--- a/src/lib/elementary/efl_ui_spotlight_icon_indicator.c
+++ b/src/lib/elementary/efl_ui_spotlight_icon_indicator.c
@@ -96,8 +96,8 @@
_efl_ui_spotlight_icon_indicator_efl_ui_spotlight_indicator_bind(Eo *obj, Efl_Ui
if (spotlight)
{
pd->container = spotlight;
-efl_event_callback_array_add(pd->container, spotlight_resized(),
pd->layout);
pd->layout = efl_add(EFL_CANVAS_LAYOUT_CLASS, pd->container);
+efl_event_callback_array_add(pd->container, spotlight_resized(),
pd->layout);
if (elm_widget_theme_object_set(pd->container, pd->layout,
"spotlight",
--
[EGIT] [core/efl] master 04/04: docs: A bit more info and formatting for Eina_Process_Cb
bu5hm4n pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=c2738b4ed9d0361049c3f83dbdd050f750ad7b72 commit c2738b4ed9d0361049c3f83dbdd050f750ad7b72 Author: Xavi Artigas Date: Fri Jan 10 16:35:37 2020 + docs: A bit more info and formatting for Eina_Process_Cb Reviewed-by: Marcel Hollerbach Differential Revision: https://phab.enlightenment.org/D11063 --- src/lib/eina/eina_iterator.h | 2 +- src/lib/eina/eina_types.h| 6 +- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/src/lib/eina/eina_iterator.h b/src/lib/eina/eina_iterator.h index 21194d59c3..4f05bda5b9 100644 --- a/src/lib/eina/eina_iterator.h +++ b/src/lib/eina/eina_iterator.h @@ -377,7 +377,7 @@ EAPI Eina_Iterator *eina_multi_iterator_internal_new(Eina_Iterator *it, ...) EIN * * Processes every node in the input iterator and returns a new iterator containing * the processed nodes. This is akin to a Map function: - * @see https://en.wikipedia.org/wiki/Map_(higher-order_function) + * https://en.wikipedia.org/wiki/Map_(higher-order_function) * * @since 1.24 */ diff --git a/src/lib/eina/eina_types.h b/src/lib/eina/eina_types.h index ad797d3d91..7c5ef004eb 100644 --- a/src/lib/eina/eina_types.h +++ b/src/lib/eina/eina_types.h @@ -542,7 +542,11 @@ typedef int (*Eina_Random_Cb)(const int min, const int max); /** * @typedef Eina_Process_Cb * Method that processes some data and returns new data. - * It's meant to be used as a callback to process all nodes inside a container (See eina_iterator_processed_new, for example.) + * It's meant to be used as a callback to process all nodes inside a container + * (See eina_iterator_processed_new, for example.) + * @param data The data to process. + * @param fdata Context data. + * @return The processed data. */ typedef void* (*Eina_Process_Cb)(const void *container, void *data, void *fdata); --
[EGIT] [core/efl] master 01/01: mono: Add "out" as a reserved word
xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=cf02feb9babf8a7b6765fb0d975da1f199bdee11 commit cf02feb9babf8a7b6765fb0d975da1f199bdee11 Author: Xavi Artigas Date: Mon Feb 17 12:35:00 2020 +0100 mono: Add "out" as a reserved word This will turn it into kw_out just like it is done for "in". Otherwise it cannot be used as a parameter name, for example. --- src/bin/eolian_mono/eolian/mono/name_helpers.hh | 1 + 1 file changed, 1 insertion(+) diff --git a/src/bin/eolian_mono/eolian/mono/name_helpers.hh b/src/bin/eolian_mono/eolian/mono/name_helpers.hh index 1294bf01ed..bc3f278c91 100644 --- a/src/bin/eolian_mono/eolian/mono/name_helpers.hh +++ b/src/bin/eolian_mono/eolian/mono/name_helpers.hh @@ -71,6 +71,7 @@ inline std::string escape_keyword(std::string const& name) || is_equal(name, "lock") || is_equal(name, "event") || is_equal(name, "in") + || is_equal(name, "out") || is_equal(name, "object") || is_equal(name, "interface") || is_equal(name, "string") --
