hey guys! can u rememebr to add yourselves to AUTHORS?

SVN revision: 9978
This commit is contained in:
Carsten Haitzler 2004-04-30 03:10:17 +00:00
parent f0edb7bb9d
commit ab01bcabdb
21 changed files with 180 additions and 157 deletions

View File

@ -4,4 +4,6 @@ Burra <burra@colorado.edu>
Chris Ross <chris@darkrock.co.uk>
Term <term@twistedpath.org>
Tilman Sauerbeck <tilman@code-monkey.de>
Yuri <da2001@hotmail.ru>
Yuri <da2001@hotmail.ru>
Nicholas Curran <quasar@bigblue.net.au>
Howell Tam <pigeon@pigeond.net>

View File

@ -1,7 +1,7 @@
PROJECT_NAME = Ecore
PROJECT_NUMBER =
OUTPUT_DIRECTORY = doc
INPUT = ecore.c
INPUT = ecore.c.in ./src/lib
IMAGE_PATH = doc/img
OUTPUT_LANGUAGE = English
GENERATE_HTML = YES
@ -63,7 +63,7 @@ WARN_IF_UNDOCUMENTED = YES
WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE =
FILE_PATTERNS =
RECURSIVE = NO
RECURSIVE = YES
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =

View File

@ -1,5 +1,4 @@
/**
@file
@brief Ecore Library Public API Calls
These routines are used for Ecore Library interaction

View File

@ -1,11 +1,4 @@
#!/bin/sh
cp ./ecore.c.in ./ecore.c
for I in `find ./src/lib -name "Ecore*.h" -print`; do
cat $I >> ./ecore.c
done
for I in `find ./src/lib -name "*.c" -print`; do
cat $I >> ./ecore.c
done
rm -rf ./doc/html ./doc/latex ./doc/man
doxygen
cp doc/img/*.png doc/html/

View File

@ -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>

View File

@ -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

View File

@ -142,8 +142,7 @@ int ecore_hash_set(Ecore_Hash *hash, void *key, void *value)
/**
* @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)
{

View File

@ -6,10 +6,9 @@ Ecore_Path_Group *__ecore_path_group_find(char *name);
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_new(char *group_name)
}
/**
* 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_del(int group_id)
}
/**
* 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_add(int group_id, char *path)
}
/**
* 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_remove(int group_id, char *path)
}
/**
* 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_find(int group_id, char *name)
}
/**
* 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)

View File

@ -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_load(int group_id, char *plugin_name)
}
/**
* 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)

View File

@ -4,11 +4,10 @@ static void _ecore_sheap_heapify(Ecore_Sheap *heap, int i);
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 *ecore_sheap_new(Ecore_Compare_Cb compare, int size)
}
/**
* 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 @@ int ecore_sheap_init(Ecore_Sheap *heap, Ecore_Compare_Cb compare, int size)
}
/**
* 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 @@ void ecore_sheap_destroy(Ecore_Sheap *heap)
}
/**
* 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 @@ int ecore_sheap_insert(Ecore_Sheap *heap, void *data)
}
/**
* 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 @@ void *ecore_sheap_extract(Ecore_Sheap *heap)
}
/**
* 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 @@ void *ecore_sheap_extreme(Ecore_Sheap *heap)
}
/**
* 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 @@ int ecore_sheap_change(Ecore_Sheap *heap, void *item, void *newval)
}
/**
* 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 @@ int ecore_sheap_set_compare(Ecore_Sheap *heap, Ecore_Compare_Cb compare)
}
/**
* 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 @@ void ecore_sheap_set_order(Ecore_Sheap *heap, char order)
}
/**
* 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 @@ void ecore_sheap_sort(Ecore_Sheap *heap)
}
/*
* 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 @@ inline void *ecore_sheap_item(Ecore_Sheap *heap, int i)
}
/*
* _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)
{

View File

@ -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 @@ char *ecore_string_instance(char *string)
}
/**
* 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)
{

View File

@ -43,10 +43,9 @@ inline void ecore_print_warning(char *function, char *sparam)
}
/**
* 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 @@ unsigned int ecore_direct_hash(void *key)
}
/**
* 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 @@ unsigned int ecore_str_hash(void *key)
}
/**
* 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 @@ int ecore_direct_compare(void *key1, void *key2)
}
/**
* 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)
{

View File

@ -1,6 +1,11 @@
#ifndef _ECORE_CON_H
#define _ECORE_CON_H
/**
* @file Ecore_Con.h
* @brief Sockets functions.
*/
#define HAVE_ECORE_CON_OPENSSL @USE_OPENSSL@
#if HAVE_ECORE_CON_OPENSSL

View File

@ -2,26 +2,17 @@
# define _ECORE_CONFIG_H
/**
* @file Ecore_Config.h
* @brief The file that any project using ecore_config will want to include.
*
* This file provies all headers and structs for use with Ecore_Config.
* Using individual header files should not be necessary.
*/
/**
* @mainpage Enlightened Configuration Library Documentation
*
* @image html ecore_config_mini.png
*
* @section intro Introduction
* @file
* @brief Provides the Enlightened Property Library.
*
* The Enlightened Property Library (Ecore_Config) is an adbstraction from the
* complexities of writing your own configuration. It provides many features
* using the Enlightenment 17 development libraries.
*
* This file provies all headers and structs for use with Ecore_Config.
* Using individual header files should not be necessary.
*/
# define DIR_DELIMITER '/'
# define ECORE_CONFIG_FLOAT_PRECISION 1000

View File

@ -1,6 +1,11 @@
#ifndef _ECORE_EVAS_H
#define _ECORE_EVAS_H
/**
* @file Ecore_Evas.h
* @brief Evas wrapper functions
*/
/* FIXME:
* to do soon:
* - iconfication api needs to work

View File

@ -1,6 +1,11 @@
#ifndef _ECORE_FB_H
#define _ECORE_FB_H
/**
* @file
* @brief Ecore frame buffer system functions.
*/
/* FIXME:
* maybe a new module?
* - code to get battery info

View File

@ -1,6 +1,11 @@
#ifndef _ECORE_IPC_H
#define _ECORE_IPC_H
/**
* @file Ecore_Ipc.h
* @brief Ecore inter-process communication functions.
*/
#define HAVE_ECORE_IPC_OPENSSL @USE_OPENSSL@
#if HAVE_ECORE_IPC_OPENSSL

View File

@ -1,6 +1,11 @@
#ifndef _ECORE_JOB_H
#define _ECORE_JOB_H
/**
* @file
* @brief Functions for dealing with Ecore jobs.
*/
#ifdef __cplusplus
extern "C" {
#endif

View File

@ -1,6 +1,11 @@
#ifndef _ECORE_TXT_H
#define _ECORE_TXT_H
/**
* @file Ecore_Txt.h
* @brief Provides a text encoding conversion function.
*/
#ifdef __cplusplus
extern "C" {
#endif

View File

@ -1,6 +1,11 @@
#ifndef _ECORE_X_H
#define _ECORE_X_H
/**
* @file
* @brief Ecore functions for dealing with the X Windows system
*/
typedef unsigned int Ecore_X_ID;
#ifndef _ECORE_X_WINDOW_PREDEF
typedef Ecore_X_ID Ecore_X_Window;

View File

@ -1,6 +1,11 @@
#ifndef _ECORE_X_CURSOR_H
#define _ECORE_X_CURSOR_H
/**
* @file
* @brief Defines the various cursor types for the X Windows system.
*/
#define ECORE_X_CURSOR_X 0
#define ECORE_X_CURSOR_ARROW 2
#define ECORE_X_CURSOR_BASED_ARROW_DOWN 4