Enlightenment CVS committal
Author : ncn
Project : e17
Module : libs/ecore
Dir : e17/libs/ecore/src/lib/ecore
Modified Files:
ecore_path.c ecore_plugin.c ecore_strings.c
Log Message:
More documentation, simplification, mode-ification, grouping.
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/ecore_path.c,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -3 -r1.4 -r1.5
--- ecore_path.c 10 Jul 2004 23:14:02 -0000 1.4
+++ ecore_path.c 12 Aug 2004 11:29:17 -0000 1.5
@@ -6,9 +6,18 @@
Ecore_Path_Group *__ecore_path_group_find_id(int id);
/**
- * Create a new path group
- * @param group_name The name of the new group
- * @return 0 on error, the integer id of the new group on success.
+ * @defgroup Ecore_Path_Group Path Group Functions
+ *
+ * Functions that make it easier to find a file in a set of search paths.
+ *
+ * @todo Give this a better description.
+ */
+
+/**
+ * Creates a new path group.
+ * @param group_name The name of the new group.
+ * @return @c 0 on error, the integer id of the new group on success.
+ * @ingroup Ecore_Path_Group
*/
int
ecore_path_group_new(char *group_name)
@@ -40,9 +49,9 @@
}
/**
- * Destroy a previously created path group
- * @param group_id The unique identifier for the group
- * @return No value.
+ * Destroys a previously created path group
+ * @param group_id The unique identifier for the group.
+ * @ingroup Ecore_Path_Group
*/
void
ecore_path_group_del(int group_id)
@@ -65,10 +74,10 @@
}
/**
- * Add a directory to be searched for files
- * @param group_id The unique identifier for the group to add the path
- * @param path The new path to be added to the group
- * @return No value.
+ * Adds a directory to be searched for files.
+ * @param group_id The unique identifier for the group to add the path.
+ * @param path The new path to be added to the group.
+ * @ingroup Ecore_Path_Group
*/
void
ecore_path_group_add(int group_id, char *path)
@@ -89,12 +98,10 @@
}
/**
- * Remove a directory to be searched for files
- * @param group_id The identifier for the group to remove @a path
- * @param path The path to be removed from @a group_id
- * @return No value.
- *
- * Removes @a path from the list of directories to search for files.
+ * Removes the given directory from the given group.
+ * @param group_id The identifier for the given group.
+ * @param path The path of the directory to be removed.
+ * @ingroup Ecore_Path_Group
*/
void
ecore_path_group_remove(int group_id, char *path)
@@ -128,11 +135,12 @@
}
/**
- * Find a file in a group of paths
- * @param group_id The path group id to search for @a name
- * @param name The name of the file to find in the path group @a group_id
- * @return A pointer to a newly allocated path location of the found file
- * on success, NULL on failure.
+ * Finds a file in a group of paths.
+ * @param group_id The path group id to search.
+ * @param name The name of the file to find.
+ * @return A pointer to a newly allocated path location of the found file
+ * on success. @c NULL on failure.
+ * @ingroup Ecore_Path_Group
*/
char *
ecore_path_group_find(int group_id, char *name)
@@ -165,10 +173,11 @@
}
/**
- * Get a list of all available files in the path
- * @param group_id The identifier for the path to get all available files
- * @return A pointer to a newly allocated list of all files found in the paths
- * identified by @a group_id, NULL on failure.
+ * Retrieves a list of all available files in the given path.
+ * @param group_id The identifier for the given path.
+ * @return A pointer to a newly allocated list of all files found in the paths
+ * identified by @p group_id. @c NULL otherwise.
+ * @ingroup Ecore_Path_Group
*/
Ecore_List *
ecore_path_group_available(int group_id)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/ecore_plugin.c,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -3 -r1.2 -r1.3
--- ecore_plugin.c 30 Apr 2004 03:10:15 -0000 1.2
+++ ecore_plugin.c 12 Aug 2004 11:29:18 -0000 1.3
@@ -3,10 +3,18 @@
static Ecore_List *loaded_plugins = NULL;
/**
- * Load the specified plugin from the specified path group
- * @param group_id The path group to search for the plugin to load
- * @param plugin_name The name of the plugin to load
- * @return A pointer to the newly loaded plugin on success, NULL on failure.
+ * @defgroup Ecore_Plugin Plugin Functions
+ *
+ * Functions that load modules of compiled code into memory.
+ */
+
+/**
+ * Loads the specified plugin from the specified path group.
+ * @param group_id The path group to search for the plugin to load
+ * @param plugin_name The name of the plugin to load.
+ * @return A pointer to the newly loaded plugin on success, @c NULL on
+ * failure.
+ * @ingroup Ecore_Plugin
*/
Ecore_Plugin *
ecore_plugin_load(int group_id, char *plugin_name)
@@ -52,9 +60,9 @@
}
/**
- * Unload the specified plugin
- * @param plugin The plugin to unload from memory
- * @return Returns no value.
+ * Unloads the given plugin from memory.
+ * @param plugin The given plugin.
+ * @ingroup Ecore_Plugin
*/
void
ecore_plugin_unload(Ecore_Plugin * plugin)
@@ -74,7 +82,11 @@
}
/*
- * Lookup the specified symbol for the plugin
+ * Searches for the specified symbol in the given plugin.
+ * @param plugin The given plugin.
+ * @param symbol_name The symbol to search for.
+ * @return Address of the given symbol if successful. Otherwise, @c NULL.
+ * @ingroup Ecore_Plugin
*/
void *
ecore_plugin_call(Ecore_Plugin * plugin, char *symbol_name)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/ecore_strings.c,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -3 -r1.3 -r1.4
--- ecore_strings.c 29 Jul 2004 19:31:36 -0000 1.3
+++ ecore_strings.c 12 Aug 2004 11:29:18 -0000 1.4
@@ -3,9 +3,18 @@
static Ecore_Hash *ecore_strings = NULL;
/**
- * Retrieve an instance of a string for use in an ecore
- * @param string The string to retrieve an instance
- * @return A pointer to a the string on success, NULL on failure.
+ * @defgroup Ecore_String_Group String Instance Functions
+ *
+ * These functions allow you to store one copy of a string, and use it
+ * throughout your program.
+ */
+
+/**
+ * Retrieves an instance of a string for use in an ecore program.
+ * @param string The string to retrieve an instance of.
+ * @return A pointer to an instance of the string on success.
+ * @c NULL on failure.
+ * @ingroup Ecore_String_Group
*/
char *ecore_string_instance(char *string)
{
@@ -44,12 +53,12 @@
}
/**
- * Release an instance of a string
- * @param string The string to release an instance
- * @return No value.
+ * Notes that the given string has lost an instance.
+ *
+ * It will free the string if no other instances are left.
*
- * Marks the string as losing an instance, will free the string if no other
- * instances are present.
+ * @param string The given string.
+ * @ingroup Ecore_String_Group
*/
void ecore_string_release(char *string)
{
-------------------------------------------------------
SF.Net email is sponsored by Shop4tech.com-Lowest price on Blank Media
100pk Sonic DVD-R 4x for only $29 -100pk Sonic DVD+R for only $33
Save 50% off Retail on Ink & Toner - Free Shipping and Free Gift.
http://www.shop4tech.com/z/Inkjet_Cartridges/9_108_r285
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
