forked from enlightenment/efl
add a table of content. "Next Steps" must be filled.
SVN revision: 47329
This commit is contained in:
parent
bb2462c3ab
commit
b1a89973df
|
@ -24,11 +24,16 @@ These routines are used for Eet Library interaction
|
||||||
@author Mathieu Taillefumier <mathieu.taillefumier@@free.fr>
|
@author Mathieu Taillefumier <mathieu.taillefumier@@free.fr>
|
||||||
@author Albin "Lutin" Tonnerre <albin.tonnerre@@gmail.com>
|
@author Albin "Lutin" Tonnerre <albin.tonnerre@@gmail.com>
|
||||||
@author Adam Simpkins <adam@@adamsimpkins.net>
|
@author Adam Simpkins <adam@@adamsimpkins.net>
|
||||||
|
|
||||||
@date 2000-2010
|
@date 2000-2010
|
||||||
|
|
||||||
|
@section toc Table of Contents
|
||||||
|
|
||||||
|
@li @ref intro
|
||||||
|
@li @ref example
|
||||||
|
@li @ref format
|
||||||
|
@li @ref next_steps
|
||||||
|
@li @ref intro_example
|
||||||
|
|
||||||
@section intro What is Eet?
|
@section intro What is Eet?
|
||||||
|
|
||||||
|
@ -51,10 +56,6 @@ machines, or just writing to arbitary files on the system. All data is
|
||||||
encoded in a platform independant way and can be written and read by any
|
encoded in a platform independant way and can be written and read by any
|
||||||
architecture.
|
architecture.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@section example A simple example on using Eet
|
@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
|
Here is a simple example on how to use Eet to save a series of strings to a
|
||||||
|
@ -106,10 +107,6 @@ main(int argc, char **argv)
|
||||||
}
|
}
|
||||||
@endcode
|
@endcode
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@section format What does an Eet file look like?
|
@section format What does an Eet file look like?
|
||||||
|
|
||||||
The file format is very simple. There is a directory block at the start of
|
The file format is very simple. There is a directory block at the start of
|
||||||
|
@ -191,9 +188,13 @@ information stored in data structures a simple 1 function call process.
|
||||||
Please see src/lib/eet_data.c for information on the format of these
|
Please see src/lib/eet_data.c for information on the format of these
|
||||||
specially encoded data entries in an Eet file (for now).
|
specially encoded data entries in an Eet file (for now).
|
||||||
|
|
||||||
|
@section next_steps Next Steps
|
||||||
|
|
||||||
|
to be filled...
|
||||||
|
|
||||||
|
@section intro_example Introductory Examples
|
||||||
|
|
||||||
|
@ref Examples
|
||||||
|
|
||||||
@todo Document data format for images and data structures.
|
@todo Document data format for images and data structures.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue