docs/eina_cxx: Add main landing page for Eina C++ documentation
authorStefan Schmidt <s.schmidt@samsung.com>
Fri, 19 Sep 2014 13:23:51 +0000 (15:23 +0200)
committerStefan Schmidt <s.schmidt@samsung.com>
Fri, 19 Sep 2014 13:27:33 +0000 (15:27 +0200)
src/bindings/eina_cxx/Eina.hh

index 1633815..4e7f7c5 100644 (file)
 #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++
  *
  * @defgroup Eina_Cxx_Data_Types_Group Data Types
@@ -96,4 +148,8 @@ struct eina_threads_init
 
 } }
 
+/**
+ * @}
+ */
+
 #endif