summaryrefslogtreecommitdiff
path: root/legacy/ecore/ecore.c.in
diff options
context:
space:
mode:
authorncn <ncn>2004-07-30 12:28:29 +0000
committerncn <ncn@7cbeb6ba-43b4-40fd-8cce-4c39aea84d33>2004-07-30 12:28:29 +0000
commit255a0b7226d4072d57c977a136a73a01333f1080 (patch)
tree80acdee85277737929c75e4e0710cf5f2191dd9f /legacy/ecore/ecore.c.in
parent49390d5f3768fc4cedebad4a1e3ed3e173060eba (diff)
More docs stuff - fix ups, rearranging, little bit o' new stuff, quieter doc generation.
SVN revision: 11103
Diffstat (limited to '')
-rw-r--r--legacy/ecore/ecore.c.in99
1 files changed, 28 insertions, 71 deletions
diff --git a/legacy/ecore/ecore.c.in b/legacy/ecore/ecore.c.in
index 30b2931792..ed400bf594 100644
--- a/legacy/ecore/ecore.c.in
+++ b/legacy/ecore/ecore.c.in
@@ -238,7 +238,10 @@ To use the library, you:
238@li Load the configuration from a file. You must set the default values 238@li Load the configuration from a file. You must set the default values
239 first, so that the library knows the correct type of each argument. 239 first, so that the library knows the correct type of each argument.
240 240
241See @ref config_basic_example.c for an example. 241The following examples show how to use the Enlightened Property Library:
242@li @link config_basic_example.c config_basic_example.c @endlink
243@li @link config_listener_example.c config_listener_example.c @endlink
244
242*/ 245*/
243 246
244/** 247/**
@@ -253,16 +256,38 @@ include the @link Ecore_Data.h Ecore_Data.h @endlink to use them.
253A list is a simple data type where one each piece of data points to 256A list is a simple data type where one each piece of data points to
254another piece of data. 257another piece of data.
255 258
256Associated modules include the following: 259Associated modules that describe the List ADT include:
260@li @ref Ecore_Data_List_Creation_Group
257@li @ref Ecore_Data_List_Add_Item_Group 261@li @ref Ecore_Data_List_Add_Item_Group
262@li @ref Ecore_Data_List_Remove_Item_Group
263@li @ref Ecore_Data_List_Traverse_Group
264@li @ref Ecore_Data_List_Node_Group
265
266Examples involving lists include:
267@li @link list_example.c list_example.c @endlink
258 268
259@section Ecore_ADT_DList Doubly Linked List 269@section Ecore_ADT_DList Doubly Linked List
260 270
261A doubly linked list is like a linked list, only each piece of data 271A doubly linked list is like a linked list, only each piece of data
262can also point to the piece before it. 272can also point to the piece before it. In other words, you can traverse
273a doubly linked list in both directions.
274
275Associated modules that describe the DList ADT include:
276@li @ref Ecore_Data_DList_Creation_Group
277@li @ref Ecore_Data_DList_Add_Item_Group
278@li @ref Ecore_Data_DList_Remove_Item_Group
263 279
264@section Ecore_ADT_Hash Hash 280@section Ecore_ADT_Hash Hash
265 281
282A hash is an abstract data type where one value is associated with another
283value. Instead of each element of the group being accessible using a
284number, each element is accessed using another object.
285
286Associated modules that describe the Hash ADT include:
287@li @ref Ecore_Data_Hash_ADT_Creation_Group
288@li @ref Ecore_Data_Hash_ADT_Destruction_Group
289@li @ref Ecore_Data_Hash_ADT_Setting_Group
290
266@todo Finish this. 291@todo Finish this.
267*/ 292*/
268 293
@@ -325,62 +350,6 @@ state.
325*/ 350*/
326 351
327/** 352/**
328@defgroup Ecore_Data_List_Creation_Group List Creation/Destruction Functions
329
330Functions that create, initialize and destroy Ecore_Lists.
331*/
332
333/**
334@defgroup Ecore_Data_List_Add_Item_Group List Item Adding Functions
335
336Functions that are used to add nodes to an Ecore_List.
337*/
338
339/**
340@defgroup Ecore_Data_List_Remove_Item_Group List Item Removing Functions
341
342Functions that remove nodes from an Ecore_List.
343*/
344
345/**
346@defgroup Ecore_Data_List_Traverse_Group List Traversal Functions
347
348Functions that can be used to traverse an Ecore_List.
349*/
350
351/**
352@defgroup Ecore_Data_List_Node_Group List Node Functions
353
354Functions that are used in the creation, maintenance and destruction of
355Ecore_List nodes.
356*/
357
358/**
359@defgroup Ecore_Config_Lib_Group Ecore Config Library Functions
360
361Functions that are used to start up and shutdown the Ecore Configuration
362Library.
363*/
364
365/**
366@defgroup Ecore_Config_Property_Group Ecore Config Property Functions
367
368Functions that retrieve or set the attributes relating to a property.
369*/
370
371/**
372@defgroup Ecore_Config_Get_Group Ecore Config Retrievers
373
374Functions that return the value of a property, based on its key.
375*/
376
377/**
378@defgroup Ecore_Config_Default_Group Ecore Config Defaults
379
380Functions that are used to set the default values of properties.
381*/
382
383/**
384@defgroup Ecore_Config_Create_Group Ecore Config Create Functions 353@defgroup Ecore_Config_Create_Group Ecore Config Create Functions
385 354
386Convenience functions that set default values, bounds, option values and 355Convenience functions that set default values, bounds, option values and
@@ -388,18 +357,6 @@ descriptions in one call.
388*/ 357*/
389 358
390/** 359/**
391@defgroup Ecore_Config_Set_Group Ecore Config Setters
392
393Functions that set the value of a property.
394*/
395
396/**
397@defgroup Ecore_Config_Listeners_Group Ecore Config Listeners
398
399Functions that set and unset property listener callbacks.
400*/
401
402/**
403@defgroup Ecore_Config_File_Group Ecore Config File Functions 360@defgroup Ecore_Config_File_Group Ecore Config File Functions
404 361
405Functions that are used to load and save properties from and to files. 362Functions that are used to load and save properties from and to files.