summaryrefslogtreecommitdiff
path: root/legacy/ecore/doc/ecore.dox.in
diff options
context:
space:
mode:
authorMike Blumenkrantz <michael.blumenkrantz@gmail.com>2010-09-20 20:33:50 +0000
committerMike Blumenkrantz <michael.blumenkrantz@gmail.com>2010-09-20 20:33:50 +0000
commit130f5bec81f1ebb3885813d2a3152d54edc0048a (patch)
treed9991151ced9d0c4facaa4fe67b31290d0948c19 /legacy/ecore/doc/ecore.dox.in
parent720fe88aef1b1447e179fd7023366cb025bef704 (diff)
doxy error fixes
SVN revision: 52512
Diffstat (limited to '')
-rw-r--r--legacy/ecore/doc/ecore.dox.in85
1 files changed, 14 insertions, 71 deletions
diff --git a/legacy/ecore/doc/ecore.dox.in b/legacy/ecore/doc/ecore.dox.in
index 94cbe1224d..5c763d88a1 100644
--- a/legacy/ecore/doc/ecore.dox.in
+++ b/legacy/ecore/doc/ecore.dox.in
@@ -42,8 +42,8 @@ These routines are used for Ecore Library interaction
42@author Andre Dieb <andre.dieb\@gmail.com> 42@author Andre Dieb <andre.dieb\@gmail.com>
43@author Mathieu Taillefumier <mathieu.taillefumier\@free.fr> 43@author Mathieu Taillefumier <mathieu.taillefumier\@free.fr>
44@author Rui Miguel Silva Seabra <rms\@1407.org> 44@author Rui Miguel Silva Seabra <rms\@1407.org>
45@author Saumsung Electronics <tbd> 45@author Saumsung Electronics
46@author Samsung SAIT <tbd> 46@author Samsung SAIT
47@author Nicolas Aguirre <aguirre.nicolas\@gmail.com> 47@author Nicolas Aguirre <aguirre.nicolas\@gmail.com>
48@author Brett Nash <nash\@nash.id.au> 48@author Brett Nash <nash\@nash.id.au>
49@author Mike Blumenkrantz <mike\@zentific.com> 49@author Mike Blumenkrantz <mike\@zentific.com>
@@ -218,7 +218,7 @@ follows the same principles as shown in this example.
218 218
219*/ 219*/
220 220
221/** 221/*
222@page Ecore_Config_Page The Enlightened Property Library 222@page Ecore_Config_Page The Enlightened Property Library
223 223
224The Enlightened Property Library (Ecore_Config) is an adbstraction 224The Enlightened Property Library (Ecore_Config) is an adbstraction
@@ -237,53 +237,6 @@ The following examples show how to use the Enlightened Property Library:
237*/ 237*/
238 238
239/** 239/**
240@page Ecore_ADT_Page Ecore Abstract Data Types
241
242This page briefly describes the different abstract data types
243that are provided by the Ecore library for general usage. You need to
244include the @link Ecore_Data.h Ecore_Data.h @endlink to use them.
245
246@section Ecore_ADT_List List
247
248A list is a simple data type where one each piece of data points to
249another piece of data.
250
251Associated modules that describe the List ADT include:
252@li @ref Ecore_Data_List_Creation_Group
253@li @ref Ecore_Data_List_Add_Item_Group
254@li @ref Ecore_Data_List_Remove_Item_Group
255@li @ref Ecore_Data_List_Traverse_Group
256@li @ref Ecore_Data_List_Node_Group
257
258Examples involving lists include:
259@li @link list_example.c list_example.c @endlink
260
261@section Ecore_ADT_DList Doubly Linked List
262
263A doubly linked list is like a linked list, only each piece of data
264can also point to the piece before it. In other words, you can traverse
265a doubly linked list in both directions.
266
267Associated modules that describe the DList ADT include:
268@li @ref Ecore_Data_DList_Creation_Group
269@li @ref Ecore_Data_DList_Add_Item_Group
270@li @ref Ecore_Data_DList_Remove_Item_Group
271
272@section Ecore_ADT_Hash Hash
273
274A hash is an abstract data type where one value is associated with another
275value. Instead of each element of the group being accessible using a
276number, each element is accessed using another object.
277
278Associated modules that describe the Hash ADT include:
279@li @ref Ecore_Data_Hash_ADT_Creation_Group
280@li @ref Ecore_Data_Hash_ADT_Destruction_Group
281@li @ref Ecore_Data_Hash_ADT_Data_Group
282
283@todo Finish this.
284*/
285
286/**
287@page X_Window_System_Page X Window System 240@page X_Window_System_Page X Window System
288 241
289The Ecore library includes a wrapper for handling the X window system. 242The Ecore library includes a wrapper for handling the X window system.
@@ -335,7 +288,7 @@ state.
335 288
336*/ 289*/
337 290
338/** 291/*
339@defgroup Ecore_Config_Create_Group Ecore Config Create Functions 292@defgroup Ecore_Config_Create_Group Ecore Config Create Functions
340 293
341Convenience functions that set default values, bounds, option values and 294Convenience functions that set default values, bounds, option values and
@@ -351,52 +304,42 @@ Functions that are used to load and save properties from and to files.
351// EXAMPLES 304// EXAMPLES
352 305
353/** 306/**
354@example args_example.c 307@example ecore_args_example.c
355Shows how to set and retrieve the program arguments. 308Shows how to set and retrieve the program arguments.
356*/ 309*/
357 310
358/** 311/**
359@example con_server_example.c 312@example ecore_con_server_example.c
360Shows how to write a simple server using the Ecore_Con library. 313Shows how to write a simple server using the Ecore_Con library.
361*/ 314*/
362 315
363/** 316/**
364@example con_client_example.c 317@example ecore_con_client_example.c
365Shows how to write a simple client, that connects to the example server. 318Shows how to write a simple client, that connects to the example server.
366*/ 319*/
367 320
368/** 321/**
369@example event_handler_example.c 322@example ecore_event_handler_example.c
370Shows how to use event handlers. 323Shows how to use event handlers.
371*/ 324*/
372 325
373/** 326/**
374@example timer_example.c 327@example ecore_timer_example.c
375Demonstrates use of the ecore_timer. 328Demonstrates use of the ecore_timer.
376*/ 329*/
377 330
378/** 331/*
379@example config_basic_example.c 332@example ecore_config_basic_example.c
380Provides an example of how to use the basic configuration functions. 333Provides an example of how to use the basic configuration functions.
381See the file Ecore_Config.h for the full list of available functions. 334See the file Ecore_Config.h for the full list of available functions.
382*/ 335*/
383 336
384/** 337/*
385@example config_listener_example.c 338@example ecore_config_listener_example.c
386Shows how to set up a listener to listen for configuration changes. 339Shows how to set up a listener to listen for configuration changes.
387*/ 340*/
388 341
389/** 342/**
390@example list_example.c 343@example ecore_x_window_example.c
391Provides a basic example of how to append to and traverse a list.
392*/
393
394/**
395@example list_destroy_example.c
396Shows how to set and use a destructor for an Ecore_List.
397*/
398
399/**
400@example x_window_example.c
401Shows the basics of using the X Windows system through Ecore functions. 344Shows the basics of using the X Windows system through Ecore functions.
402*/ 345*/