[DEV] basic documentation (no sample)

doc/build.md

@@ -0,0 +1,76 @@
+Build lib & build sample                           {#enet_build}
+========================
+
+@tableofcontents
+
+Download:                                          {#enet_build_download}
+=========
+
+enet use some tools to manage source and build it:
+
+lutin (build-system):                              {#enet_build_download_lutin}
+---------------------
+
+```{.sh}
+	pip install lutin --user
+	# optionnal dependency of lutin (manage image changing size for application release)
+	pip install pillow --user
+```
+
+
+dependency:                                        {#enet_build_download_dependency}
+-----------
+
+```{.sh}
+	mkdir framework
+	cd framework
+	git clone https://github.com/atria-soft/etk.git
+	git clone https://github.com/atria-soft/ememory.git
+	git clone https://github.com/atria-soft/algue.git
+	git clone https://github.com/generic-library/gtest-lutin.git --recursive
+	git clone https://github.com/generic-library/z-lutin.git --recursive
+	git clone https://github.com/generic-library/openssl-lutin.git --recursive
+	cd ..
+```
+
+sources:                                           {#enet_build_download_sources}
+--------
+
+```{.sh}
+	cd framework
+	git clone https://github.com/atria-soft/enet.git
+	cd ..
+```
+
+Build:                                             {#enet_build_build}
+======
+
+
+library:                                           {#enet_build_build_library}
+--------
+
+```{.sh}
+	lutin -mdebug enet
+```
+
+Sample:                                            {#enet_build_build_sample}
+-------
+
+```{.sh}
+	lutin -mdebug enet-server-websocket enet-client-websocket
+```
+
+
+Run sample:                                        {#enet_build_run_sample}
+===========
+
+```{.sh}
+	lutin -mdebug enet-server-websocket?run
+```
+
+In an other bash:
+
+```{.sh}
+	lutin -mdebug enet-client-websocket?run
+```
+

doc/mainpage.md

@@ -0,0 +1,64 @@
+ENET library                                {#mainpage}
+=============
+
+@tableofcontents
+
+What is ENET:                               {#enet_mainpage_what}
+==============
+
+`enet` is a network abstraction layer for ewol
+
+What it does:                               {#enet_mainpage_what_it_does}
+-------------
+
+Provide some acces on Network interface for all platform (simplify API)
+
+ENET is dependent of the STL (compatible with MacOs stl (CXX))
+
+It provide some simple interface for TCP, HTTP, webSocket in server and client modes
+
+
+What is the TODO list:                       {#enet_mainpage_todo}
+----------------------
+
+Create a full complient interface for every protocol ...
+
+this is in dev
+
+
+What languages are supported?                    {#enet_mainpage_language}
+=============================
+
+ENET is written in C++.
+
+
+Are there any licensing restrictions?            {#enet_mainpage_license_restriction}
+=====================================
+
+ENET is **FREE software** and _all sub-library are FREE and staticly linkable !!!_
+
+
+License (APACHE-2.0)                             {#enet_mainpage_license}
+====================
+
+Copyright ENET Edouard DUPIN
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+<http://www.apache.org/licenses/LICENSE-2.0>
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+
+Other pages                              {#enet_mainpage_sub_page}
+===========
+
+  - @ref enet_build
+  - [**ewol coding style**](http://atria-soft.github.io/ewol/ewol_coding_style.html)
+

doxy_enet.py

@@ -0,0 +1,23 @@
+#!/usr/bin/python
+import os
+import doxy.module as module
+import doxy.debug as debug
+import doxy.tools as tools
+
+def create(target, module_name):
+	my_module = module.Module(__file__, module_name)
+	my_module.set_version("version.txt")
+	my_module.set_title("enet: Ewol network abstraction")
+	my_module.set_website("http://atria-soft.github.io/" + module_name)
+	my_module.set_website_sources("http://github.com/atria-soft/" + module_name)
+	my_module.add_path([
+	    module_name,
+	    "doc"
+	    ])
+	my_module.add_depend([
+	    'etk',
+	    'ememory',
+	    #'algue'
+	    ])
+	
+	return my_module

enet/enet.h

@@ -10,3 +10,11 @@
 #include <enet/Http.h>
 #include <enet/Ftp.h>
 
+
+/**
+ * @brief Main esvg namespace
+ */
+namespace enet {
+	
+}
+

lutin_enet.py

@@ -26,7 +26,11 @@ def get_version():
 
 def create(target, module_name):
 	my_module = module.Module(__file__, module_name, get_type())
-	my_module.add_depend(['etk', 'ememory', 'algue'])
+	my_module.add_depend([
+	    'etk',
+	    'ememory',
+	    'algue'
+	    ])
 	my_module.add_src_file([
 	    'enet/debug.cpp'
 	    ])