[DOC] add basic Documentation
This commit is contained in:
parent
3787dd7814
commit
443d7272b8
41
doc/mainpage.md
Normal file
41
doc/mainpage.md
Normal file
@ -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.
|
||||
|
@ -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'
|
||||
])
|
||||
|
@ -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>;
|
||||
/*
|
||||
|
Loading…
x
Reference in New Issue
Block a user