examples/evas: streamline the intro description statement for examples

Summary:
For people browing through the examples, having the opening statement be
concise and consistent will help them more quickly find what they're
looking for.

Signed-off-by: Bryce Harrington <bryce@osg.samsung.com>

Test Plan:
Some of the examples had identical opening statements (e.g. the image
object examples).  I've tried to give each a unique description defining
what they are demonstrating, but you may want to doublecheck I got these
correct.  Of particular note, to me evas-images5.c looks like just a
fixup to evas-images4.c, so I'm not sure what makes these two distinct.

Subscribers: cedric, jpeg

Differential Revision: https://phab.enlightenment.org/D4861

Signed-off-by: Cedric BAIL <cedric@osg.samsung.com>

src/examples/evas/evas-3d-aabb.c

@@ -1,5 +1,5 @@
 /**
- * This example shows how to get and draw axis-aligned bounding box.
+ * Example of getting and drawing an axis-aligned bounding box in Evas-3D.
  *
  * @see _redraw_aabb();
  * Rotate axes (keys 1-4) for model and bounding box view from another angle.

src/examples/evas/evas-3d-blending.c

@@ -1,5 +1,7 @@
 /**
- * Example illustrating usage of blending modes. Press "Up" or "Down" key for change source blending factor.
+ * Example of different blending modes in Evas-3D.
+ *
+ * Press "Up" or "Down" key for change source blending factor.
  * Press "Left" or "Right" for change destination blending factors.
  * For more details see https://www.opengl.org/sdk/docs/man2/xhtml/glBlendFunc.xml
  *
@@ -8,7 +10,6 @@
  * @endverbatim
  */
 
-
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #else

src/examples/evas/evas-3d-colorpick.c

