Enlightenment CVS committal
Author : raster
Project : e17
Module : libs/ecore
Dir : e17/libs/ecore
Modified Files:
AUTHORS Doxyfile Makefile.am configure.in ecore.c.in
Log Message:
nathan's docs :)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/AUTHORS,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -3 -r1.10 -r1.11
--- AUTHORS 2 May 2004 21:02:49 -0000 1.10
+++ AUTHORS 8 May 2004 04:44:01 -0000 1.11
@@ -10,3 +10,4 @@
Howell Tam <[EMAIL PROTECTED]>
Nathan Ingersoll <[EMAIL PROTECTED]>
Andrew Elcock <[EMAIL PROTECTED]>
+Nicholas Curran <[EMAIL PROTECTED]>
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/Doxyfile,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -3 -r1.3 -r1.4
--- Doxyfile 30 Apr 2004 03:10:15 -0000 1.3
+++ Doxyfile 8 May 2004 04:44:01 -0000 1.4
@@ -67,7 +67,7 @@
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
-EXAMPLE_PATH =
+EXAMPLE_PATH = ./examples/
EXAMPLE_PATTERNS =
EXAMPLE_RECURSIVE = NO
INPUT_FILTER =
@@ -137,9 +137,3 @@
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
SEARCHENGINE = NO
-CGI_NAME = search.cgi
-CGI_URL =
-DOC_URL =
-DOC_ABSPATH =
-BIN_ABSPATH = /usr/bin/
-EXT_DOC_PATHS =
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/Makefile.am,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -3 -r1.11 -r1.12
--- Makefile.am 16 Feb 2004 02:48:13 -0000 1.11
+++ Makefile.am 8 May 2004 04:44:01 -0000 1.12
@@ -1,6 +1,6 @@
## Process this file with automake to produce Makefile.in
-SUBDIRS = src debian
+SUBDIRS = src debian examples
MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.guess \
config.h.in config.sub configure install-sh \
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/configure.in,v
retrieving revision 1.46
retrieving revision 1.47
diff -u -3 -r1.46 -r1.47
--- configure.in 16 Apr 2004 01:46:54 -0000 1.46
+++ configure.in 8 May 2004 04:44:01 -0000 1.47
@@ -643,6 +643,7 @@
src/lib/ecore_txt/Makefile
src/lib/ecore_config/Makefile
debian/Makefile
+examples/Makefile
], [
chmod +x ecore-config
]
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/ecore.c.in,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -3 -r1.5 -r1.6
--- ecore.c.in 30 Apr 2004 03:10:15 -0000 1.5
+++ ecore.c.in 8 May 2004 04:44:01 -0000 1.6
@@ -7,8 +7,10 @@
/**
@mainpage Ecore
+
@image latex ecore_big.eps width=5cm
@image html ecore.png
+
@version 1.0.0
@author Carsten Haitzler <[EMAIL PROTECTED]>
@author Tom Gilbert <[EMAIL PROTECTED]>
@@ -20,16 +22,6 @@
-
-
-
-
-
-
-
-
-
-
@section intro What is Ecore?
Ecore is a clean and tiny event loop library with many modules to do lots of
@@ -64,19 +56,6 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
@section work How does Ecore work?
Ecore is very easy to learn and use. All the function calls are designed to
@@ -141,15 +120,16 @@
}
@endcode
-In the previous example, we initialize our application and get the time at which
-our program has started so we can calculate an offset. We set up a timer to
-tick off in 0.5 seconds, and since it returns 1, will keep ticking off every
-0.5 seconds until it returns 0, or is deleted by hand. An event handler is set
-up to call a function - exit_func(), whenever an event of type
-ECORE_EVENT_SIGNAL_EXIT is received (CTRL-C on the command line will cause
-such an event to happen). If this event occurs it tells you what kind of
-exit signal was received, and asks the main loop to quit when it is finished
-by calling ecore_main_loop_quit().
+In the previous example, we initialize our application and get the time at
+which our program has started so we can calculate an offset. We set
+up a timer to tick off in 0.5 seconds, and since it returns 1, will
+keep ticking off every 0.5 seconds until it returns 0, or is deleted
+by hand. An event handler is set up to call a function - exit_func(),
+whenever an event of type ECORE_EVENT_SIGNAL_EXIT is received (CTRL-C
+on the command line will cause such an event to happen). If this event
+occurs it tells you what kind of exit signal was received, and asks
+the main loop to quit when it is finished by calling
+ecore_main_loop_quit().
The handles returned by ecore_timer_add() and ecore_event_handler_add() are
only stored here as an example. If you don't need to address the timer or
@@ -163,11 +143,6 @@
-
-
-
-
-
@section compiling How to compile using Ecore?
This section has to be documented. Below is just a quick line to handle all
@@ -183,17 +158,6 @@
-
-
-
-
-
-
-
-
-
-
-
@section install How is it installed?
Suggested configure options for evas for a Linux desktop X display:
@@ -213,15 +177,6 @@
-
-
-
-
-
-
-
-
-
@section tutorial Ecore Tutorial
You will find a more comprehensive @ref tut here, going through many examples
@@ -240,3 +195,79 @@
Here is a tutotial for using Ecore...
*/
+
+/**
[EMAIL PROTECTED] The Enlightened Property Library
+
+The Enlightened Property Library (Ecore_Config) is an adbstraction
+from the complexities of writing your own configuration. It provides
+many features using the Enlightenment 17 development libraries.
+
+
+
+ */
+
+// GROUP DEFINITIONS
+
+/**
+ * @defgroup Ecore_Main_Loop_Group Main Loop Functions
+ *
+ * Functions used to control the main loop.
+ */
+
+/**
+ * @defgroup Ecore_Timer_Group Ecore Timer
+ *
+ * The timer allows callbacks to be called at specific intervals.
+ */
+
+/**
+ * @defgroup Idle_Group Idle Handlers
+ *
+ * Callbacks that are called when the program enters or exits an idle state.
+ *
+ * The ecore main loop enters an idle state when it is waiting for
+ * timers to time out, data to come in on a file descriptor or any
+ * other event to occur. You can set callbacks to be called when the
+ * main loop enters an idle state, during an idle state or just after
+ * the program wakes up.
+ *
+ * Enterer callbacks are good for updating your program's state, if it
+ * has a state engine. Once all of the enterer handlers are called,
+ * the program will enter a "sleeping" state.
+ *
+ * Idler callbacks are called when the main loop has called all
+ * enterer handlers. They are useful for interfaces that require
+ * polling and timers would be too slow to use.
+ *
+ * If no idler callbacks are specified, then the process literally
+ * goes to sleep. Otherwise, the idler callbacks are called
+ * continuously while the loop is "idle", using as much CPU as is
+ * available to the process.
+ *
+ * Exiter callbacks are called when the main loop wakes up from an idle
+ * state.
+ */
+
+// EXAMPLES
+
+/**
+ * @example args_example.c
+ * Shows how to set and retrieve the program arguments.
+ */
+
+/**
+ * @example event_handler_example.c
+ * Shows how to use event handlers.
+ */
+
+/**
+ * @example timer_example.c
+ * Demonstrates use of the ecore_timer.
+ */
+
+/**
+ * @example config_basic_example.c
+ * Provides an example of how to use the basic configuration functions.
+ * See the file Ecore_Config.h for the full list of available functions.
+ */
-------------------------------------------------------
This SF.Net email is sponsored by Sleepycat Software
Learn developer strategies Cisco, Motorola, Ericsson & Lucent use to
deliver higher performing products faster, at low TCO.
http://www.sleepycat.com/telcomwpreg.php?From=osdnemail3
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
