Enlightenment CVS committal
Author : ncn
Project : e17
Module : libs/ecore
Dir : e17/libs/ecore
Modified Files:
Doxyfile ecore.c.in
Log Message:
More docs stuff - fix ups, rearranging, little bit o' new stuff, quieter doc
generation.
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/Doxyfile,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -3 -r1.4 -r1.5
--- Doxyfile 8 May 2004 04:44:01 -0000 1.4
+++ Doxyfile 30 Jul 2004 12:28:28 -0000 1.5
@@ -57,7 +57,7 @@
OPTIMIZE_OUTPUT_FOR_C = YES
OPTIMIZE_OUTPUT_JAVA = NO
SHOW_USED_FILES = NO
-QUIET = NO
+QUIET = YES
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_FORMAT = "$file:$line: $text"
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/ecore.c.in,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -3 -r1.11 -r1.12
--- ecore.c.in 22 Jul 2004 13:07:24 -0000 1.11
+++ ecore.c.in 30 Jul 2004 12:28:28 -0000 1.12
@@ -238,7 +238,10 @@
@li Load the configuration from a file. You must set the default values
first, so that the library knows the correct type of each argument.
-See @ref config_basic_example.c for an example.
+The following examples show how to use the Enlightened Property Library:
[EMAIL PROTECTED] @link config_basic_example.c config_basic_example.c @endlink
[EMAIL PROTECTED] @link config_listener_example.c config_listener_example.c @endlink
+
*/
/**
@@ -253,16 +256,38 @@
A list is a simple data type where one each piece of data points to
another piece of data.
-Associated modules include the following:
+Associated modules that describe the List ADT include:
[EMAIL PROTECTED] @ref Ecore_Data_List_Creation_Group
@li @ref Ecore_Data_List_Add_Item_Group
[EMAIL PROTECTED] @ref Ecore_Data_List_Remove_Item_Group
[EMAIL PROTECTED] @ref Ecore_Data_List_Traverse_Group
[EMAIL PROTECTED] @ref Ecore_Data_List_Node_Group
+
+Examples involving lists include:
[EMAIL PROTECTED] @link list_example.c list_example.c @endlink
@section Ecore_ADT_DList Doubly Linked List
A doubly linked list is like a linked list, only each piece of data
-can also point to the piece before it.
+can also point to the piece before it. In other words, you can traverse
+a doubly linked list in both directions.
+
+Associated modules that describe the DList ADT include:
[EMAIL PROTECTED] @ref Ecore_Data_DList_Creation_Group
[EMAIL PROTECTED] @ref Ecore_Data_DList_Add_Item_Group
[EMAIL PROTECTED] @ref Ecore_Data_DList_Remove_Item_Group
@section Ecore_ADT_Hash Hash
+A hash is an abstract data type where one value is associated with another
+value. Instead of each element of the group being accessible using a
+number, each element is accessed using another object.
+
+Associated modules that describe the Hash ADT include:
[EMAIL PROTECTED] @ref Ecore_Data_Hash_ADT_Creation_Group
[EMAIL PROTECTED] @ref Ecore_Data_Hash_ADT_Destruction_Group
[EMAIL PROTECTED] @ref Ecore_Data_Hash_ADT_Setting_Group
+
@todo Finish this.
*/
@@ -325,62 +350,6 @@
*/
/**
[EMAIL PROTECTED] Ecore_Data_List_Creation_Group List Creation/Destruction Functions
-
-Functions that create, initialize and destroy Ecore_Lists.
-*/
-
-/**
[EMAIL PROTECTED] Ecore_Data_List_Add_Item_Group List Item Adding Functions
-
-Functions that are used to add nodes to an Ecore_List.
-*/
-
-/**
[EMAIL PROTECTED] Ecore_Data_List_Remove_Item_Group List Item Removing Functions
-
-Functions that remove nodes from an Ecore_List.
-*/
-
-/**
[EMAIL PROTECTED] Ecore_Data_List_Traverse_Group List Traversal Functions
-
-Functions that can be used to traverse an Ecore_List.
-*/
-
-/**
[EMAIL PROTECTED] Ecore_Data_List_Node_Group List Node Functions
-
-Functions that are used in the creation, maintenance and destruction of
-Ecore_List nodes.
-*/
-
-/**
[EMAIL PROTECTED] Ecore_Config_Lib_Group Ecore Config Library Functions
-
-Functions that are used to start up and shutdown the Ecore Configuration
-Library.
-*/
-
-/**
[EMAIL PROTECTED] Ecore_Config_Property_Group Ecore Config Property Functions
-
-Functions that retrieve or set the attributes relating to a property.
-*/
-
-/**
[EMAIL PROTECTED] Ecore_Config_Get_Group Ecore Config Retrievers
-
-Functions that return the value of a property, based on its key.
-*/
-
-/**
[EMAIL PROTECTED] Ecore_Config_Default_Group Ecore Config Defaults
-
-Functions that are used to set the default values of properties.
-*/
-
-/**
@defgroup Ecore_Config_Create_Group Ecore Config Create Functions
Convenience functions that set default values, bounds, option values and
@@ -388,18 +357,6 @@
*/
/**
[EMAIL PROTECTED] Ecore_Config_Set_Group Ecore Config Setters
-
-Functions that set the value of a property.
-*/
-
-/**
[EMAIL PROTECTED] Ecore_Config_Listeners_Group Ecore Config Listeners
-
-Functions that set and unset property listener callbacks.
-*/
-
-/**
@defgroup Ecore_Config_File_Group Ecore Config File Functions
Functions that are used to load and save properties from and to files.
-------------------------------------------------------
This SF.Net email is sponsored by OSTG. Have you noticed the changes on
Linux.com, ITManagersJournal and NewsForge in the past few weeks? Now,
one more big change to announce. We are now OSTG- Open Source Technology
Group. Come see the changes on the new OSTG site. www.ostg.com
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