@@ -1,5 +1,6 @@
 /**
- * This example shows how to use color pick algorithm for finding node at scene.
+ * Example of finding nodes by color or geometry in an Evas-3D scene.
+ *
  * Enable color pick mode of meshes and scene objects.
  * Click (left for color pick, right for geometry pick) on 3D object and see
  * in terminal time response of the found node.

src/examples/evas/evas-3d-cube-rotate.c

@@ -1,5 +1,5 @@
 /**
- * This example shows how the work of events with callback of the mouse could be useful in node rotation.
+ * Example of using mouse callback events for node rotation in Evas-3D.
  *
  * After clicking the mouse on cube callbacks began to emit automatically,
  * depending on mouse's position change the cube rotates with a certain

src/examples/evas/evas-3d-cube.c

@@ -1,5 +1,5 @@
 /**
- * Simple Evas-3D example illustrating how to create simple mesh without any loading.
+ * Example of creating simple meshes in Evas-3D.
  *
  * This example is the best to start introduction to usage of Evas-3D.
  *

src/examples/evas/evas-3d-cube2.c

@@ -1,6 +1,5 @@
 /**
- * Simple Evas-3D example illustrating usage of normal mapping and animation created
+ * Example of frame interpolation animation with normal mapping in Evas 3D.
- * by interpolation between frames.
  *
  * @verbatim
  * gcc -o evas-3d-cube2 evas-3d-cube2.c `pkg-config --libs --cflags efl evas ecore ecore-evas eo` -lm

src/examples/evas/evas-3d-eet.c

@@ -1,5 +1,5 @@
 /**
- * Simple Evas example illustrating .eet import/export
+ * Example of .eet file format import/export in Evas-3D.
  *
  * Take mesh from md2.
  * Set material to it.

src/examples/evas/evas-3d-fog.c

@@ -1,5 +1,5 @@
 /**
- * Example illustrating usage of fog effect.
+ * Example of applying a fog effect in Evas-3D.
  *
  * @verbatim
  * gcc -o evas-3d-fog evas-3d-fog.c `pkg-config --libs --cflags efl evas ecore ecore-evas eo` -lm

src/examples/evas/evas-3d-frustum.c

@@ -1,5 +1,6 @@
 /**
- * This example shows how to work frustum culling.
+ * Example of frustum culling in Evas-3D.
+ *
  * Use 'w'/'s' key to move far frustum plane from/to the camera.
  * Use 't'/'g' key to move near frustum plane from/to the camera.
  * Use '1'/'2' key to set camera to the first/second position.

src/examples/evas/evas-3d-hull.c

@@ -1,7 +1,9 @@
 /**
- * This example is a testing example, first model (from the right side) is
+ * Example to test convex hull models made in Evas-3D vs. Blender.
- * original model, the second one is convex hull made in evas-3d,
+ *
- * the third one is convex hull made in blender.
+ * The first model (from the right side) is the original model, the
+ * second one is a convex hull made in Evas-3D, and the third one is a
+ * convex hull made in Blender.
  *
  * Press "Right" or "Left" to switch models, the result of test (vertex count)
  * will be printed in console window.

src/examples/evas/evas-3d-md2.c

@@ -1,5 +1,5 @@
 /**
- * Simple Evas-3D example illustrating import from .md2 format.
+ * Example of .md2 file format import in Evas-3D.
  *
  * @verbatim
  * gcc -o evas-3d-md2 evas-3d-md2.c `pkg-config --libs --cflags efl evas ecore ecore-evas eo`

src/examples/evas/evas-3d-mmap-set.c

@@ -1,5 +1,5 @@
 /**
- * Simple Evas example illustrating import from mmap.
+ * Example of mmap import in Evas-3D.
  *
  * Open files to Eina_Files.
  * Read meshes from Eina_Files.

src/examples/evas/evas-3d-obj.c

@@ -1,5 +1,6 @@
 /**
- * Simple Evas example illustrating import/export of .obj format.
+ * Example of .obj file format import in Evas-3D.
+ *
  * Example demonstrates possibility to load and save mesh without tex_coords or/and normals.
  *
  * Read mesh from "sweet_home(parameters).obj".

src/examples/evas/evas-3d-parallax-occlusion.c

@@ -1,5 +1,5 @@
 /**
- * Example illustrating usage of parallax occlusion shading and texture animation.
+ * Example of parallax occlusion shading and texture animation in Evas-3D.
  *
  * Press "n" for use normal mapping shading. Pres "p" for use parallax occlusion mapping shading.
  *

src/examples/evas/evas-3d-pick.c

@@ -1,5 +1,5 @@
 /**
- * This example shows how to attach mechanism of pick.
+ * Example of picking nodes and meshes by screen coordinates using Evas-3D.
  *
  * Here shown which transformation should be applied to event_info of
  * _on_mouse_down to make them usable in evas_canvas3d_scene_pick()

src/examples/evas/evas-3d-ply.c

@@ -1,5 +1,5 @@
 /**
- * Simple Evas example illustrating import/export of .ply format.
+ * Example of .ply file format import/export in Evas-3D.
  *
  * Read meshes from "tested_man_all_with_mods.ply", "tested_man_only_geometry.ply" and "tested_man_without_UVs.ply".
  * After that change some properties of material.

src/examples/evas/evas-3d-proxy.c

@@ -1,5 +1,5 @@
 /**
- * Evas-3D example illustrating usage of evas_canvas3d_texture_source_set()
+ * Example of setting the texture source of an object in Evas-3D.
  *
  * Data which will be used as texture can be generated directly in application.
  *

src/examples/evas/evas-3d-shadows.c

@@ -1,6 +1,9 @@
 /**
+ * Example of setting up an animated Evas-3D scene with lighting and anti-aliasing.
+ *
  * This example illustrates use of shadows, callbacks(clicked, collision),
  * technic of the billboard and post proccesing render with anti-aliasing.
+ *
  * Model and cube are clickable. Model detects collision with sphere.
  * Cube detects collision with sphere, model and cone. Model and cude are moveable.
  * @see evas_canvas3d_scene_shadows_enable_set(Eina_Bool _shadows_enabled)

src/examples/evas/evas-3d-static-lod.c

@@ -1,5 +1,6 @@
 /**
- * This example illustrates using static LOD technic.
+ * Example of static LOD techniques in Evas-3D.
+ *
  * Main idea using several meshes with different quantity of polygons,
  * render mesh depends on distance to the camera node.
  * Use key up/down to change animtion style:

src/examples/evas/evas-aspect-hints.c

@@ -1,5 +1,5 @@
 /**
- * Simple Evas example illustrating aspect control hints on objects.
+ * Example of aspect control hints on objects in Evas.
  *
  * You'll need at least one engine built for it (excluding the buffer
  * one) and the png image loader also built. See stdout/stderr for

src/examples/evas/evas-box.c

@@ -1,5 +1,5 @@
 /**
- * Simple Evas example illustrating a custom Evas box object
+ * Example of custom box objects in Evas.
  *
  * You'll need at least one engine built for it (excluding the buffer
  * one). See stdout/stderr for output.

src/examples/evas/evas-buffer-simple.c

@@ -1,5 +1,5 @@
 /**
- * Simple Evas example using the Buffer engine.
+ * Example of using the buffer engine in Evas.
  *
  * You must have Evas compiled with the buffer engine, and have the
  * evas-software-buffer pkg-config files installed.

src/examples/evas/evas-events.c

@@ -1,6 +1,5 @@
 /**
- * Simple Evas example illustrating how to interact with canvas' (and
+ * Example of using callbacks to interact with the canvas and its objects in Evas.
- * its objects') events and other canvas operations.
  *
  * You'll need at least one engine built for it (excluding the buffer
  * one) and the png image loader also built. See stdout/stderr for

src/examples/evas/evas-gl.c

@@ -1,5 +1,5 @@
 /**
- * Evas example illustrating work with GL APIs.
+ * Example of working with OpenGL APIs in Evas.
  *
  * Evas_GL.h should be added for Evas GL APIs access.
  *

src/examples/evas/evas-hints.c

@@ -1,6 +1,8 @@
 /**
- * Simple Evas example illustrating <b>alignment, minimum size, maximum
+ * Example of setting hints on objects in Evas.
- * size, padding and weight</b> hints on objects.
+ *
+ * Object hints shown include <b>alignment, minimum size, maximum size,
+ * padding and weight</b>.
  *
  * To exemplify those hints, whe use the Evas box object, one of the
  * managers using size hints to layout its children.

src/examples/evas/evas-images.c

@@ -1,5 +1,5 @@
 /**
- * Simple Evas example illustrating some image objects functions
+ * Example of changing fills and borders for image objects in Evas.
  *
  * You'll need at least one engine built for it (excluding the buffer
  * one) and the png image loader also built. See stdout/stderr for

src/examples/evas/evas-images2.c

@@ -1,5 +1,5 @@
 /**
- * Simple Evas example illustrating some image objects functions
+ * Example of handling events for image objects in Evas.
  *
  * You'll need at least one engine built for it (excluding the buffer
  * one) and the png image loader/saver also built. See stdout/stderr

src/examples/evas/evas-images3.c

@@ -1,5 +1,5 @@
 /**
- * Simple Evas example illustrating some image objects functions
+ * Example saving data for modified image objects to disk with Evas.
  *
  * You'll need at least one engine built for it (excluding the buffer
  * one) and the png image loader/saver also built. See stdout/stderr

src/examples/evas/evas-images4.c

@@ -1,5 +1,5 @@
 /**
- * Simple Evas example illustrating some image objects functions
+ * Example of rotating and flipping image objects in Evas.
  *
  * You'll need at least one engine built for it (excluding the buffer
  * one) and the png image loader/saver also built. See stdout/stderr

src/examples/evas/evas-images5.c

@@ -1,5 +1,5 @@
 /**
- * Simple Evas example illustrating some image objects functions
+ * Example of rotating and flipping image objects in Evas.
  *
  * You'll need at least one engine built for it (excluding the buffer
  * one) and the png image loader/saver also built. See stdout/stderr

src/examples/evas/evas-init-shutdown.c

@@ -1,8 +1,9 @@
 /**
- * Simple example illustrating usage of evas_init() and
+ * Example of initializing and shutting down Evas.
- * evas_shutdown(). Usually one would instantiate a canvas to have
+ *
- * something useful out of Evas. For an example of this kind, see the
+ * Usually one would instantiate a canvas to have something useful out
- * @ref Example_Evas_Buffer_Simple.
+ * of Evas. For an example of this kind, see the @ref
+ * Example_Evas_Buffer_Simple.
  *
  * Here, we are just listing the engine Evas was compiled with support
  * to.

src/examples/evas/evas-map-aa-eo.c

@@ -1,6 +1,5 @@
 /**
- * Example showing the difference between Evas Map with and without
+ * Example comparing map with and without anti-aliasing (AA) with an Eo-styled Evas API.
- * anti-aliasing (AA).
  *
  * @verbatim
  * gcc -o evas_map_aa_eo evas-map-aa-eo.c `pkg-config --libs --cflags evas ecore ecore-evas eina`

src/examples/evas/evas-map-aa.c

@@ -1,6 +1,5 @@
 /**
- * Example showing the difference between Evas Map with and without
+ * Example comparing map with and without anti-aliasing (AA) in Evas.
- * anti-aliasing (AA).
  *
  * @verbatim
  * gcc -o evas-map-aa evas-map-aa.c `pkg-config --libs --cflags evas ecore ecore-evas eina`

src/examples/evas/evas-map-utils-eo.c

@@ -1,5 +1,5 @@
 /**
- * Simple Evas example illustrating basic map utils.
+ * Example of basic map utils with an Eo-styled Evas API.
  *
  * You'll need at least one engine built for it (excluding the buffer
  * one). See stdout/stderr for output.

src/examples/evas/evas-map-utils.c

@@ -1,5 +1,5 @@
 /**
- * Simple Evas example illustrating basic map utils.
+ * Example of basic map utils in Evas.
  *
  * You'll need at least one engine built for it (excluding the buffer
  * one). See stdout/stderr for output.

src/examples/evas/evas-multi-touch.c

@@ -1,5 +1,5 @@
 /**
- * Simple Evas example illustrating usage of multi touch.
+ * Example of multi-touch in Evas.
  *
  * You'll need at least one engine built for it (excluding the buffer
  * one) and the png image loader also built.

src/examples/evas/evas-multiseat-events.c

@@ -1,5 +1,7 @@
 /**
- * Evas example illustrating how to handle events with multiseat information:
+ * Example of handling events with multiseat information in Evas.
+ *
+ * Illustrates handling of:
  *    * mouse events
  *    * keyboard events
  *    * focus events

src/examples/evas/evas-object-manipulation-eo.c

@@ -1,8 +1,5 @@
 /**
- * Porting evas-object-manipulation.c example
+ * Example of basic object manipulation with an Eo-styled Evas API.
- * to use Eo-styled Evas API.
- *
- * Simple Evas example illustrating basic objects manipulation.
  *
  * You'll need at least one engine built for it (excluding the buffer
  * one) and the png image loader also built. See stdout/stderr for

src/examples/evas/evas-object-manipulation.c

@@ -1,5 +1,5 @@
 /**
- * Simple Evas example illustrating basic objects manipulation.
+ * Example of basic object manipulation in Evas.
  *
  * You'll need at least one engine built for it (excluding the buffer
  * one) and the png image loader also built. See stdout/stderr for

src/examples/evas/evas-smart-interface.c

@@ -1,5 +1,5 @@
 /**
- * Simple Evas example illustrating Evas smart interfaces
+ * Example of smart interfaces in Evas.
  *
  * You'll need at least one engine built for it (excluding the buffer
  * one). See stdout/stderr for output.

src/examples/evas/evas-smart-object.c

@@ -1,5 +1,5 @@
 /**
- * Simple Evas example illustrating a custom Evas smart object
+ * Example of custom smart objects in Evas.
  *
  * You'll need at least one engine built for it (excluding the buffer
  * one). See stdout/stderr for output.

src/examples/evas/evas-stacking.c

@@ -1,6 +1,5 @@
 /**
- * Simple Evas example illustrating <b>objects stacking</b> and
+ * Example of <b>object stacking</b> and <b>canvas layers</b> in Evas.
- * <b>canvas layers</b>.
  *
  * You'll need at least one engine built for it (excluding the buffer
  * one) and the png image loader also built. See stdout/stderr for

src/examples/evas/evas-table.c

@@ -1,5 +1,5 @@
 /**
- * Simple Evas example illustrating usage of table object.
+ * Example of table objects in Evas.
  *
  * You'll need at least one engine built for it (excluding the buffer
  * one) and the png image loader also built.

src/examples/evas/evas-text.c

@@ -1,5 +1,5 @@
 /**
- * Simple Evas example illustrating text objects
+ * Example of text objects in Evas.
  *
  * You'll need at least one engine built for it (excluding the buffer
  * one). See stdout/stderr for output.

src/examples/evas/evas-textblock-obstacles.c

@@ -1,5 +1,5 @@
 /**
- * Evas textblock example for obstacles feature
+ * Example of textblock obstacles in Evas.
  *
  * You'll need at least one engine built for it (excluding the buffer
  * one). See stdout/stderr for output.

src/examples/evas/evas-transparent.c

@@ -1,5 +1,5 @@
 /**
- * Simple Evas example illustrating a trasnparent window
+ * Example of transparent windows in Evas.
  *
  * @verbatim
  * gcc -o evas-transparent evas-transparent.c `pkg-config --libs --cflags evas ecore ecore-evas eina`

src/examples/evas/evas-vg-batman.c

@@ -1,5 +1,5 @@
 /**
- * Simple Evas example illustrating the use of Evas_VG animation
+ * Example of animation using Evas_VG.
  *
  * You'll need at least one engine built for it (excluding the buffer
  * one). See stdout/stderr for output.

src/examples/evas/evas-vg-simple.c

@@ -1,5 +1,5 @@
 /**
- * Simple Evas example illustrating a Evas_VG basic node usage.
+ * Example of basic nodes in Evas_VG.
  *
  * You'll need at least one engine built for it (excluding the buffer
  * one). See stdout/stderr for output.