[DOC] better doc
This commit is contained in:
parent
dc87e2a7d5
commit
33d985fcac
69
doc/build.md
Normal file
69
doc/build.md
Normal file
@ -0,0 +1,69 @@
|
||||
Build lib & build sample {#etk_build}
|
||||
========================
|
||||
|
||||
@tableofcontents
|
||||
|
||||
Download: {#etk_build_download}
|
||||
=========
|
||||
|
||||
etk use some tools to manage source and build it:
|
||||
|
||||
lutin (build-system): {#etk_build_download_lutin}
|
||||
---------------------
|
||||
|
||||
```{.sh}
|
||||
pip install lutin --user
|
||||
# optionnal dependency of lutin (manage image changing size for application release
|
||||
pip install pillow --user
|
||||
```
|
||||
|
||||
|
||||
dependency: {#etk_build_download_dependency}
|
||||
-----------
|
||||
|
||||
```{.sh}
|
||||
mkdir framework
|
||||
cd framework
|
||||
git clone https://github.com/atria-soft/elog.git
|
||||
cd ..
|
||||
```
|
||||
|
||||
sources: {#etk_build_download_sources}
|
||||
--------
|
||||
|
||||
```{.sh}
|
||||
cd framework
|
||||
git clone https://github.com/atria-soft/etk.git
|
||||
cd ..
|
||||
```
|
||||
|
||||
Build: {#etk_build_build}
|
||||
======
|
||||
|
||||
|
||||
library: {#etk_build_build_library}
|
||||
--------
|
||||
|
||||
```{.sh}
|
||||
lutin -mdebug etk
|
||||
```
|
||||
|
||||
test: {#etk_build_build_sample}
|
||||
-----
|
||||
|
||||
```{.sh}
|
||||
lutin -mdebug etk-test
|
||||
```
|
||||
|
||||
Or simple:
|
||||
|
||||
```{.sh}
|
||||
lutin -mdebug etk-*
|
||||
```
|
||||
|
||||
Run sample: {#etk_build_run_sample}
|
||||
===========
|
||||
|
||||
```{.sh}
|
||||
lutin -mdebug etk-test?run
|
||||
```
|
||||
@ -1,8 +1,8 @@
|
||||
ETK library {#mainpage}
|
||||
ETK library {#mainpage}
|
||||
===========
|
||||
|
||||
What is ETK, and how can I use it?
|
||||
----------------------------------
|
||||
What is ETK, and how can I use it? {#etk_mainpage_what}
|
||||
==================================
|
||||
|
||||
ETK, or Ewol Tool kit is a simple abstraction layer for some elements like mutex, std missing element(in android or MacOS) and ...
|
||||
|
||||
@ -19,20 +19,20 @@ ETK is composed of some part:
|
||||
|
||||
|
||||
|
||||
What languages are supported?
|
||||
-----------------------------
|
||||
What languages are supported? {#etk_mainpage_langue}
|
||||
=============================
|
||||
|
||||
ETK is written in C++.
|
||||
|
||||
|
||||
Are there any licensing restrictions?
|
||||
-------------------------------------
|
||||
Are there any licensing restrictions? {#etk_mainpage_dependency}
|
||||
=====================================
|
||||
|
||||
ETK is **FREE software** and _all sub-library are FREE and staticly linkable !!!_
|
||||
|
||||
|
||||
License (APACHE-2.0)
|
||||
--------------------
|
||||
License (APACHE-2.0) {#etk_mainpage_licence}
|
||||
====================
|
||||
|
||||
Copyright etk Edouard DUPIN
|
||||
|
||||
@ -48,3 +48,12 @@ 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 {#etk_mainpage_sub_page}
|
||||
===========
|
||||
|
||||
- @ref etk_build
|
||||
- [**ewol coding style**](http://atria-soft.github.io/ewol/ewol_coding_style.html)
|
||||
|
||||
|
||||
|
||||
|
||||
34
doxy_etk.py
34
doxy_etk.py
@ -12,15 +12,39 @@ def create(target, module_name):
|
||||
my_module.set_website_sources("http://github.com/atria-soft/" + module_name)
|
||||
my_module.add_path([
|
||||
module_name,
|
||||
"doc"
|
||||
"doc",
|
||||
])
|
||||
my_module.add_data_path([
|
||||
"data/dox",
|
||||
])
|
||||
my_module.add_data_path("data/dox")
|
||||
my_module.add_module_depend([
|
||||
'elog'
|
||||
'elog',
|
||||
])
|
||||
my_module.add_module_define([
|
||||
"ETK_BUILD_MINIZIP"
|
||||
])
|
||||
"ETK_BUILD_MINIZIP",
|
||||
])
|
||||
my_module.add_exclude_symbols([
|
||||
'*operator<<*',
|
||||
'*string_to_*',
|
||||
'*compare_no_case*',
|
||||
'*end_with*',
|
||||
'*extract_line*',
|
||||
'*isIn*',
|
||||
'*matRotate2*',
|
||||
'*replace*',
|
||||
'*sort*',
|
||||
'*split*',
|
||||
'*start_with*',
|
||||
'tolower',
|
||||
'toupper',
|
||||
])
|
||||
my_module.add_exclude_file([
|
||||
'debug.h',
|
||||
])
|
||||
my_module.add_file_patterns([
|
||||
'*.h',
|
||||
'*.md',
|
||||
])
|
||||
|
||||
|
||||
return my_module
|
||||
|
||||
@ -442,7 +442,11 @@ namespace etk {
|
||||
*/
|
||||
etk::Color<uint8_t, 4> parseStringColorNamed(const std::string& _input);
|
||||
|
||||
//! @not_in_doc
|
||||
/**
|
||||
* @brief Specify that the Get intance is specialized for uint8_t/4 template
|
||||
* @return unsignad iterger containing the color value in RGBA
|
||||
* @internal
|
||||
*/
|
||||
template<> uint32_t Color<uint8_t, 4>::get() const;
|
||||
|
||||
template<typename MY_TYPE, int MY_TYPE_SIZE> uint32_t Color<MY_TYPE, MY_TYPE_SIZE>::get() const {
|
||||
|
||||
@ -146,7 +146,11 @@ namespace etk {
|
||||
MY_TYPE& operator[] (const std::string& _key) {
|
||||
return get(_key);
|
||||
}
|
||||
//! @previous
|
||||
/**
|
||||
* @brief Get an copy Element an a special position
|
||||
* @param[in] _key Name of the hash requested
|
||||
* @return An reference on the copy of selected element
|
||||
*/
|
||||
const MY_TYPE& operator[] (const std::string& _key) const {
|
||||
return get(_key);
|
||||
}
|
||||
|
||||
@ -218,6 +218,7 @@ namespace etk {
|
||||
}
|
||||
/**
|
||||
* @brief Return a vector will the absolute values of each element
|
||||
* @return New vector with the absolute value
|
||||
*/
|
||||
Vector4D<T> absolute() const {
|
||||
return Vector4D<T>( abs(m_floats[0]),
|
||||
|
||||
@ -51,7 +51,7 @@
|
||||
#ifndef _WIN32
|
||||
#include <math.h>
|
||||
#ifndef _MATH_H_MATHDEF
|
||||
//! @not_in_doc
|
||||
//! @brief Generate a basic type for floating point unit selection (not finished)
|
||||
using float_t = float;
|
||||
#endif
|
||||
#endif
|
||||
|
||||
Loading…
Reference in New Issue
Block a user