forked from enlightenment/efl
From: Guillaume Friloux <guillaume.friloux@asp64.com>
Hello again e people, i have play a bit with eina's comments to get proper namings and fix broken references. SVN revision: 67289
This commit is contained in:
parent
46c5dd5329
commit
537bc81acb
|
@ -20,3 +20,4 @@ Myungjae Lee <mjae.lee@samsung.com>
|
|||
Youness Alaoui <kakaroto@kakaroto.homelinux.net>
|
||||
billiob (Boris Faure) <billiob@gmail.com>
|
||||
Sung W. Park <sungwoo@gmail.com>
|
||||
Guillaume Friloux <guillaume.friloux@asp64.com>
|
||||
|
|
|
@ -59,7 +59,7 @@
|
|||
* Linux, BSD, Opensolaris and Windows (XP and CE).
|
||||
*
|
||||
* The data types that are available are (see @ref Eina_Data_Types_Group):
|
||||
* @li @ref Eina_Inarray_Group standard array of inlined members.
|
||||
* @li @ref Eina_Inline_Array_Group standard array of inlined members.
|
||||
* @li @ref Eina_Array_Group standard array of @c void* data.
|
||||
* @li @ref Eina_Hash_Group standard hash of @c void* data.
|
||||
* @li @ref Eina_Inline_List_Group list with nodes inlined into user type.
|
||||
|
|
|
@ -31,7 +31,7 @@
|
|||
|
||||
|
||||
/**
|
||||
* @page array_01_example_page Basic array usage
|
||||
* @page eina_array_01_example_page Basic array usage
|
||||
* @dontinclude eina_array_01.c
|
||||
*
|
||||
* For this example we add stdlib.h, stdio.h and string.h for some
|
||||
|
@ -94,7 +94,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @page array_02_example_page Removing array elements
|
||||
* @page eina_array_02_example_page Removing array elements
|
||||
* @dontinclude eina_array_02.c
|
||||
*
|
||||
* Just the usual includes:
|
||||
|
@ -191,8 +191,8 @@
|
|||
* of void pointers.
|
||||
*
|
||||
* See here some examples:
|
||||
* @li @ref array_01_example_page
|
||||
* @li @ref array_02_example_page
|
||||
* @li @ref eina_array_01_example_page
|
||||
* @li @ref eina_array_02_example_page
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
@ -25,7 +25,7 @@
|
|||
#include <stddef.h>
|
||||
|
||||
/**
|
||||
* @page inlist_01_example_page Eina_Inlist basic usage
|
||||
* @page eina_inlist_01_example_page Eina_Inlist basic usage
|
||||
* @dontinclude eina_inlist_01.c
|
||||
*
|
||||
* To see the full source for this example, click here: @ref
|
||||
|
@ -111,7 +111,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @page inlist_02_example_page Eina_Inlist advanced usage - lists and inlists
|
||||
* @page eina_inlist_02_example_page Eina_Inlist advanced usage - lists and inlists
|
||||
* @dontinclude eina_inlist_02.c
|
||||
*
|
||||
* This example describes the usage of @ref Eina_Inlist mixed with @ref
|
||||
|
@ -120,7 +120,7 @@
|
|||
* from this normal list.
|
||||
*
|
||||
* The struct that is going to be used is the same used in @ref
|
||||
* inlist_01_example_page , since we still need the @ref EINA_INLIST macro to
|
||||
* eina_inlist_01_example_page , since we still need the @ref EINA_INLIST macro to
|
||||
* declare the inlist node info:
|
||||
*
|
||||
* @skip struct
|
||||
|
@ -184,7 +184,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @page inlist_03_example_page Eina_Inlist advanced usage - multi-inlists
|
||||
* @page eina_inlist_03_example_page Eina_Inlist advanced usage - multi-inlists
|
||||
* @dontinclude eina_inlist_03.c
|
||||
*
|
||||
* This example describes the usage of multiple inlists storing the same data.
|
||||
|
@ -315,7 +315,7 @@
|
|||
* exactly what type this list is.
|
||||
*
|
||||
* A simple example demonstrating the basic usage of an inlist can be found
|
||||
* here: @ref inlist_01_example_page
|
||||
* here: @ref eina_inlist_01_example_page
|
||||
*
|
||||
* @section inlist_algo Algorithm
|
||||
*
|
||||
|
@ -368,9 +368,9 @@
|
|||
* @ref inlist_03_example_page
|
||||
*
|
||||
* List of examples:
|
||||
* @li @ref inlist_01_example_page
|
||||
* @li @ref inlist_02_example_page
|
||||
* @li @ref inlist_03_example_page
|
||||
* @li @ref eina_inlist_01_example_page
|
||||
* @li @ref eina_inlist_02_example_page
|
||||
* @li @ref eina_inlist_03_example_page
|
||||
*/
|
||||
|
||||
/**
|
||||
|
@ -787,6 +787,7 @@ EAPI Eina_Inlist *eina_inlist_sort(Eina_Inlist *head, Eina_Compare_Cb func);
|
|||
_EINA_INLIST_OFFSET(ref))
|
||||
#endif
|
||||
|
||||
/** Macro to iterate over an inlist */
|
||||
#define EINA_INLIST_FOREACH(list, l) \
|
||||
for (l = NULL, l = (list ? _EINA_INLIST_CONTAINER(l, list) : NULL); l; \
|
||||
l = (EINA_INLIST_GET(l)->next ? _EINA_INLIST_CONTAINER(l, EINA_INLIST_GET(l)->next) : NULL))
|
||||
|
|
|
@ -25,7 +25,7 @@
|
|||
#include "eina_magic.h"
|
||||
|
||||
/**
|
||||
* @page eina_iterator_example Eina_Iterator usage
|
||||
* @page eina_iterator_example_page Eina_Iterator usage
|
||||
* @dontinclude eina_iterator_01.c
|
||||
*
|
||||
* As always when using eina we need to include it:
|
||||
|
@ -48,7 +48,7 @@
|
|||
* @until eina_init
|
||||
*
|
||||
* Next we populate both an array and a list with our strings, for more details
|
||||
* see @ref eina_list_01_example and @ref eina_array_01_example:
|
||||
* see @ref eina_list_01_example_page and @ref eina_array_01_example_page :
|
||||
* @until }
|
||||
*
|
||||
* And now we create an array and because the first element of the container
|
||||
|
@ -63,7 +63,7 @@
|
|||
* iterator itself:
|
||||
* @until eina_iterator_free
|
||||
*
|
||||
* But so far you're not impressed in @ref eina_array_01_example an array is
|
||||
* But so far you're not impressed in @ref eina_array_01_example_page an array is
|
||||
* also printed, so now we go to the cool stuff and use an iterator to do same
|
||||
* stuff to a list:
|
||||
* @until eina_iterator_free
|
||||
|
@ -99,7 +99,7 @@
|
|||
* eina_iterator_next(). To call a function on all the elements of a
|
||||
* container, use eina_iterator_foreach().
|
||||
*
|
||||
* Here an @ref eina_iterator_example "example"
|
||||
* Here an @ref eina_iterator_example_page "example"
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
@ -29,7 +29,7 @@
|
|||
#include "eina_magic.h"
|
||||
|
||||
/**
|
||||
* @page list_01_example_page Adding elements to Eina_List
|
||||
* @page eina_list_01_example_page Adding elements to Eina_List
|
||||
* @dontinclude eina_list_01.c
|
||||
*
|
||||
* Creating an @ref Eina_List and adding elements to it is very easy and can be
|
||||
|
@ -99,11 +99,11 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @page list_02_example_page Sorting Eina_List elements
|
||||
* @page eina_list_02_example_page Sorting Eina_List elements
|
||||
* @dontinclude eina_list_02.c
|
||||
*
|
||||
* If you don't know how to create lists see
|
||||
* @ref list_01_example_page.
|
||||
* @ref eina_list_01_example_page.
|
||||
*
|
||||
* @skip #include
|
||||
* @until boomer
|
||||
|
@ -151,11 +151,11 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @page list_03_example_page Reordering Eina_List elments
|
||||
* @page eina_list_03_example_page Reordering Eina_List elments
|
||||
* @dontinclude eina_list_03.c
|
||||
*
|
||||
* If you don't know how to create lists see
|
||||
* @ref list_01_example_page.
|
||||
* @ref eina_list_01_example_page.
|
||||
*
|
||||
* We start out with code that should be familiar by now:
|
||||
* @skip #include
|
||||
|
@ -197,11 +197,11 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @page list_04_example_page Eina_List and memory allocation
|
||||
* @page eina_list_04_example_page Eina_List and memory allocation
|
||||
* @dontinclude eina_list_04.c
|
||||
*
|
||||
* If you don't know how to create lists see
|
||||
* @ref list_01_example_page. In this example we also use
|
||||
* @ref eina_list_01_example_page. In this example we also use
|
||||
* @ref Eina_Stringshare_Group, however it should be possible to understand the code
|
||||
* regardless of previous knowledge about it.
|
||||
*
|
||||
|
@ -276,10 +276,10 @@
|
|||
* list as the list!
|
||||
*
|
||||
* Here are some examples of @ref Eina_List usage:
|
||||
* @li @ref list_01_example_page
|
||||
* @li @ref list_02_example_page
|
||||
* @li @ref list_03_example_page
|
||||
* @li @ref list_04_example_page
|
||||
* @li @ref eina_list_01_example_page
|
||||
* @li @ref eina_list_02_example_page
|
||||
* @li @ref eina_list_03_example_page
|
||||
* @li @ref eina_list_04_example_page
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
@ -119,16 +119,16 @@ struct _Eina_Simple_XML_Node_Data
|
|||
|
||||
typedef enum _Eina_Simple_XML_Type
|
||||
{
|
||||
EINA_SIMPLE_XML_OPEN = 0, /* <tag attribute="value"> */
|
||||
EINA_SIMPLE_XML_OPEN_EMPTY, /* <tag attribute="value" /> */
|
||||
EINA_SIMPLE_XML_CLOSE, /* </tag> */
|
||||
EINA_SIMPLE_XML_DATA, /* tag text data */
|
||||
EINA_SIMPLE_XML_CDATA, /* <![CDATA[something]]> */
|
||||
EINA_SIMPLE_XML_ERROR, /* error contents */
|
||||
EINA_SIMPLE_XML_PROCESSING, /* <?xml ... ?> <?php .. ?> */
|
||||
EINA_SIMPLE_XML_DOCTYPE, /* <!DOCTYPE html */
|
||||
EINA_SIMPLE_XML_COMMENT, /* <!-- something --> */
|
||||
EINA_SIMPLE_XML_IGNORED /* whatever is ignored by parser, like whitespace */
|
||||
EINA_SIMPLE_XML_OPEN = 0, /*!< <tag attribute="value"> */
|
||||
EINA_SIMPLE_XML_OPEN_EMPTY, /*!< <tag attribute="value" /> */
|
||||
EINA_SIMPLE_XML_CLOSE, /*!< </tag> */
|
||||
EINA_SIMPLE_XML_DATA, /*!< tag text data */
|
||||
EINA_SIMPLE_XML_CDATA, /*!< <![CDATA[something]]> */
|
||||
EINA_SIMPLE_XML_ERROR, /*!< error contents */
|
||||
EINA_SIMPLE_XML_PROCESSING, /*!< <?xml ... ?> <?php .. ?> */
|
||||
EINA_SIMPLE_XML_DOCTYPE, /*!< <!DOCTYPE html */
|
||||
EINA_SIMPLE_XML_COMMENT, /*!< <!-- something --> */
|
||||
EINA_SIMPLE_XML_IGNORED /*!< whatever is ignored by parser, like whitespace */
|
||||
} Eina_Simple_XML_Type;
|
||||
|
||||
typedef Eina_Bool (*Eina_Simple_XML_Cb)(void *data, Eina_Simple_XML_Type type, const char *content, unsigned offset, unsigned length);
|
||||
|
|
|
@ -75,7 +75,7 @@ EAPI Eina_Unicode *eina_unicode_strdup(const Eina_Unicode *text) EINA_WARN_UNUSE
|
|||
* @return The duplicated string.
|
||||
*
|
||||
* This function duplicates @p text. The resuting string is cut on @p
|
||||
* n. @p n is assumed to be lesser (<) than the length of @t
|
||||
* n. @p n is assumed to be lesser (<) than the length of @p
|
||||
* text. When not needed anymore, the returned string must be freed.
|
||||
*
|
||||
* @since 1.1.0
|
||||
|
|
Loading…
Reference in New Issue