summaryrefslogtreecommitdiff
path: root/src/lib/ector
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2017-09-12 16:07:13 +0900
committerJean-Philippe Andre <jp.andre@samsung.com>2017-09-12 16:07:13 +0900
commit9c78628908c8db332378a097f86174b5634a89f9 (patch)
tree6aaf0ff2c9a297fadebaad0eda81e659893d881a /src/lib/ector
parent9cf8e756686b1e339ccd2505fbcfac4f579903a6 (diff)
ector: Copyedit Ector doxygen
Summary: - Fix various spelling and grammar errors. - Add a slight bit more explanation of what Ector is. - Condense compilation directions similar to Evas. Reviewers: cedric Subscribers: jpeg Differential Revision: https://phab.enlightenment.org/D5176
Diffstat (limited to 'src/lib/ector')
-rw-r--r--src/lib/ector/Ector.h41
1 files changed, 16 insertions, 25 deletions
diff --git a/src/lib/ector/Ector.h b/src/lib/ector/Ector.h
index ba0efb7d89..b9a2ffd416 100644
--- a/src/lib/ector/Ector.h
+++ b/src/lib/ector/Ector.h
@@ -49,36 +49,27 @@ extern "C" {
49 * 49 *
50 * @section ector_main_intro Introduction 50 * @section ector_main_intro Introduction
51 * 51 *
52 * Ector is a retained mode drawing library that is designed to work 52 * Ector is a retained mode drawing library designed to work
53 * for and with an scenegraph like Evas. 53 * for and with a scenegraph such as Evas, which supports several
54 * types of rendering surface including software, cairo, and gl.
54 * 55 *
55 * @section ector_main_compiling How to compile 56 * @section ector_main_compiling How to compile the library
56 * 57 *
57 * Ector is a library your application links to. The procedure for this is 58 * Ector compiles automatically within EFL's build system, and is
58 * very simple. You simply have to compile your application with the 59 * automatically linked with other components that need it. But it can
59 * appropriate compiler flags that the @c pkg-config script outputs. For 60 * also be built and used standalone, by compiling and linking your
61 * application with the compiler flags indicated by @c pkg-config. For
60 * example: 62 * example:
61 * 63 *
62 * Compiling C or C++ files into object files:
63 *
64 * @verbatim 64 * @verbatim
65 gcc -c -o main.o main.c `pkg-config --cflags ector` 65 * gcc -c -o my_main.o my_main.c `pkg-config --cflags ector`
66 @endverbatim
67 *
68 * Linking object files into a binary executable:
69 * 66 *
70 * @verbatim 67 * gcc -o my_application my_main.o `pkg-config --libs ector`
71 gcc -o my_application main.o `pkg-config --libs ector` 68 * @endverbatim
72 @endverbatim
73 * 69 *
74 * See @ref pkgconfig 70 * See @ref pkgconfig
75 * 71 *
76 * @section ector_main_next_steps Next Steps 72 * @section ector_main_next_steps Recommended reading:
77 *
78 * After you understood what Ector is and installed it in your system
79 * you should proceed understanding the programming interface.
80 *
81 * Recommended reading:
82 * 73 *
83 * @li @ref Ector_Surface 74 * @li @ref Ector_Surface
84 * @li @ref Ector_Renderer 75 * @li @ref Ector_Renderer
@@ -110,7 +101,7 @@ typedef Eo Ector_Renderer;
110 * @typedef Ector_Colorspace 101 * @typedef Ector_Colorspace
111 * The definiton of colorspace. 102 * The definiton of colorspace.
112 */ 103 */
113 // FIXME: Enable that when we have merged Emile 104 // FIXME: Enable this when we have merged Emile
114/* typedef Evas_Colorspace Ector_Colorspace; */ 105/* typedef Evas_Colorspace Ector_Colorspace; */
115 106
116/** 107/**
@@ -131,8 +122,8 @@ typedef enum _Ector_Update_Type
131{ 122{
132 ECTOR_UPDATE_BACKGROUND = 1, /* All the previous state in that area is reset to the new updated profile */ 123 ECTOR_UPDATE_BACKGROUND = 1, /* All the previous state in that area is reset to the new updated profile */
133 ECTOR_UPDATE_EMPTY = 2, /* Pushing empty area (no visible pixels at all, no need to read this surface to render it) */ 124 ECTOR_UPDATE_EMPTY = 2, /* Pushing empty area (no visible pixels at all, no need to read this surface to render it) */
134 ECTOR_UPDATE_ALPHA = 4, /* Pushing some transparent pixels (this impact the under layer and will require to read back the surface where this surface is blitted) */ 125 ECTOR_UPDATE_ALPHA = 4, /* Pushing some transparent pixels (this impacts the under layer and will require reading back the surface where this surface is blitted) */
135 ECTOR_UPDATE_OPAQUE = 8 /* Pushing some opaque pixels (this means that their is no need to read the under layer when blitting this surface) */ 126 ECTOR_UPDATE_OPAQUE = 8 /* Pushing some opaque pixels (this means that there is no need to read the under layer when blitting this surface) */
136} Ector_Update_Type; 127} Ector_Update_Type;
137 128
138/** 129/**
@@ -159,7 +150,7 @@ EAPI int ector_shutdown(void);
159 * @return EINA_TRUE if call succeeded, EINA_FALSE if glsym was undefined or an error occurred 150 * @return EINA_TRUE if call succeeded, EINA_FALSE if glsym was undefined or an error occurred
160 * 151 *
161 * The RTLD_DEFAULT and RTLD_NEXT pseudo-handles can be passed as lib to 152 * The RTLD_DEFAULT and RTLD_NEXT pseudo-handles can be passed as lib to
162 * look up the first or next occurance of the desired symbol in the dynamic 153 * look up the first or next occurrence of the desired symbol in the dynamic
163 * library search order. 154 * library search order.
164 * 155 *
165 * @see dlsym() 156 * @see dlsym()