Improve docs in Eet.h

By: Hanspeter Portner


SVN revision: 41307

legacy/eet/ChangeLog

@@ -190,3 +190,6 @@
 
 	* Reorder gcry init to be used during gnutls init.
 
+2009-07-11  Hanspeter Portner
+
+	* Improve docs/examples in Eet.h

legacy/eet/src/lib/Eet.h

@@ -187,6 +187,7 @@ extern "C" {
     * @code
     * #include <Eet.h>
     * #include <stdio.h>
+    * #include <string.h>
     *
     * int
     * main(int argc, char **argv)
@@ -195,6 +196,8 @@ extern "C" {
     *   char buf[1024], *ret, **list;
     *   int size, num, i;
     *
+    *   eet_init();
+    *
     *   strcpy(buf, "Here is a string of data to save!");
     *
     *   ef = eet_open("/tmp/my_file.eet", EET_FILE_MODE_WRITE);
@@ -220,6 +223,8 @@ extern "C" {
     *     }
     *   eet_close(ef);
     *
+    *   eet_shutdown();
+    *
     *   return 0;
     * }
     * @endcode
@@ -874,6 +879,8 @@ extern "C" {
     *    FILE *f;
     *    Blah *blah_in;
     *
+    *    eet_init();
+    *
     *    edd3 = eet_data_descriptor_new("blah3", sizeof(Blah3),
     *                                   eina_list_next,
     *                                   eina_list_append,
@@ -960,6 +967,8 @@ extern "C" {
     *    eet_data_descriptor_free(edd2);
     *    eet_data_descriptor_free(edd3);
     *
+    *    eet_shutdown();
+    *
     *   return 0;
     * }
     *