diff options
author | Rafael Antognolli <antognolli@gmail.com> | 2011-07-04 14:31:01 +0000 |
---|---|---|
committer | Rafael Antognolli <antognolli@gmail.com> | 2011-07-04 14:31:01 +0000 |
commit | ffcf50987fa92e2007d3c6e7cf5c0ad6df65c882 (patch) | |
tree | b85b6d4c4800f2758226b7a35c5dbf34ddfeb4d1 /legacy/emotion/doc | |
parent | 1d4852f11e989a375fd23d355735ccc7f70571d2 (diff) | |
download | efl-ffcf50987fa92e2007d3c6e7cf5c0ad6df65c882.tar.gz |
emotion - better introduction and link to emotion_test.
SVN revision: 61008
Diffstat (limited to 'legacy/emotion/doc')
-rw-r--r-- | legacy/emotion/doc/Doxyfile.in | 2 | ||||
-rw-r--r-- | legacy/emotion/doc/emotion.dox.in | 8 | ||||
-rw-r--r-- | legacy/emotion/doc/examples.dox | 6 |
3 files changed, 11 insertions, 5 deletions
diff --git a/legacy/emotion/doc/Doxyfile.in b/legacy/emotion/doc/Doxyfile.in index 853fce1390..33d7f3323f 100644 --- a/legacy/emotion/doc/Doxyfile.in +++ b/legacy/emotion/doc/Doxyfile.in @@ -69,7 +69,7 @@ RECURSIVE = NO EXCLUDE = EXCLUDE_SYMLINKS = NO EXCLUDE_PATTERNS = -EXAMPLE_PATH = @top_srcdir@/src/examples +EXAMPLE_PATH = @top_srcdir@/src/examples @top_srcdir@/src/bin EXAMPLE_PATTERNS = EXAMPLE_RECURSIVE = NO INPUT_FILTER = diff --git a/legacy/emotion/doc/emotion.dox.in b/legacy/emotion/doc/emotion.dox.in index dfbf4ce812..5d9000bc2f 100644 --- a/legacy/emotion/doc/emotion.dox.in +++ b/legacy/emotion/doc/emotion.dox.in @@ -12,10 +12,10 @@ * @image html e.png * * Emotion is a library that allows playing audio and video files, using one of - * its backends (gstreamer and xine). + * 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 happening. Once + * 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). * @@ -38,8 +38,8 @@ * @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 and - * process them when needed. It's also possible to swallow Emotion objects + * 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. * diff --git a/legacy/emotion/doc/examples.dox b/legacy/emotion/doc/examples.dox index 054608b338..5e193f166a 100644 --- a/legacy/emotion/doc/examples.dox +++ b/legacy/emotion/doc/examples.dox @@ -5,6 +5,7 @@ * * @li @ref emotion_basic_example_c * @li @ref emotion_signals_example.c "Emotion signals" + * @li @ref emotion_test_main.c "emotion_test - full API usage" * */ @@ -96,3 +97,8 @@ * signals are emitted can change depending on the module being used. Following * is the full source code of this example: */ + +/** + * @example emotion_test_main.c + * This example covers the entire emotion API. Use it as a reference. + */ |