[DOC] update documentation

doc/build.md

@@ -0,0 +1,38 @@
+Build lib & build sample                           {#ethread_build}
+========================
+
+@tableofcontents
+
+Download:                                          {#ethread_build_download}
+=========
+
+ethread use some tools to manage source and build it:
+
+lutin (build-system):                              {#ethread_build_download_lutin}
+---------------------
+
+```{.sh}
+	pip install lutin --user
+	# optionnal dependency of lutin (manage image changing size for application release)
+	pip install pillow --user
+```
+
+sources:                                           {#ethread_build_download_sources}
+--------
+
+```{.sh}
+	cd framework
+	git clone https://github.com/atria-soft/ethread.git
+	cd ..
+```
+
+Build:                                             {#ethread_build_build}
+======
+
+
+library:                                           {#ethread_build_build_library}
+--------
+
+```{.sh}
+	lutin -mdebug ethread
+```

doc/mainpage.md

@@ -0,0 +1,58 @@
+ETHREAD library                                {#mainpage}
+===============
+
+@tableofcontents
+
+What is ETHREAD:                               {#ethread_mainpage_what}
+================
+
+ETHREAD, or Ewol thread tools (specific platform). this permit to abstaract the platform for somme tools associated with the theead like set priority or naming.
+
+What it does:                               {#ethread_mainpage_what_it_does}
+-------------
+
+  - Set the thread name (usefull for elog) and in the system if possible
+  - set the thread priority if supported by the system
+
+What it doesn't do:                          {#ethread_mainpage_what_it_not_does}
+-------------------
+
+  - thread management
+  - thread abstraction (we have std::thread for this ...)
+
+What languages are supported?                    {#ethread_mainpage_language}
+=============================
+
+ETHREAD is written in C++.
+
+
+Are there any licensing restrictions?            {#ethread_mainpage_license_restriction}
+=====================================
+
+ETHREAD is **FREE software** and _all sub-library are FREE and staticly linkable !!!_
+
+
+License (APACHE-2.0)                             {#ethread_mainpage_license}
+====================
+
+Copyright ETHREAD 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                              {#ethread_mainpage_sub_page}
+===========
+
+  - @ref ethread_build
+  - [**ewol coding style**](http://atria-soft.github.io/ewol/ewol_coding_style.html)
+

doxy_ethread.py

@@ -0,0 +1,22 @@
+#!/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("ethread: Ewol thread platform tools")
+	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_file_patterns([
+	    '*.h',
+	    '*.md',
+	    ])
+	
+	return my_module

ethread/tools.h

@@ -9,6 +9,9 @@
 
 #include <thread>
 
+/**
+ * @brief ethread main namespace
+ */
 namespace ethread {
 	/**
 	 * @brief get human readable thread ID. (not the std::thread::get_id())
@@ -39,7 +42,7 @@ namespace ethread {
 	std::string getName();
 	/**
 	 * @brief Get an other thread name
-	 * @praram[in] _thread Thread handle
+	 * @param[in] _thread Thread handle
 	 * @return The external thread name of the thread
 	 */
 	std::string getName(std::thread& _thread);