Enlightenment CVS committal
Author : raster
Project : e17
Module : libs/ecore
Dir : e17/libs/ecore/src/lib/ecore
Modified Files:
Ecore.h Ecore_Data.h ecore_hash.c ecore_path.c ecore_plugin.c
ecore_sheap.c ecore_strings.c ecore_value.c
Log Message:
hey guys! can u rememebr to add yourselves to AUTHORS?
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/Ecore.h,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -3 -r1.11 -r1.12
--- Ecore.h 14 Apr 2004 08:51:18 -0000 1.11
+++ Ecore.h 30 Apr 2004 03:10:15 -0000 1.12
@@ -1,6 +1,13 @@
#ifndef _ECORE_H
#define _ECORE_H
+/**
+ * @file Ecore.h
+ * @brief The file that provides the program utility, main loop and timer
+ * functions.
+ *
+ */
+
#include <sys/types.h>
#include <unistd.h>
#include <stdio.h>
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/Ecore_Data.h,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -3 -r1.4 -r1.5
--- Ecore_Data.h 25 Apr 2004 04:35:46 -0000 1.4
+++ Ecore_Data.h 30 Apr 2004 03:10:15 -0000 1.5
@@ -1,6 +1,11 @@
#ifndef _ECORE_DATA_H
# define _ECORE_DATA_H
+/**
+ * @file Ecore_Data.h
+ * @brief Contains threading, list, hash, debugging and tree functions.
+ */
+
# ifdef __cplusplus
extern "C" {
# endif
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/ecore_hash.c,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -3 -r1.2 -r1.3
--- ecore_hash.c 18 Mar 2004 19:02:23 -0000 1.2
+++ ecore_hash.c 30 Apr 2004 03:10:15 -0000 1.3
@@ -142,8 +142,7 @@
/**
* @brief Free the hash table and the data contained inside it
* @param hash: the hash table to destroy
- *
- * @brief Returns TRUE on success, FALSE on error
+ * @return Returns TRUE on success, FALSE on error
*/
void ecore_hash_destroy(Ecore_Hash *hash)
{
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/ecore_path.c,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- ecore_path.c 18 Mar 2004 05:29:54 -0000 1.1
+++ ecore_path.c 30 Apr 2004 03:10:15 -0000 1.2
@@ -6,10 +6,9 @@
Ecore_Path_Group *__ecore_path_group_find_id(int id);
/**
- * ecore_path_group_new - create a new path group
- * @group_name: the name of the new group
- *
- * Returns 0 on error, the integer id of the new group on success.
+ * 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.
*/
int
ecore_path_group_new(char *group_name)
@@ -41,10 +40,9 @@
}
/**
- * ecore_path_group_del - destroy a previously created path group
- * @group_id: the unique identifier for the group
- *
- * Returns no value.
+ * Destroy a previously created path group
+ * @param group_id The unique identifier for the group
+ * @return No value.
*/
void
ecore_path_group_del(int group_id)
@@ -67,11 +65,10 @@
}
/**
- * ecore_path_group_add - add a directory to be searched for files
- * @group_id: the unique identifier for the group to add the path
- * @path: the new path to be added to the group
- *
- * Returns no value.
+ * 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.
*/
void
ecore_path_group_add(int group_id, char *path)
@@ -92,12 +89,12 @@
}
/**
- * ecore_path_group_remove - remove a directory to be searched for files
- * @group_id: the identifier for the group to remove a path
- * @path: the path to be removed from @group_id
+ * 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.
*
- * Returns no value. Removes @path from the list of directories to search for
- * files.
+ * Removes @a path from the list of directories to search for files.
*/
void
ecore_path_group_remove(int group_id, char *path)
@@ -131,12 +128,11 @@
}
/**
- * ecore_path_group_find - find a file in a group of paths
- * @group_id - the path group id to search for @file
- * @file: the name of the file to find in the path group @group_id
- *
- * Returns a pointer to a newly allocated path location of the found file
- * on success, NULL on failure.
+ * 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.
*/
char *
ecore_path_group_find(int group_id, char *name)
@@ -167,11 +163,10 @@
}
/**
- * ecore_path_group_available - get a list of all available files in the path
- * @group_id: the identifier for the path to get all available files
- *
- * Returns a pointer to a newly allocated list of all files found in the paths
- * identified by @group_id, NULL on failure.
+ * 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 @group_id, NULL on failure.
*/
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.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- ecore_plugin.c 18 Mar 2004 05:29:54 -0000 1.1
+++ ecore_plugin.c 30 Apr 2004 03:10:15 -0000 1.2
@@ -3,11 +3,10 @@
static Ecore_List *loaded_plugins = NULL;
/**
- * ecore_plugin_load - load the specified plugin from the specified path group
- * @group_id: the path group to search for the plugin to load
- * @plugin_name: the name of the plugin to load
- *
- * Returns a pointer to the newly loaded plugin on success, NULL on failure.
+ * 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.
*/
Ecore_Plugin *
ecore_plugin_load(int group_id, char *plugin_name)
@@ -53,10 +52,9 @@
}
/**
- * ecore_plugin_unload - unload the specified plugin
- * @plugin: the plugin to unload from memory
- *
- * Returns no value.
+ * Unload the specified plugin
+ * @param plugin The plugin to unload from memory
+ * @return Returns no value.
*/
void
ecore_plugin_unload(Ecore_Plugin * plugin)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/ecore_sheap.c,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- ecore_sheap.c 18 Mar 2004 05:29:54 -0000 1.1
+++ ecore_sheap.c 30 Apr 2004 03:10:15 -0000 1.2
@@ -4,11 +4,10 @@
static void _ecore_sheap_update_data(Ecore_Sheap *heap);
/**
- * ecore_sheap_new - allocate and initialize a new binary heap
- * @compare: the function for comparing keys, NULL for direct comparison
- * @size: the number of elements to allow in the heap
- *
- * Returns a pointer to the newly allocated binary heap on success, NULL on
+ * Allocate and initialize a new binary heap
+ * @param compare The function for comparing keys, NULL for direct comparison
+ * @param size The number of elements to allow in the heap
+ * @return A pointer to the newly allocated binary heap on success, NULL on
* failure.
*/
Ecore_Sheap *ecore_sheap_new(Ecore_Compare_Cb compare, int size)
@@ -29,12 +28,11 @@
}
/**
- * ecore_sheap_init - initialize a binary heap to default values
- * @heap: the heap to initialize
- * @compare: the function for comparing keys, NULL for direct comparison
- * @size: the number of elements to allow in the heap
- *
- * Returns TRUE on success, FALSE on failure
+ * Initialize a binary heap to default values
+ * @param heap The heap to initialize
+ * @param compare The function for comparing keys, NULL for direct comparison
+ * @param size The number of elements to allow in the heap
+ * @return TRUE on success, FALSE on failure
*/
int ecore_sheap_init(Ecore_Sheap *heap, Ecore_Compare_Cb compare, int size)
{
@@ -56,11 +54,12 @@
}
/**
- * ecore_sheap_destroy - free up the memory used by the heap
- * @heap: the heap to be freed
+ * Free up the memory used by the heap
+ * @param heap The heap to be freed
+ * @return No value.
*
- * Returns no value. Free's the memory used by @heap, calls the destroy
- * function on each data item if necessary.
+ * Frees the memory used by @heap, calls the destroy function on each data
+ * item if necessary.
*/
void ecore_sheap_destroy(Ecore_Sheap *heap)
{
@@ -75,12 +74,11 @@
}
/**
- * ecore_sheap_insert - insert new data into the heap
- * @heap: the heap to insert @data
- * @data: the data to add to @heap
- *
- * Returns TRUE on success, NULL on failure. Increases the size of the heap if
- * it becomes larger than available space.
+ * Insert new data into the heap
+ * @param heap The heap to insert @data
+ * @param data The data to add to @heap
+ * @return TRUE on success, NULL on failure. Increases the size of the heap if
+ * it becomes larger than available space.
*/
int ecore_sheap_insert(Ecore_Sheap *heap, void *data)
{
@@ -164,11 +162,11 @@
}
/**
- * ecore_sheap_extract - extract the item at the top of the heap
- * @heap: the heap to remove the top item
- *
- * Returns the top item of the heap on success, NULL on failure. The extract
- * function maintains the heap properties after the extract.
+ * Extract the item at the top of the heap
+ * @param heap The heap to remove the top item
+ * @return The top item of the heap on success, NULL on failure.
+ * @note The extract function maintains the heap properties after the
+ * extract.
*/
void *ecore_sheap_extract(Ecore_Sheap *heap)
{
@@ -189,11 +187,10 @@
}
/**
- * ecore_sheap_extreme - examine the item at the top of the heap
- * @heap: the heap to examine the top item
- *
- * Returns the top item of the heap on success, NULL on failure. The function
- * does not alter the heap.
+ * Examine the item at the top of the heap
+ * @param heap The heap to examine the top item
+ * @return The top item of the heap on success, NULL on failure.
+ * @note The function does not alter the heap.
*/
void *ecore_sheap_extreme(Ecore_Sheap *heap)
{
@@ -204,14 +201,13 @@
}
/**
- * ecore_sheap_change - change the value of the specified item in the heap
- * @heap: the heap to search for the item to change
- * @item: the item in the heap to change
- * @newval: the new value assigned to the item in the heap
- *
- * Returns TRUE on success, FALSE on failure. The heap does not free the old
- * data since it must be passed in, so the caller can perform the free if
- * desired.
+ * Change the value of the specified item in the heap
+ * @param heap The heap to search for the item to change
+ * @param item The item in the heap to change
+ * @param newval The new value assigned to the item in the heap
+ * @return TRUE on success, FALSE on failure.
+ * @note The heap does not free the old data since it must be passed
+ * in, so the caller can perform the free if desired.
*/
int ecore_sheap_change(Ecore_Sheap *heap, void *item, void *newval)
{
@@ -235,12 +231,13 @@
}
/**
- * ecore_sheap_set_compare - change the comparison function for the heap
- * @heap: the heap to change comparison function
- * @compare: the new function for comparing nodes
- *
- * Returns TRUE on success, FALSE on failure. The comparison function is
- * changed to @compare and the heap is heapified by the new comparison.
+ * Change the comparison function for the heap
+ * @param heap The heap to change comparison function
+ * @param compare The new function for comparing nodes
+ * @return TRUE on success, FALSE on failure.
+ *
+ * The comparison function is changed to @compare and the heap is heapified
+ * by the new comparison.
*/
int ecore_sheap_set_compare(Ecore_Sheap *heap, Ecore_Compare_Cb compare)
{
@@ -257,12 +254,13 @@
}
/**
- * ecore_sheap_set_order - change the order of the heap
- * @heap: the heap to change the order
- * @order: the new order of the heap
- *
- * Returns no value. Changes the heap order of @heap and re-heapifies the data
- * to this new order. The default order is a min heap.
+ * Change the order of the heap
+ * @param heap The heap to change the order
+ * @param order The new order of the heap
+ * @return No value.
+ *
+ * Changes the heap order of @heap and re-heapifies the data to this new
+ * order. The default order is a min heap.
*/
void ecore_sheap_set_order(Ecore_Sheap *heap, char order)
{
@@ -274,11 +272,12 @@
}
/**
- * ecore_sheap_sort - sort the data in the heap
- * @heap: the heap to be sorted
+ * Sort the data in the heap
+ * @param heap The heap to be sorted
+ * @return No value.
*
- * Returns no value. Sorts the data in the heap into the order that is used
- * for the heap's data.
+ * Sorts the data in the heap into the order that is used for the heap's
+ * data.
*/
void ecore_sheap_sort(Ecore_Sheap *heap)
{
@@ -306,12 +305,12 @@
}
/*
- * ecore_sheap_item - access the item at the ith position in the heap
- * @heap: the heap to access the internal data
- * @i: the index of the data within the heap
- *
- * Returns the data located at the ith position within @heap on success, NULL
- * on failure. The data is guaranteed to be in sorted order.
+ * Access the item at the ith position in the heap
+ * @param heap The heap to access the internal data
+ * @param i The index of the data within the heap
+ * @return The data located at the ith position within @heap on success,
+ * NULL on failure.
+ * @note The data is guaranteed to be in sorted order.
*/
inline void *ecore_sheap_item(Ecore_Sheap *heap, int i)
{
@@ -328,11 +327,10 @@
}
/*
- * _ecore_sheap_heapify - regain the heap properties starting at position i
- * @heap: the heap to regain heap properties
- * @i: the position to start heapifying
- *
- * Returns no value.
+ * Regain the heap properties starting at position i
+ * @param heap The heap to regain heap properties
+ * @param i The position to start heapifying
+ * @return No value.
*/
static void _ecore_sheap_heapify(Ecore_Sheap *heap, int i)
{
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/ecore_strings.c,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- ecore_strings.c 18 Mar 2004 05:29:54 -0000 1.1
+++ ecore_strings.c 30 Apr 2004 03:10:15 -0000 1.2
@@ -3,10 +3,9 @@
static Ecore_Hash *ecore_strings = NULL;
/**
- * ecore_stringinstance - retrieve an instance of a string for use in an ecore
- * @string: the string to retrieve an instance
- *
- * Returns a pointer to a the string on success, NULL on failure.
+ * 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.
*/
char *ecore_string_instance(char *string)
{
@@ -45,11 +44,12 @@
}
/**
- * ecore_string_release - release an instance of a string
- * @string: the string to release an instance
+ * Release an instance of a string
+ * @param string The string to release an instance
+ * @return No value.
*
- * Returns no value. Marks the string as losing an instance, will free the
- * string if no other instances are present.
+ * Marks the string as losing an instance, will free the string if no other
+ * instances are present.
*/
void ecore_string_release(char *string)
{
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore/ecore_value.c,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- ecore_value.c 18 Mar 2004 05:29:54 -0000 1.1
+++ ecore_value.c 30 Apr 2004 03:10:15 -0000 1.2
@@ -43,10 +43,9 @@
}
/**
- * ecore_direct_hash - just casts the key to an unsigned int
- * @key: the key to return compute a hash value
- *
- * Returns the key cast to an unsigned int.
+ * Just casts the key to an unsigned int
+ * @param key The key to return compute a hash value
+ * @return The key cast to an unsigned int.
*/
unsigned int ecore_direct_hash(void *key)
{
@@ -54,10 +53,9 @@
}
/**
- * ecore_str_hash - compute the hash value of a string
- * @key: a pointer to the string to compute a hash value
- *
- * Returns a computed hash value for @key.
+ * Compute the hash value of a string
+ * @param key A pointer to the string to compute a hash value
+ * @return A computed hash value for @key.
*/
unsigned int ecore_str_hash(void *key)
{
@@ -77,11 +75,10 @@
}
/**
- * ecore_direct_compare - perform a direct comparison of two keys values
- * @key1: the first key to compare
- * @key2: the second key to compare
- *
- * Return a strcmp style value to indicate the larger key
+ * Perform a direct comparison of two keys' values
+ * @param key1 The first key to compare
+ * @param key2 The second key to compare
+ * @return A strcmp style value to indicate the larger key
*/
int ecore_direct_compare(void *key1, void *key2)
{
@@ -100,11 +97,10 @@
}
/**
- * ecore_direct_compare - perform a string comparison of two keys values
- * @key1: the first key to compare
- * @key2: the second key to compare
- *
- * Return a strcmp style value to indicate the larger key
+ * Perform a string comparison of two keys values
+ * @param key1 The first key to compare
+ * @param key2 The second key to compare
+ * @return A strcmp style value to indicate the larger key
*/
int ecore_str_compare(void *key1, void *key2)
{
-------------------------------------------------------
This SF.Net email is sponsored by: Oracle 10g
Get certified on the hottest thing ever to hit the market... Oracle 10g.
Take an Oracle 10g class now, and we'll give you the exam FREE.
http://ads.osdn.com/?ad_id=3149&alloc_id=8166&op=click
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
