From b1a89973df44fa3399f40a20106b3649d7add20f Mon Sep 17 00:00:00 2001 From: Vincent Torri Date: Thu, 18 Mar 2010 21:32:34 +0000 Subject: [PATCH] add a table of content. "Next Steps" must be filled. SVN revision: 47329 --- legacy/eet/doc/eet.dox.in | 21 +++++++++++---------- 1 file 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 @author Mathieu Taillefumier @author Albin "Lutin" Tonnerre @author Adam Simpkins + @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? @@ -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 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 @@ -106,10 +107,6 @@ main(int argc, char **argv) } @endcode - - - - @section format What does an Eet file look like? 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 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.