[DEV] better doc
This commit is contained in:
parent
91cd2e9058
commit
44d04b66a5
66
doc/build.md
Normal file
66
doc/build.md
Normal file
@ -0,0 +1,66 @@
|
||||
Build lib & build sample {#elog_build}
|
||||
========================
|
||||
|
||||
@tableofcontents
|
||||
|
||||
Download: {#elog_build_download}
|
||||
=========
|
||||
|
||||
elog use some tools to manage source and build it:
|
||||
|
||||
lutin (build-system): {#elog_build_download_lutin}
|
||||
---------------------
|
||||
|
||||
```{.sh}
|
||||
pip install lutin --user
|
||||
# optionnal dependency of lutin (manage image changing size for application release
|
||||
pip install pillow --user
|
||||
```
|
||||
|
||||
|
||||
dependency: {#elog_build_download_dependency}
|
||||
-----------
|
||||
|
||||
**no dependency**
|
||||
|
||||
sources: {#elog_build_download_sources}
|
||||
--------
|
||||
|
||||
```{.sh}
|
||||
mkdir framework
|
||||
cd framework
|
||||
git clone https://github.com/atria-soft/elog.git
|
||||
cd ..
|
||||
```
|
||||
|
||||
Build: {#elog_build_build}
|
||||
======
|
||||
|
||||
|
||||
library: {#elog_build_build_library}
|
||||
--------
|
||||
|
||||
```{.sh}
|
||||
lutin -mdebug elog
|
||||
```
|
||||
|
||||
Sample: {#elog_build_build_sample}
|
||||
-------
|
||||
|
||||
```{.sh}
|
||||
lutin -mdebug elog-sample
|
||||
lutin -mdebug elog-test
|
||||
```
|
||||
|
||||
Or simple:
|
||||
|
||||
```{.sh}
|
||||
lutin -mdebug elog-*
|
||||
```
|
||||
|
||||
Run sample: {#elog_build_run_sample}
|
||||
===========
|
||||
|
||||
```{.sh}
|
||||
lutin -mdebug elog-sample?run
|
||||
```
|
||||
@ -1,13 +1,15 @@
|
||||
Elog library {#mainpage}
|
||||
============
|
||||
|
||||
What is ELOG?
|
||||
-------------
|
||||
@tableofcontents
|
||||
|
||||
What is ELOG? {#elog_mainpage_what}
|
||||
=============
|
||||
|
||||
ELOG, or [**EWOL**](http://atria-soft.github.io/ewol) Logger, is a simple wrapper to concataine log with a simple basic macro ELOG_BASE().
|
||||
|
||||
Where can I use it?
|
||||
-------------------
|
||||
Where can I use it? {#elog_mainpage_where}
|
||||
===================
|
||||
|
||||
Everywhere! EWOL is cross-platform devolopped to support bases OS:
|
||||
- Linux (X11) (mouse)
|
||||
@ -16,20 +18,20 @@ Everywhere! EWOL is cross-platform devolopped to support bases OS:
|
||||
- Android (mouse + touch)
|
||||
- IOs (touch)
|
||||
|
||||
What languages are supported?
|
||||
-----------------------------
|
||||
What languages are supported? {#elog_mainpage_language}
|
||||
=============================
|
||||
|
||||
EWOL is written in C++
|
||||
|
||||
Are there any licensing restrictions?
|
||||
-------------------------------------
|
||||
Are there any licensing restrictions? {#elog_mainpage_restriction}
|
||||
=====================================
|
||||
|
||||
EWOL is **FREE software** and //all sub-library are FREE and staticly linkable !!!//
|
||||
EWOL is **FREE software** and _all sub-library are FREE and staticly linkable !!!_
|
||||
|
||||
We have no dependency expected generic lib C++ (STL or CXX)
|
||||
|
||||
License (APACHE 2)
|
||||
------------------
|
||||
License (APACHE 2) {#elog_mainpage_license}
|
||||
==================
|
||||
|
||||
Copyright elog Edouard DUPIN
|
||||
|
||||
@ -45,9 +47,13 @@ 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.
|
||||
|
||||
Main documentation:
|
||||
-------------------
|
||||
Other pages {#elog_mainpage_sub_page}
|
||||
===========
|
||||
|
||||
@ref elog_tutorial
|
||||
- @ref elog_build
|
||||
- @ref elog_tutorial
|
||||
* @ref elog_tutorial_01
|
||||
* @ref elog_tutorial_02
|
||||
* @ref elog_tutorial_03
|
||||
- [**ewol coding style**](http://atria-soft.github.io/ewol/ewol_coding_style.html)
|
||||
|
||||
[**ewol coding style**](http://atria-soft.github.io/ewol/ewol_coding_style.html)
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
Elog Tutorial: Add some Log (using) {#elog_tutorial_01}
|
||||
===================================
|
||||
|
||||
@tableofcontents
|
||||
|
||||
You might not use the log directly.
|
||||
The reson is simple:
|
||||
- It is designed to be replaced by an other log library.
|
||||
@ -8,8 +10,8 @@ The reson is simple:
|
||||
This permit you to use custom log library just replacing Macro and basic functions
|
||||
|
||||
|
||||
Declaring the list of macro
|
||||
---------------------------
|
||||
Declaring the list of macro {#elog_tutorial_01_declaration}
|
||||
===========================
|
||||
|
||||
|
||||
**debug.h**
|
||||
@ -69,8 +71,8 @@ int main(int _argc, const char *_argv[]) {
|
||||
}
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Using it
|
||||
--------
|
||||
Using it {#elog_tutorial_01_using_it}
|
||||
========
|
||||
|
||||
You just need to call the macro whe you want to add debug log:
|
||||
|
||||
@ -80,10 +82,10 @@ APPL_INFO("Hello, how are you?");
|
||||
|
||||
|
||||
Specification of logs
|
||||
---------------------
|
||||
=====================
|
||||
|
||||
- *_CRITICAL(***); This will log the data and asert just after (display backtrace if possible)
|
||||
- *_PRINT(***); display on console (can not be removed with the log-level)
|
||||
- *_CRITICAL(***); This will log the data and asert just after (display backtrace if possible)
|
||||
- *_PRINT(***); display on console (can not be removed with the log-level)
|
||||
|
||||
|
||||
|
||||
|
||||
16
doxy_elog.py
16
doxy_elog.py
@ -10,9 +10,19 @@ def create(target, module_name):
|
||||
my_module.set_title("Elog: Etk log 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),
|
||||
os.path.join(tools.get_current_path(__file__), "doc"),
|
||||
my_module.add_path([
|
||||
module_name,
|
||||
"doc",
|
||||
])
|
||||
my_module.add_exclude_symbols([
|
||||
'*operator<<*',
|
||||
])
|
||||
my_module.add_exclude_file([
|
||||
'debug.h',
|
||||
])
|
||||
my_module.add_file_patterns([
|
||||
'*.h',
|
||||
'*.md',
|
||||
])
|
||||
|
||||
return my_module
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user