[DEV] basic documentation (no sample)

doc/build.md

@@ -0,0 +1,67 @@
+Build lib & build sample                           {#esvg_build}
+========================
+
+@tableofcontents
+
+Download:                                          {#esvg_build_download}
+=========
+
+esvg use some tools to manage source and build it:
+
+lutin (build-system):                              {#esvg_build_download_lutin}
+---------------------
+
+```{.sh}
+	pip install lutin --user
+	# optionnal dependency of lutin (manage image changing size for application release)
+	pip install pillow --user
+```
+
+
+dependency:                                        {#esvg_build_download_dependency}
+-----------
+
+```{.sh}
+	mkdir framework
+	cd framework
+	git clone https://github.com/atria-soft/etk.git
+	git clone https://github.com/atria-soft/exml.git
+	git clone https://github.com/generic-library/gtest-lutin.git --recursive
+	git clone https://github.com/generic-library/z-lutin.git --recursive
+	cd ..
+```
+
+sources:                                           {#esvg_build_download_sources}
+--------
+
+```{.sh}
+	cd framework
+	git clone https://github.com/atria-soft/esvg.git
+	cd ..
+```
+
+Build:                                             {#esvg_build_build}
+======
+
+
+library:                                           {#esvg_build_build_library}
+--------
+
+```{.sh}
+	lutin -mdebug esvg
+```
+
+Sample:                                            {#esvg_build_build_sample}
+-------
+
+```{.sh}
+	lutin -mdebug esvg-test
+```
+
+
+Run sample:                                        {#esvg_build_run_sample}
+===========
+
+```{.sh}
+	lutin -mdebug esvg-test?run
+```

doc/mainpage.md

@@ -0,0 +1,62 @@
+ESVG library                                {#mainpage}
+=============
+
+@tableofcontents
+
+What is ESVG:                               {#esvg_mainpage_what}
+==============
+
+`esvg` is c++ svg image parser and renderer.
+
+What it does:                               {#esvg_mainpage_what_it_does}
+-------------
+
+It parse a svg file (not compressed) and render it in a simple raw image.
+
+ESVG is dependent of the STL (compatible with MacOs stl (CXX))
+
+What is the TODO list:                       {#esvg_mainpage_todo}
+----------------------
+
+Write an interface to manage internal element of the svg (same methode of exml @ref #exml_mainpage_what or ejson @ref #ejson_mainpage_what)
+
+Write svg file
+
+Access et internal meta-data.
+
+What languages are supported?                    {#esvg_mainpage_language}
+=============================
+
+ESVG is written in C++.
+
+
+Are there any licensing restrictions?            {#esvg_mainpage_license_restriction}
+=====================================
+
+ESVG is **FREE software** and _all sub-library are FREE and staticly linkable !!!_
+
+
+License (APACHE-2.0)                             {#esvg_mainpage_license}
+====================
+
+Copyright ESVG 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                              {#esvg_mainpage_sub_page}
+===========
+
+  - @ref esvg_build
+  - [**ewol coding style**](http://atria-soft.github.io/ewol/ewol_coding_style.html)
+

doxy_esvg.py

@@ -10,7 +10,10 @@ def create(target, module_name):
 	my_module.set_title("esvg: Ewol SVG parser and renderer")
 	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_depend([
 	    'exml',
 	    'etk'

esvg/esvg.h

@@ -12,6 +12,9 @@
 
 #include <esvg/Base.h>
 
+/**
+ * @brief Main esvg namespace
+ */
 namespace esvg {
 	class Document : public esvg::Base {
 		private: