summaryrefslogtreecommitdiff
path: root/src/lib/ephysics/EPhysics.h
diff options
context:
space:
mode:
authorGustavo Sverzut Barbieri <barbieri@gmail.com>2013-01-03 22:10:40 +0000
committerGustavo Sverzut Barbieri <barbieri@gmail.com>2013-01-03 22:10:40 +0000
commit9e0788cc2e261ec66cf740e35a3e71f4485df763 (patch)
tree8c1230e446edd6966d39c1b8959c7f97f5c0f731 /src/lib/ephysics/EPhysics.h
parent9edec477ebb83e64f3e464d82665e2b9f01f9bb0 (diff)
efl: merge ephysics
changes: * __UNUSED__ -> EINA_UNUSED * Fixed doc hierarchy SVN revision: 82126
Diffstat (limited to '')
-rw-r--r--src/lib/ephysics/EPhysics.h (renamed from legacy/ephysics/src/lib/EPhysics.h)61
1 files changed, 42 insertions, 19 deletions
diff --git a/legacy/ephysics/src/lib/EPhysics.h b/src/lib/ephysics/EPhysics.h
index e7fc6a8f04..90ea09f046 100644
--- a/legacy/ephysics/src/lib/EPhysics.h
+++ b/src/lib/ephysics/EPhysics.h
@@ -2,12 +2,18 @@
2#define EPHYSICS_H 2#define EPHYSICS_H
3 3
4/** 4/**
5 * @mainpage EPhysics Library Documentation 5 * @page ephysics_main EPhysics
6 * 6 *
7 * @version 0.1.0 7 * @date 2012 (created)
8 * @date 2012
9 * 8 *
10 * @section intro What is EPhysics ? 9 * @section toc Table of Contents
10 *
11 * @li @ref ephysics_main_intro
12 * @li @ref ephysics_main_compiling
13 * @li @ref ephysics_main_next_steps
14 * @li @ref ephysics_main_intro_example
15 *
16 * @section ephysics_main_intro Introduction
11 * 17 *
12 * EPhysics is a library that makes it easy to use Ecore, Evas and Bullet 18 * EPhysics is a library that makes it easy to use Ecore, Evas and Bullet
13 * Physics together. It's a kind of wrapper, a glue, between these libraries. 19 * Physics together. It's a kind of wrapper, a glue, between these libraries.
@@ -16,7 +22,33 @@
16 * @image html diagram_ephysics.png 22 * @image html diagram_ephysics.png
17 * @image latex diagram_ephysics.eps 23 * @image latex diagram_ephysics.eps
18 * 24 *
19 * For a better reference, check the following groups: 25 * @section ephysics_main_compiling How to compile
26 *
27 * Ephysics is a library your application links to. The procedure for this is
28 * very simple. You simply have to compile your application with the
29 * appropriate compiler flags that the @c pkg-config script outputs. For
30 * example:
31 *
32 * Compiling C or C++ files into object files:
33 *
34 * @verbatim
35 gcc -c -o main.o main.c `pkg-config --cflags ephysics`
36 @endverbatim
37 *
38 * Linking object files into a binary executable:
39 *
40 * @verbatim
41 gcc -o my_application main.o `pkg-config --libs ephysics`
42 @endverbatim
43 *
44 * See @ref pkgconfig
45 *
46 * @section ephysics_main_next_steps Next Steps
47 *
48 * After you understood what EPhysics is and installed it in your system
49 * you should proceed understanding the programming interface.
50 *
51 * Recommended reading:
20 * @li @ref EPhysics 52 * @li @ref EPhysics
21 * @li @ref EPhysics_World 53 * @li @ref EPhysics_World
22 * @li @ref EPhysics_Body 54 * @li @ref EPhysics_Body
@@ -25,20 +57,11 @@
25 * @li @ref EPhysics_Quaternion 57 * @li @ref EPhysics_Quaternion
26 * @li @ref EPhysics_Shape 58 * @li @ref EPhysics_Shape
27 * 59 *
28 * Please see the @ref authors page for contact details. 60 * @section ephysics_main_intro_example Introductory Example
29 */
30
31/**
32 *
33 * @page authors Authors
34 *
35 * @author Bruno Dilly <bdilly@@profusion.mobi>
36 * @author Leandro Dorileo <dorileo@@profusion.mobi>
37 * @author Ricardo de Almeida Gonzaga <ricardo@@profusion.mobi>
38 * 61 *
39 * Please contact <enlightenment-devel@lists.sourceforge.net> to get in 62 * @include test_bouncing_ball.c
40 * contact with the developers and maintainers.
41 * 63 *
64 * More examples can be found at @ref ephysics_examples.
42 */ 65 */
43 66
44#include <Evas.h> 67#include <Evas.h>
@@ -82,8 +105,8 @@ extern "C" {
82 */ 105 */
83 106
84/** 107/**
85 * @brief How to initialize EPhysics. 108 * @brief Physics simulation integration and visual effects.
86 * @defgroup EPhysics Top Level API available to add physics effects. 109 * @defgroup EPhysics EPhysics
87 * 110 *
88 * @{ 111 * @{
89 * 112 *