From 443d7272b85fddacc13c5ee1dfce0b299be7bdc9 Mon Sep 17 00:00:00 2001
From: Edouard DUPIN <yui.heero@gmail.com>
Date: Mon, 4 Apr 2016 21:40:47 +0200
Subject: [PATCH] [DOC] add basic Documentation

---
 doc/mainpage.md  | 41 +++++++++++++++++++++++++++++++++++++++++
 doxy_ememory.py  |  5 ++++-
 ememory/memory.h | 11 +++++++++++
 3 files changed, 56 insertions(+), 1 deletion(-)
 create mode 100644 doc/mainpage.md

diff --git a/doc/mainpage.md b/doc/mainpage.md
new file mode 100644
index 0000000..f9487e9
--- /dev/null
+++ b/doc/mainpage.md
@@ -0,0 +1,41 @@
+EMEMORY library                                {#mainpage}
+===============
+
+What is EMEMORY, and how can I use it?
+--------------------------------------
+
+EMEMORY, or Ewol Memory interface is a simple abstraction layer over std::shared_ptr. 
+
+EMEMORY is designed for:
+  - Permit to change the backend of shered_ptr when we want
+  - shared_ptr are not thread-safe (for now)
+
+Now it is just a wrapper over shared_ptr
+
+What languages are supported?
+-----------------------------
+
+EMEMORY is written in C++.
+
+Are there any licensing restrictions?
+-------------------------------------
+
+EMEMORY is **FREE software** and _all sub-library are FREE and staticly linkable !!!_
+
+License (APACHE-2.0)
+--------------------
+
+Copyright ememory 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.
+
diff --git a/doxy_ememory.py b/doxy_ememory.py
index 4bb082b..583c0e3 100644
--- a/doxy_ememory.py
+++ b/doxy_ememory.py
@@ -10,7 +10,10 @@ def create(target, module_name):
 	my_module.set_title("ememory: Ewol memory interface")
 	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.set_path(os.path.join(tools.get_current_path(__file__), module_name))
+	my_module.add_path([
+	    module_name,
+	    "doc"
+	    ])
 	my_module.add_module_depend([
 	    'etk'
 	    ])
diff --git a/ememory/memory.h b/ememory/memory.h
index 4fabc8a..801e0d0 100644
--- a/ememory/memory.h
+++ b/ememory/memory.h
@@ -12,10 +12,21 @@
 #include <memory>
 
 namespace ememory {
+	/**
+	 * @brief std::shared_ptr wrapper
+	 */
 	template<class TYPE>
 	using SharedPtr = std::shared_ptr<TYPE>;
+	
+	/**
+	 * @brief std::weak_ptr wrapper
+	 */
 	template<class TYPE>
 	using WeakPtr = std::weak_ptr<TYPE>;
+	
+	/**
+	 * @brief std::enable_shared_from_this wrapper
+	 */
 	template<class TYPE>
 	using EnableSharedFromThis = std::enable_shared_from_this<TYPE>;
 	/*