efl/legacy/ecore
Jérôme Pinot 59bc51be37 From: Jérôme Pinot <ngc891@gmail.com>
Subject: [E-devel] [patch] ecore doxygen doc

Here is a patch to correct some problems in ecore doxygen doc.
It fixes:

/tmp/ecore/doc/examples.dox:1173: warning: Unsupported xml/html tag
<some_num> found
/tmp/ecore/doc/examples.dox:1174: warning: Unsupported xml/html tag
<some_path> found
/tmp/ecore/doc/examples.dox:1176: warning: Unsupported xml/html tag
<some_num> found
/tmp/ecore/src/lib/ecore_con/ecore_con_ssl.c:714: warning: The
following parameters of
ecore_con_ssl_server_privkey_add(Ecore_Con_Server *svr, const char
*key_file) are not documented:
  parameter 'svr'
  /tmp/ecore/src/lib/ecore_con/Ecore_Con.h:1360: warning: The
following parameters of ecore_con_url_http_version_set(Ecore_Con_Url
*url_con, Ecore_Con_Url_Http_Version version) are not documented:
  parameter 'url_con'
  /tmp/ecore/src/lib/ecore_evas/Ecore_Evas.h:530: warning: argument
'demand_attention' of command @param is not found in the argument list
of ecore_evas_demand_attention_set(Ecore_Evas *ee, Eina_Bool demand)
/tmp/ecore/src/lib/ecore_evas/Ecore_Evas.h:530: warning: The following
parameters of ecore_evas_demand_attention_set(Ecore_Evas *ee,
Eina_Bool demand) are not documented:
  parameter 'demand'
  /tmp/ecore/src/lib/ecore_x/xcb/ecore_xcb_damage.c:129: warning:
Unsupported xml/html tag <empty> found


There are more things to fix due to API change but it's not so obvious
for me. I will first continue to check/correct trivial things in the
others efl doxygen doc.



SVN revision: 69820
2012-03-31 12:03:05 +00:00
..
doc From: Jérôme Pinot <ngc891@gmail.com> 2012-03-31 12:03:05 +00:00
m4 Ecore: fix shm_open() check (can be in libc or librt) 2012-03-25 17:25:04 +00:00
po gear up svn for release. one of many steps/things to do. 2012-03-17 04:17:29 +00:00
src From: Jérôme Pinot <ngc891@gmail.com> 2012-03-31 12:03:05 +00:00
.gitignore gitignore 2011-12-10 07:34:47 +00:00
AUTHORS From: Vikram Narayanan <vikram186@gmail.com> 2012-03-22 06:01:59 +00:00
COPYING fix COPYING to say 2011. 2011-09-05 07:15:41 +00:00
ChangeLog * Fix range of issues with ecore_fb and even ecore_evas where 2012-03-29 05:57:41 +00:00
INSTALL and now ecore is 1.0.0 ready too. 2010-08-16 08:17:24 +00:00
Makefile.am Ecore: fix shm_open() check (can be in libc or librt) 2012-03-25 17:25:04 +00:00
NEWS Ecore_Win32/WinCE: also do not autorepeat the Win key 2012-03-26 17:33:10 +00:00
README gear up svn for release. one of many steps/things to do. 2012-03-17 04:17:29 +00:00
autogen.sh ecore: check change in C++ flags to. 2012-01-11 08:55:37 +00:00
configure.ac Ecore_Wayland: Remove dependency on egl (handled in compositors). 2012-03-27 17:50:40 +00:00
ecore-cocoa.pc.in add back in libs.private/requires to pc files with some fixes for 2012-03-17 05:37:25 +00:00
ecore-con.pc.in add back in libs.private/requires to pc files with some fixes for 2012-03-17 05:37:25 +00:00
ecore-config.pc.in add back in libs.private/requires to pc files with some fixes for 2012-03-17 05:37:25 +00:00
ecore-directfb.pc.in add back in libs.private/requires to pc files with some fixes for 2012-03-17 05:37:25 +00:00
ecore-evas.pc.in add back in libs.private/requires to pc files with some fixes for 2012-03-17 05:37:25 +00:00
ecore-fb.pc.in add back in libs.private/requires to pc files with some fixes for 2012-03-17 05:37:25 +00:00
ecore-file.pc.in add back in libs.private/requires to pc files with some fixes for 2012-03-17 05:37:25 +00:00
ecore-imf-evas.pc.in Move Ecore.h (and associated headers) to own dir. 2010-07-09 06:23:19 +00:00
ecore-imf.pc.in add back in libs.private/requires to pc files with some fixes for 2012-03-17 05:37:25 +00:00
ecore-input-evas.pc.in add back in libs.private/requires to pc files with some fixes for 2012-03-17 05:37:25 +00:00
ecore-input.pc.in add back in libs.private/requires to pc files with some fixes for 2012-03-17 05:37:25 +00:00
ecore-ipc.pc.in add back in libs.private/requires to pc files with some fixes for 2012-03-17 05:37:25 +00:00
ecore-psl1ght.pc.in add back in libs.private/requires to pc files with some fixes for 2012-03-17 05:37:25 +00:00
ecore-sdl.pc.in add back in libs.private/requires to pc files with some fixes for 2012-03-17 05:37:25 +00:00
ecore-wayland.pc.in add back in libs.private/requires to pc files with some fixes for 2012-03-17 05:37:25 +00:00
ecore-win32.pc.in missing flags 2012-03-17 05:42:47 +00:00
ecore-wince.pc.in add back in libs.private/requires to pc files with some fixes for 2012-03-17 05:37:25 +00:00
ecore-x.pc.in add back in libs.private/requires to pc files with some fixes for 2012-03-17 05:37:25 +00:00
ecore.pc.in add back in libs.private/requires to pc files with some fixes for 2012-03-17 05:37:25 +00:00
ecore.spec.in Minor adjustments to the current status. 2011-12-10 11:26:31 +00:00
ecore.supp more suppressions 2004-10-19 16:40:25 +00:00

