docs/eina_cxx: Add main landing page for Eina C++ documentation

This commit is contained in:
Stefan Schmidt 2014-09-19 15:23:51 +02:00
parent 7366607de6
commit c2eb17325c
1 changed files with 56 additions and 0 deletions

View File

@ -29,6 +29,58 @@
#include <eina_optional.hh>
#include <eina_integer_sequence.hh>
/**
* @page eina_cxx_main Eina C++ (BETA)
*
* @date 2014 (created)
*
* @section toc Table of Contents
*
* @li @ref eina_cxx_main_intro
* @li @ref eina_cxx_main_compiling
* @li @ref eina_cxx_main_next_steps
*
* @section eina_cxx_main_intro Introduction
*
* Eina C++ bindings
* @section eina_cxx_main_compiling How to compile
*
* Eina CXX is a library your application links to. The procedure for this is
* very simple. You simply have to compile your application with the
* appropriate compiler flags that the @c pkg-config script outputs. For
* example:
*
* Compiling C or C++ files into object files:
*
* @verbatim
gcc -c -o main.o main.c `pkg-config --cflags eina-cxx`
@endverbatim
*
* Linking object files into a binary executable:
*
* @verbatim
gcc -o my_application main.o `pkg-config --libs eina-cxx`
@endverbatim
*
* See @ref pkgconfig
*
* @section eina_cxx_main_next_steps Next Steps
*
* After you understood what Eina CXX is and installed it in your system
* you should proceed understanding the programming interface.
*
* Recommended reading:
*
*
*
* @addtogroup Eina_Cxx
* @{
*/
/**
* @defgroup Eina_Cxx Eina C++
*
@ -96,4 +148,8 @@ struct eina_threads_init
} }
/**
* @}
*/
#endif