Index: src/lib/eet/Eet.h =================================================================== --- src/lib/eet/Eet.h (revision 76873) +++ src/lib/eet/Eet.h (working copy) @@ -1,147 +1,3 @@ -/** - @brief Eet Data Handling Library Public API Calls - - These routines are used for Eet Library interaction - - @mainpage Eet Library Documentation - - @version 1.7.0 - @date 2000-2012 - - Please see the @ref authors page for contact details. - - @section toc Table of Contents - - @li @ref intro - @li @ref example - @li @ref compiling - @li @ref install - @li @ref next_steps - @li @ref intro_example - - @section intro What is Eet? - - It is a tiny library designed to write an arbitrary set of chunks of data - to a file and optionally compress each chunk (very much like a zip file) - and allow fast random-access reading of the file later on. It does not - do zip as a zip itself has more complexity than is needed, and it was much - simpler to implement this once here. - - Eet is extremely fast, small and simple. Eet files can be very small and - highly compressed, making them very optimal for just sending across the - internet without having to archive, compress or decompress and install them. - They allow for lightning-fast random-access reads once created, making them - perfect for storing data that is written once (or rarely) and read many - times, but the program does not want to have to read it all in at once. - - It also can encode and decode data structures in memory, as well as image - data for saving to Eet files or sending across the network to other - machines, or just writing to arbitrary files on the system. All data is - encoded in a platform independent way and can be written and read by any - architecture. - - @section example A simple example on using Eet - - Here is a simple example on how to use Eet to save a series of strings to a - file and load them again. The advantage of using Eet over just - fprintf() and - fscanf() is that not only can these entries be strings, they need no special - parsing to handle delimiter characters or escaping, they can be binary data, - image data, data structures containing integers, strings, other data - structures, linked lists and much more, without the programmer having to - worry about parsing, and best of all, Eet is very fast. - - This is just a very simple example that doesn't show all of the capabilities - of Eet, but it serves to illustrate its simplicity. - - @include eet-basic.c - - @section compiling How to compile using Eet ? - - Eet is a library your application links to. The procedure for this is very - simple. You simply have to compile your application with the appropriate - compiler flags that the @p pkg-config script outputs. For example: - - Compiling C or C++ files into object files: - - @verbatim - gcc -c -o main.o main.c `pkg-config --cflags eet` - @endverbatim - - Linking object files into a binary executable: - - @verbatim - gcc -o my_application main.o `pkg-config --libs eet` - @endverbatim - - You simply have to make sure that pkg-config is in your shell's PATH (see - the manual page for your appropriate shell) and eet.pc in /usr/lib/pkgconfig - or its path is in the PKG_CONFIG_PATH environment variable. It's that simple - to link and use Eet once you have written your code to use it. - - Since the program is linked to Eet, it is now able to use any advertised - API calls to serialize your data. - - You should make sure you add any extra compile and link flags to your - compile commands that your application may need as well. The above example - is only guaranteed to make Eet add it's own requirements. - - - @section install How is it installed? - - Simple: - - @verbatim - ./configure - make - su - - ... - make install - @endverbatim - - @section next_steps Next Steps - - After you understood what Eet is and installed it in your system you - should proceed understanding the programming interface. We'd recommend - you to take a while to learn Eina - (http://docs.enlightenment.org/auto/eina/) as it is very convenient - and optimized, and Eet provides integration with it. - - Recommended reading: - - @li @ref Eet_File_Group to know the basics to open and save files. - @li @ref Eet_Data_Group to know the convenient way to serialize and - parse your data structures automatically. Just create your - descriptors and let Eet do the work for you. - - @section intro_example Introductory Examples - - @ref Examples - - @todo Document data format for images and data structures. - - */ - -/** - @page authors Authors - @author Carsten Haitzler - @author David Goodlad - @author Cedric Bail - @author Arnaud de Turckheim - @author Luis Felipe Strano Moraes - @author Chidambar Zinnoury - @author Vincent Torri - @author Gustavo Sverzut Barbieri - @author Raphael Kubo da Costa - @author Mathieu Taillefumier - @author Albin "Lutin" Tonnerre - @author Adam Simpkins - @author Mike Blumenkrantz - - Please contact to get in - contact with the developers and maintainers. - */ - #ifndef _EET_H #define _EET_H Index: src/lib/evil/Evil.h =================================================================== --- src/lib/evil/Evil.h (revision 76873) +++ src/lib/evil/Evil.h (working copy) @@ -2,48 +2,6 @@ #define __EVIL_H__ /** - * @mainpage Evil - * @image html e_big.png - * @author Vincent Torri - * @version 1.7.0 - * @date 2008-2012 - * - * @section intro_sec Introduction - * - * The Evil library is an evil library that ports some evil Unix - * functions to the Windows (XP or above, or Mobile) platform. The - * evilness is so huge that the most of the functions are not POSIX or - * BSD compliant. - * - * These functions are intended to be used in the Enlightenment - * Foundation Libraries only and can be compiled only on Windows, - * using MSYS/MinGW on Windows, and cross-compilation on Unix. This - * library is minimal in the sense that only the functions needed to - * compile the EFL are available. The purpose of this library is NOT - * to have a full POSIX emulation et it is NOT a replacement of - * cygwin. To compare the size of the DLL themselves, Evil is around - * 33 KB and cygwin DLL is around 800 KB. - * - * @section acknowledgments_sec Acknowledgments - * - * This library has receive some from people interested in the EFL or - * not. Among them, evil thanks to Lars Munch, Raoul Hecky, Nicolas - * Aguirre, Tor Lillqvist, Lance Fetters, Vincent Richomme, Paul - * Vixie, Daniel Stenberg, who helped the author of the library in - * different fields (code and tests). - * - * @section license_sec license - * - * The Evil library is distributes under a modified BSD license. See - * the files COPYING and COPYING-PLAIN in the top level directory for - * the full license text. - * - * @section reference_sec Reference API - * - * Use the horizontal menu above to navigate into the reference API - */ - -/** * @file Evil.h * @brief The file that provides miscellaneous functions ported from Unix. * @defgroup Evil Miscellaneous functions ported from Unix. Index: src/include/eina/Eina.h =================================================================== --- src/include/eina/Eina.h (revision 76873) +++ src/include/eina/Eina.h (working copy) @@ -44,55 +44,6 @@ */ /** - * @mainpage Eina - * - * @version 1.7 - * @date 2008-2012 - * - * @section eina_intro_sec Introduction - * - * The Eina library is a library that implements an API for data types - * in an efficient way. It also provides some useful tools like - * opening shared libraries, errors management, type conversion, - * time accounting and memory pool. - * - * This library is cross-platform and can be compiled and used on - * Linux, BSD, Opensolaris and Windows (XP and CE). - * - * The data types that are available are (see @ref Eina_Data_Types_Group): - * @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. - * @li @ref Eina_CList_Group Compact List. - * @li @ref Eina_List_Group standard list of @c void* data. - * @li @ref Eina_Iterator_Group Iterator functions. - * @li @ref Eina_Matrixsparse_Group sparse matrix of @c void* data. - * @li @ref Eina_Rbtree_Group red-black tree with nodes inlined into user type. - * @li @ref Eina_String_Buffer_Group mutable string to prepend, insert or append strings to a buffer. - * @li @ref Eina_Stringshare_Group saves memory by sharing read-only string references. - * @li @ref Eina_Tiler_Group split, merge and navigates into 2D tiled regions. - * @li @ref Eina_Trash_Group container of unused but allocated data. - * @li @ref Eina_Value_Group container for generic value storage and access. - * @li @ref Eina_Model_Group container for data with user defined hierarchy/structure. - * - * The tools that are available are (see @ref Eina_Tools_Group): - * @li @ref Eina_Benchmark_Group helper to write benchmarks. - * @li @ref Eina_Convert_Group faster conversion from strings to integers, double, etc. - * @li @ref Eina_Counter_Group measures number of calls and their time. - * @li @ref Eina_Error_Group error identifiers. - * @li @ref Eina_File_Group simple file list and path split. - * @li @ref Eina_Lalloc_Group simple lazy allocator. - * @li @ref Eina_Log_Group full-featured logging system. - * @li @ref Eina_Magic_Group provides runtime type checking. - * @li @ref Eina_Memory_Pool_Group abstraction for various memory allocators. - * @li @ref Eina_Module_Group lists, loads and share modules using Eina_Module standard. - * @li @ref Eina_Rectangle_Group rectangle structure and standard manipulation methods. - * @li @ref Eina_Safety_Checks_Group extra checks that will report unexpected conditions and can be disabled at compile time. - * @li @ref Eina_String_Group a set of functions that manages C strings. - * - * Please see the @ref authors page for contact details. - * * @defgroup Eina_Data_Types_Group Data Types * * Eina provide easy to use and optimized data types and structures. @@ -150,42 +101,8 @@ * * Eina tools aims to help application development, providing ways to * make it safer, log errors, manage memory more efficiently and more. - * */ -/** - * - * @page authors Authors - * - * @author Albin "Lutin" Tonnerre - * @author Alexandre "diaxen" Becoulet - * @author Andre Dieb - * @author Arnaud de Turckheim "quarium" - * @author Carsten Haitzler - * @author Cedric Bail - * @author Corey "atmos" Donohoe - * @author Vincent "caro" Torri - * @author Fabiano Fidêncio - * @author Gustavo Chaves - * @author Gustavo Sverzut Barbieri - * @author Jorge Luis "turran" Zapata - * @author Tilman Sauerbeck - * @author Peter "pfritz" Wehrfritz - * @author Raphael Kubo da Costa - * @author Tom Hacohen - * @author Brett Nash - * @author Sebastian Dransfeld - * @author Myungjae Lee - * @author Youness Alaoui - * @author Boris "billiob" Faure - * @author Sung W. Park - * @author Guillaume Friloux - * - * Please contact to get in - * contact with the developers and maintainers. - * - */ - #ifdef _WIN32 # include #endif Index: doc/Doxyfile.in =================================================================== --- doc/Doxyfile.in (revision 76873) +++ doc/Doxyfile.in (working copy) @@ -25,7 +25,7 @@ # The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. -PROJECT_NAME = Eina +PROJECT_NAME = Efl # The PROJECT_NUMBER tag can be used to enter a project or revision number. # This could be handy for archiving the generated documentation or @@ -599,7 +599,8 @@ # with spaces. INPUT = @top_srcdir@/src/include \ - @top_srcdir@/src/lib + @top_srcdir@/src/lib \ + @top_srcdir@/doc/efl.doxy # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is Index: doc/efl.doxy =================================================================== --- doc/efl.doxy (revision 0) +++ doc/efl.doxy (revision 0) @@ -0,0 +1,265 @@ +/** + * @mainpage Efl Documentation + * + * @section eina Eina + * + * @subsection eina_intro_sec Introduction + * + * The Eina library is a library that implements an API for data types + * in an efficient way. It also provides some useful tools like + * opening shared libraries, errors management, type conversion, + * time accounting and memory pool. + * + * This library is cross-platform and can be compiled and used on + * Linux, BSD, Opensolaris and Windows (XP and CE). + * + * The data types that are available are (see @ref Eina_Data_Types_Group): + * @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. + * @li @ref Eina_CList_Group Compact List. + * @li @ref Eina_List_Group standard list of @c void* data. + * @li @ref Eina_Iterator_Group Iterator functions. + * @li @ref Eina_Matrixsparse_Group sparse matrix of @c void* data. + * @li @ref Eina_Rbtree_Group red-black tree with nodes inlined into user type. + * @li @ref Eina_String_Buffer_Group mutable string to prepend, insert or append strings to a buffer. + * @li @ref Eina_Stringshare_Group saves memory by sharing read-only string references. + * @li @ref Eina_Tiler_Group split, merge and navigates into 2D tiled regions. + * @li @ref Eina_Trash_Group container of unused but allocated data. + * @li @ref Eina_Value_Group container for generic value storage and access. + * @li @ref Eina_Model_Group container for data with user defined hierarchy/structure. + * + * The tools that are available are (see @ref Eina_Tools_Group): + * @li @ref Eina_Benchmark_Group helper to write benchmarks. + * @li @ref Eina_Convert_Group faster conversion from strings to integers, double, etc. + * @li @ref Eina_Counter_Group measures number of calls and their time. + * @li @ref Eina_Error_Group error identifiers. + * @li @ref Eina_File_Group simple file list and path split. + * @li @ref Eina_Lalloc_Group simple lazy allocator. + * @li @ref Eina_Log_Group full-featured logging system. + * @li @ref Eina_Magic_Group provides runtime type checking. + * @li @ref Eina_Memory_Pool_Group abstraction for various memory allocators. + * @li @ref Eina_Module_Group lists, loads and share modules using Eina_Module standard. + * @li @ref Eina_Rectangle_Group rectangle structure and standard manipulation methods. + * @li @ref Eina_Safety_Checks_Group extra checks that will report unexpected conditions and can be disabled at compile time. + * @li @ref Eina_String_Group a set of functions that manages C strings. + * + * Please see the @ref authors_eina page for contact details. + + @section eet Eet Library Documentation + + Eet Data Handling Library Public API Calls + + These routines are used for Eet Library interaction + + @version 1.7.0 + @date 2000-2012 + + Please see the @ref authors_eet page for contact details. + + @subsection toc Table of Contents + + @li @ref intro + @li @ref example + @li @ref compiling + @li @ref install + @li @ref next_steps + @li @ref intro_example + + @subsection intro What is Eet? + + It is a tiny library designed to write an arbitrary set of chunks of data + to a file and optionally compress each chunk (very much like a zip file) + and allow fast random-access reading of the file later on. It does not + do zip as a zip itself has more complexity than is needed, and it was much + simpler to implement this once here. + + Eet is extremely fast, small and simple. Eet files can be very small and + highly compressed, making them very optimal for just sending across the + internet without having to archive, compress or decompress and install them. + They allow for lightning-fast random-access reads once created, making them + perfect for storing data that is written once (or rarely) and read many + times, but the program does not want to have to read it all in at once. + + It also can encode and decode data structures in memory, as well as image + data for saving to Eet files or sending across the network to other + machines, or just writing to arbitrary files on the system. All data is + encoded in a platform independent way and can be written and read by any + architecture. + + @subsection example A simple example on using Eet + + Here is a simple example on how to use Eet to save a series of strings to a + file and load them again. The advantage of using Eet over just + fprintf() and + fscanf() is that not only can these entries be strings, they need no special + parsing to handle delimiter characters or escaping, they can be binary data, + image data, data structures containing integers, strings, other data + structures, linked lists and much more, without the programmer having to + worry about parsing, and best of all, Eet is very fast. + + This is just a very simple example that doesn't show all of the capabilities + of Eet, but it serves to illustrate its simplicity. + + @include eet-basic.c + + @subsection compiling How to compile using Eet ? + + Eet is a library your application links to. The procedure for this is very + simple. You simply have to compile your application with the appropriate + compiler flags that the @p pkg-config script outputs. For example: + + Compiling C or C++ files into object files: + + @verbatim + gcc -c -o main.o main.c `pkg-config --cflags eet` + @endverbatim + + Linking object files into a binary executable: + + @verbatim + gcc -o my_application main.o `pkg-config --libs eet` + @endverbatim + + You simply have to make sure that pkg-config is in your shell's PATH (see + the manual page for your appropriate shell) and eet.pc in /usr/lib/pkgconfig + or its path is in the PKG_CONFIG_PATH environment variable. It's that simple + to link and use Eet once you have written your code to use it. + + Since the program is linked to Eet, it is now able to use any advertised + API calls to serialize your data. + + You should make sure you add any extra compile and link flags to your + compile commands that your application may need as well. The above example + is only guaranteed to make Eet add it's own requirements. + + + @subsection install How is it installed? + + Simple: + + @verbatim + ./configure + make + su - + ... + make install + @endverbatim + + @subsection next_steps Next Steps + + After you understood what Eet is and installed it in your system you + should proceed understanding the programming interface. We'd recommend + you to take a while to learn Eina + (http://docs.enlightenment.org/auto/eina/) as it is very convenient + and optimized, and Eet provides integration with it. + + Recommended reading: + + @li @ref Eet_File_Group to know the basics to open and save files. + @li @ref Eet_Data_Group to know the convenient way to serialize and + parse your data structures automatically. Just create your + descriptors and let Eet do the work for you. + + @subsection intro_example Introductory Examples + + @ref Examples + + @todo Document data format for images and data structures. + + + * @section evil Evil + * + * @image html e_big.png + * @author Vincent Torri + * @version 1.7.0 + * @date 2008-2012 + * + * @subsection intro_sec Introduction + * + * The Evil library is an evil library that ports some evil Unix + * functions to the Windows (XP or above, or Mobile) platform. The + * evilness is so huge that the most of the functions are not POSIX or + * BSD compliant. + * + * These functions are intended to be used in the Enlightenment + * Foundation Libraries only and can be compiled only on Windows, + * using MSYS/MinGW on Windows, and cross-compilation on Unix. This + * library is minimal in the sense that only the functions needed to + * compile the EFL are available. The purpose of this library is NOT + * to have a full POSIX emulation et it is NOT a replacement of + * cygwin. To compare the size of the DLL themselves, Evil is around + * 33 KB and cygwin DLL is around 800 KB. + * + * @subsection acknowledgments_sec Acknowledgments + * + * This library has receive some from people interested in the EFL or + * not. Among them, evil thanks to Lars Munch, Raoul Hecky, Nicolas + * Aguirre, Tor Lillqvist, Lance Fetters, Vincent Richomme, Paul + * Vixie, Daniel Stenberg, who helped the author of the library in + * different fields (code and tests). + * + * @subsection license_sec license + * + * The Evil library is distributes under a modified BSD license. See + * the files COPYING and COPYING-PLAIN in the top level directory for + * the full license text. + * + * @subsection reference_sec Reference API + * + * Use the horizontal menu above to navigate into the reference API + */ + +/** + * + * @page authors_eina Eina Authors + * + * @author Albin "Lutin" Tonnerre + * @author Alexandre "diaxen" Becoulet + * @author Andre Dieb + * @author Arnaud de Turckheim "quarium" + * @author Carsten Haitzler + * @author Cedric Bail + * @author Corey "atmos" Donohoe + * @author Vincent "caro" Torri + * @author Fabiano Fidêncio + * @author Gustavo Chaves + * @author Gustavo Sverzut Barbieri + * @author Jorge Luis "turran" Zapata + * @author Tilman Sauerbeck + * @author Peter "pfritz" Wehrfritz + * @author Raphael Kubo da Costa + * @author Tom Hacohen + * @author Brett Nash + * @author Sebastian Dransfeld + * @author Myungjae Lee + * @author Youness Alaoui + * @author Boris "billiob" Faure + * @author Sung W. Park + * @author Guillaume Friloux + * + * Please contact to get in + * contact with the developers and maintainers. + * + */ + +/** + @page authors_eet Eet Authors + @author Carsten Haitzler + @author David Goodlad + @author Cedric Bail + @author Arnaud de Turckheim + @author Luis Felipe Strano Moraes + @author Chidambar Zinnoury + @author Vincent Torri + @author Gustavo Sverzut Barbieri + @author Raphael Kubo da Costa + @author Mathieu Taillefumier + @author Albin "Lutin" Tonnerre + @author Adam Simpkins + @author Mike Blumenkrantz + + Please contact to get in + contact with the developers and maintainers. + */