README

Ecore 1.2.0

******************************************************************************

 FOR ANY ISSUES PLEASE EMAIL:
 enlightenment-devel@lists.sourceforge.net
  
******************************************************************************
  
Requirements:
-------------

Must:
  libc
  eina (1.1.0 or better)
  (For windows you also need: evil)
  
Recommended:
  libX11
  libXext
  libXcursor
  libXprint
  libXinerama
  libXrandr
  libXss
  libXrender
  libXcomposite
  libXfixes
  libXdamage
  libXdpms
  libXtest
  GNUTLS or OpenSSL
  CURL
  evas (1.1.0 or better)

Optional:
  XCB (fully working)
  SDL
  DirectFB
  glib
  tslib

Ecore is a clean and tiny event loop library with many modules to do
lots of convenient things for a programmer, to save time and effort.

It's small and lean, designed to work on embedded systems all the way
to large and powerful multi-cpu workstations. It serialises all system
signals, events etc. into a single event queue, that is easily
processed without needing to worry about concurrency. A properly
written, event-driven program using this kind of programming doesn't
need threads, nor has to worry about concurrency. It turns a program
into a state machine, and makes it very robust and easy to follow.

Ecore gives you other handy primitives, such as timers to tick over
for you and call specified functions at particular times so the
programmer can use this to do things, like animate, or time out on
connections or tasks that take too long etc.

Idle handlers are provided too, as well as calls on entering an idle
state (often a very good time to update the state of the program). All
events that enter the system are passed to specific callback functions
that the program sets up to handle those events. Handling them is
simple and other Ecore modules produce more events on the queue,
coming from other sources such as file descriptors etc.

Ecore also help you work in a multi threaded environment and setup a
thread pool that help you use the EFL on multi-cpu system. It help split
the part that can't be called outside of the ecore main loop from the
computation heavy function that could run on another CPU. Be aware that
Evas and most of Ecore API is not thread safe and should only be called
in the main loop. Eina and Eet could be used, if done carefully, in any
heavy function on another cpu.

Ecore also lets you have functions called when file descriptors become
active for reading or writing, allowing for streamlined, non-blocking
IO.

------------------------------------------------------------------------------
COMPILING AND INSTALLING:

  ./configure
  make
(as root unless you are installing in your users directories):
  make install
      
------------------------------------------------------------------------------
NOTE:

You can experience main loop lock (and more likely see UI lock) if libcurl
doesn't use an asynchronous dns resolver. Since Curl 7.21.0, you can use the
native dns resolver asynchronously by turning  --enable-threaded-resolver
on during configure time. For older version, C-Ares is the way to solve that
issue (see: http://c-ares.haxx.se/ ).