summaryrefslogtreecommitdiff
path: root/legacy/ecore/ecore.c.in
diff options
context:
space:
mode:
authorrbdpngn <rbdpngn>2004-07-14 14:15:17 +0000
committerrbdpngn <rbdpngn@7cbeb6ba-43b4-40fd-8cce-4c39aea84d33>2004-07-14 14:15:17 +0000
commit6565e59d589a208b30097b4aeb5c8139f3cb7b1f (patch)
treef33904af0b5e037fd66d5958761daa3fbd612a37 /legacy/ecore/ecore.c.in
parent001bc616027964f208e5bb0d3263e0eb71a4be2a (diff)
Add the documentation and examples from Nicholas Curran, with some
modifications for conditional builds. SVN revision: 10828
Diffstat (limited to '')
-rw-r--r--legacy/ecore/ecore.c.in71
1 files changed, 64 insertions, 7 deletions
diff --git a/legacy/ecore/ecore.c.in b/legacy/ecore/ecore.c.in
index 1833a40b1d..3e1e292a2d 100644
--- a/legacy/ecore/ecore.c.in
+++ b/legacy/ecore/ecore.c.in
@@ -199,6 +199,33 @@ follows the same principles as shown in this example.
199*/ 199*/
200 200
201/** 201/**
202@page Ecore_Con_Page The Ecore Connection Library
203
204The Ecore Connection Library ( @c Ecore_Con ) provides simple mechanisms
205for communications between programs using reliable sockets. It saves
206the programmer from having to worry about file descripters and waiting
207for incoming connections.
208
209There are two main objects in the @c Ecore_Con library: the @c
210Ecore_Con_Server and the @c Ecore_Con_Client.
211
212The @c Ecore_Con_Server represents a server to connect to. It is
213represents a server that can be connected to. It is used regardless
214of whether the program is acting as a server or client itself.
215
216To create a listening server, call @c ecore_con_server_add().
217
218To connect to a server, call @c ecore_Con_server_connect(). Data can
219then be sent to the server using the @c ecore_con_server_send().
220
221Whenever a client connection is made to an @c Ecore_Con_Server, a
222@c ECORE_CON_CLIENT_ADD event is emitted. Any event callbacks that are
223called receive a @c Ecore_Con_Client object, which represents a
224connection that that particular client.
225
226 */
227
228/**
202@page Ecore_Config_Page The Enlightened Property Library 229@page Ecore_Config_Page The Enlightened Property Library
203 230
204The Enlightened Property Library (Ecore_Config) is an adbstraction 231The Enlightened Property Library (Ecore_Config) is an adbstraction
@@ -385,17 +412,47 @@ Shows how to set and retrieve the program arguments.
385*/ 412*/
386 413
387/** 414/**
415@example con_server_example.c
416Shows how to write a simple server using the Ecore_Con library.
417*/
418
419/**
420@example con_client_example.c
421Shows how to write a simple client, that connects to the example server.
422*/
423
424/**
388@example event_handler_example.c 425@example event_handler_example.c
389Shows how to use event handlers. 426Shows how to use event handlers.
390*/ 427*/
391 428
392/** 429/**
393 * @example timer_example.c 430@example timer_example.c
394 * Demonstrates use of the ecore_timer. 431Demonstrates use of the ecore_timer.
395 */ 432*/
396 433
397/** 434/**
398 * @example config_basic_example.c 435@example config_basic_example.c
399 * Provides an example of how to use the basic configuration functions. 436Provides an example of how to use the basic configuration functions.
400 * See the file Ecore_Config.h for the full list of available functions. 437See the file Ecore_Config.h for the full list of available functions.
401 */ 438*/
439
440/**
441@example config_listener_example.c
442Shows how to set up a listener to listen for configuration changes.
443*/
444
445/**
446@example list_example.c
447Provides a basic example of how to append to and traverse a list.
448*/
449
450/**
451@example list_destroy_example.c
452Shows how to set and use a destructor for an Ecore_List.
453*/
454
455/**
456@example x_window_example.c
457Shows the basics of using the X Windows system through Ecore functions.
458*/ \ No newline at end of file