summaryrefslogtreecommitdiff
path: root/src/lib/elua
diff options
context:
space:
mode:
authorDaniel Kolesa <d.kolesa@osg.samsung.com>2015-04-20 14:38:18 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-05-06 15:05:21 +0100
commit81e3f753da5ab2edc3a0cb2ba7576dffbb0863ed (patch)
treea4b4feec00db540a1e28d3a806929367bd0ef277 /src/lib/elua
parent7cb8d13980150e8a2f99377b8f2987b3c7aa9ff7 (diff)
elua lib: start adding documentation
Diffstat (limited to 'src/lib/elua')
-rw-r--r--src/lib/elua/Elua.h44
1 files changed, 44 insertions, 0 deletions
diff --git a/src/lib/elua/Elua.h b/src/lib/elua/Elua.h
index 81a6421b6e..bd4b20ba1c 100644
--- a/src/lib/elua/Elua.h
+++ b/src/lib/elua/Elua.h
@@ -52,6 +52,50 @@ extern "C" {
52# include <config.h> 52# include <config.h>
53#endif 53#endif
54 54
55/**
56 * @page elua_main Elua library (BETA)
57 *
58 * @date 2015 (created)
59 *
60 * @section toc Table of Contents
61 *
62 * @li @ref elua_main_intro
63 * @li @ref elua_main_compiling
64 * @li @ref elua_main_next_steps
65 *
66 * @section elua_main_intro Introduction
67 *
68 * The Elua library provides all necessary infrastructure required to set up
69 * a fully functional Lua state able of running Elua scripts. This is provided
70 * as a library in order to encourage reuse from different libraries and apps.
71 *
72 * @section elua_main_compiling How to compile
73 *
74 * As Elua is a library, compiling is very simple.
75 *
76 * Compiling C or C++ files into object files:
77 *
78 * @verbatim
79 gcc -c -o main.o main.c `pkg-config --cflags elua`
80 @endverbatim
81 *
82 * Linking object files into a binary executable:
83 *
84 * @verbatim
85 gcc -o my_application main.o `pkg-config --libs elua`
86 @endverbatim
87 *
88 * See @ref pkgconfig
89 *
90 * @section elua_main_next_steps Next Steps
91 *
92 * There is a comperehensive API reference available that should get you up
93 * and running.
94 *
95 * @addtogroup Elua
96 * @{
97 */
98
55#ifdef EFL_BETA_API_SUPPORT 99#ifdef EFL_BETA_API_SUPPORT
56 100
57#include <Eina.h> 101#include <Eina.h>