get rid of emotion.dox and move to Emotion.h where all docs should be.

examples.dox is a slight issue atm.

git-svn-id: http://svn.enlightenment.org/svn/e/trunk/emotion@62032 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33

diff --git a/configure.ac b/configure.ac
index b59f891..13b8ed6 100644 (file)
--- a/configure.ac
+++ b/configure.ac
@@ -255,7 +255,6 @@ src/bin/Makefile
 src/examples/Makefile
 doc/Makefile
 doc/Doxyfile
-doc/emotion.dox
 data/Makefile
 ])
 

diff --git a/doc/emotion.dox.in b/doc/emotion.dox.in
deleted file mode 100644 (file)
index 61bb6a5..0000000
--- a/doc/emotion.dox.in
+++ /dev/null
@@ -1,65 +0,0 @@
-/**
- * @file
- * @brief Emotion Media Library
- *
- * These routines are used for Emotion.
- */
-
-/**
- *
- * @mainpage Emotion Library Documentation
- *
- * @image html e.png
- *
- * Emotion is a library that allows playing audio and video files, using one of
- * its backends (gstreamer or xine).
- *
- * It is integrated into Ecore through its mainloop, and is transparent to the
- * user of the library how the decoding of audio and video is being done. Once
- * the objects are created, the user can set callbacks to the specific events
- * and set options to this object, all in the main loop (no threads are needed).
- *
- * Emotion is also integrated with Evas. The emotion object returned by
- * emotion_object_add() is an Evas smart object, so it can be manipulated with
- * default Evas object functions. Callbacks can be added to the signals emitted
- * by this object with evas_object_smart_callback_add().
- *
- * @version @PACKAGE_VERSION@
- * @author Carsten Haitzler <raster@rasterman.com>
- * @author vtorri (Vincent Torri) <torri@maths.univ-evry.fr>
- * @author Sebastian Dransfeld <sd@tango.flipp.net>
- * @author captainigloo
- * @date 2003-2011
- *
- * @section intro What is Emotion?
- *
- * A media object library for Evas and Ecore.
- *
- * @section work How does Emotion work?
- *
- * The Emotion library uses Evas smart objects to allow you to manipulate the
- * created object as any other Evas object, and to connect to its signals,
- * handling them when needed. It's also possible to swallow Emotion objects
- * inside Edje themes, and expect it to behave as a normal image or rectangle
- * when regarding to its dimensions.
- *
- * To instantiate an Emotion object, the simple code below is enough:
- *
- * @code
- * em = emotion_object_add(e);
- * emotion_object_init(em, NULL);
- *
- * emotion_object_file_set(em, file_path);
- *
- * evas_object_move(em, 0, 0);
- * evas_object_resize(em, WIDTH, HEIGHT);
- * evas_object_show(em);
- *
- * emotion_object_play_set(em, EINA_TRUE);
- * @endcode
- *
- *
- * See the @ref Emotion_API for a better reference.
- *
- * @todo Complete documentation of API - in progress
- */

diff --git a/src/lib/Emotion.h b/src/lib/Emotion.h
index 9640a4d..3031b44 100644 (file)
--- a/src/lib/Emotion.h
+++ b/src/lib/Emotion.h
@@ -1,6 +1,70 @@
 #ifndef EMOTION_H
 #define EMOTION_H
 
+/**
+ * @file
+ * @brief Emotion Media Library
+ *
+ * These routines are used for Emotion.
+ */
+
+/**
+ *
+ * @mainpage Emotion Library Documentation
+ *
+ * @image html e.png
+ *
+ * Emotion is a library that allows playing audio and video files, using one of
+ * its backends (gstreamer or xine).
+ *
+ * It is integrated into Ecore through its mainloop, and is transparent to the
+ * user of the library how the decoding of audio and video is being done. Once
+ * the objects are created, the user can set callbacks to the specific events
+ * and set options to this object, all in the main loop (no threads are needed).
+ *
+ * Emotion is also integrated with Evas. The emotion object returned by
+ * emotion_object_add() is an Evas smart object, so it can be manipulated with
+ * default Evas object functions. Callbacks can be added to the signals emitted
+ * by this object with evas_object_smart_callback_add().
+ *
+ * @version 0.2.0
+ * @author Carsten Haitzler <raster@rasterman.com>
+ * @author Vincent Torri <torri@maths.univ-evry.fr>
+ * @author Nicolas Aguirre <aguirre.nicolas@gmail.com>
+ * @author Sebastian Dransfeld <sd@tango.flipp.net>
+ * @author Cedric Bail <cedric.bail@free.fr>
+ * @date 2003-2011
+ *
+ * @section intro What is Emotion?
+ *
+ * A media object library for Evas and Ecore.
+ *
+ * @section work How does Emotion work?
+ *
+ * The Emotion library uses Evas smart objects to allow you to manipulate the
+ * created object as any other Evas object, and to connect to its signals,
+ * handling them when needed. It's also possible to swallow Emotion objects
+ * inside Edje themes, and expect it to behave as a normal image or rectangle
+ * when regarding to its dimensions.
+ *
+ * To instantiate an Emotion object, the simple code below is enough:
+ *
+ * @code
+ * em = emotion_object_add(e);
+ * emotion_object_init(em, NULL);
+ *
+ * emotion_object_file_set(em, file_path);
+ *
+ * evas_object_move(em, 0, 0);
+ * evas_object_resize(em, WIDTH, HEIGHT);
+ * evas_object_show(em);
+ *
+ * emotion_object_play_set(em, EINA_TRUE);
+ * @endcode
+ *
+ * See the @ref Emotion_API for a better reference.
+ */
+
 #include <Evas.h>
 
 #ifdef EAPI