summaryrefslogtreecommitdiff
path: root/legacy/eet/doc
diff options
context:
space:
mode:
authorVincent Torri <vincent.torri@gmail.com>2010-03-18 21:32:34 +0000
committerVincent Torri <vincent.torri@gmail.com>2010-03-18 21:32:34 +0000
commitb1a89973df44fa3399f40a20106b3649d7add20f (patch)
treea9cd8c11dd9d06dea272dd402cecdc515fd013a8 /legacy/eet/doc
parentbb2462c3ab681ed79f1d4e93a0d957bc17c7b27f (diff)
add a table of content. "Next Steps" must be filled.
SVN revision: 47329
Diffstat (limited to 'legacy/eet/doc')
-rw-r--r--legacy/eet/doc/eet.dox.in21
1 files changed, 11 insertions, 10 deletions
diff --git a/legacy/eet/doc/eet.dox.in b/legacy/eet/doc/eet.dox.in
index 8847fb40ed..9922fdb3ef 100644
--- a/legacy/eet/doc/eet.dox.in
+++ b/legacy/eet/doc/eet.dox.in
@@ -24,11 +24,16 @@ These routines are used for Eet Library interaction
24@author Mathieu Taillefumier <mathieu.taillefumier@@free.fr> 24@author Mathieu Taillefumier <mathieu.taillefumier@@free.fr>
25@author Albin "Lutin" Tonnerre <albin.tonnerre@@gmail.com> 25@author Albin "Lutin" Tonnerre <albin.tonnerre@@gmail.com>
26@author Adam Simpkins <adam@@adamsimpkins.net> 26@author Adam Simpkins <adam@@adamsimpkins.net>
27@date 2000-2010
28
29 27
28@date 2000-2010
30 29
30@section toc Table of Contents
31 31
32@li @ref intro
33@li @ref example
34@li @ref format
35@li @ref next_steps
36@li @ref intro_example
32 37
33@section intro What is Eet? 38@section intro What is Eet?
34 39
@@ -51,10 +56,6 @@ machines, or just writing to arbitary files on the system. All data is
51encoded in a platform independant way and can be written and read by any 56encoded in a platform independant way and can be written and read by any
52architecture. 57architecture.
53 58
54
55
56
57
58@section example A simple example on using Eet 59@section example A simple example on using Eet
59 60
60Here is a simple example on how to use Eet to save a series of strings to a 61Here 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)
106} 107}
107@endcode 108@endcode
108 109
109
110
111
112
113@section format What does an Eet file look like? 110@section format What does an Eet file look like?
114 111
115The file format is very simple. There is a directory block at the start of 112The 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.
191Please see src/lib/eet_data.c for information on the format of these 188Please see src/lib/eet_data.c for information on the format of these
192specially encoded data entries in an Eet file (for now). 189specially encoded data entries in an Eet file (for now).
193 190
191@section next_steps Next Steps
194 192
193to be filled...
195 194
195@section intro_example Introductory Examples
196 196
197@ref Examples
197 198
198@todo Document data format for images and data structures. 199@todo Document data format for images and data structures.
199 200