[DOC] basic documantation

audio/types.h

@@ -7,6 +7,9 @@
 
 #include <etk/types.h>
 
+/**
+ * @brief Audio library namespace
+ */
 namespace audio {
 	class int8_8_t;
 	class int8_16_t;

doc/build.md

@@ -0,0 +1,85 @@
+Build lib & build sample                           {#audio_build}
+========================
+
+@tableofcontents
+
+Download:                                          {#audio_build_download}
+=========
+
+ege use some tools to manage source and build it:
+
+need google repo:                                  {#audio_build_download_repo}
+-----------------
+
+see: http://source.android.com/source/downloading.html#installing-repo
+
+On all platform:
+```{.sh}
+	mkdir ~/.bin
+	PATH=~/.bin:$PATH
+	curl https://storage.googleapis.com/git-repo-downloads/repo > ~/.bin/repo
+	chmod a+x ~/.bin/repo
+```
+
+On ubuntu
+```{.sh}
+	sudo apt-get install repo
+```
+
+On archlinux
+```{.sh}
+	sudo pacman -S repo
+```
+
+lutin (build-system):                              {#audio_build_download_lutin}
+---------------------
+
+```{.sh}
+	pip install lutin --user
+	# optionnal dependency of lutin (manage image changing size for application release)
+	pip install pillow --user
+```
+
+
+dependency:                                        {#audio_build_download_dependency}
+-----------
+
+```{.sh}
+	mkdir -p WORKING_DIRECTORY/framework
+	cd WORKING_DIRECTORY/framework
+	repo init -u git://github.com/atria-soft/manifest.git
+	repo sync -j8
+	cd ../..
+```
+
+sources:                                           {#audio_build_download_sources}
+--------
+
+They are already download in the repo manifest in:
+
+```{.sh}
+	cd WORKING_DIRECTORY/framework/musicdsp/audio
+```
+
+Build:                                             {#audio_build_build}
+======
+
+you must stay in zour working directory...
+```{.sh}
+	cd WORKING_DIRECTORY
+```
+
+library:                                           {#audio_build_build_library}
+--------
+
+```{.sh}
+	lutin -mdebug audio
+```
+
+Test:                                              {#audio_build_build_test}
+-----
+
+```{.sh}
+	lutin -mdebug audio-test?build?run
+```
+

doc/mainpage.md

@@ -0,0 +1,54 @@
+AUDIO library                                {#mainpage}
+=============
+
+@tableofcontents
+
+What is AUDIO:                               {#audio_mainpage_what}
+==============
+
+AUDIO, or basic audio types. this lib is to generize acces on the basic audio type in fixed point view like 16 bits on 32 bits data ...
+
+What it does:                               {#audio_mainpage_what_it_does}
+-------------
+
+nearly all basic type and convertion between type in audio stream
+
+AUDIO is dependent of the STL (compatible with MacOs stl (CXX))
+
+
+What languages are supported?                    {#audio_mainpage_language}
+=============================
+
+AUDIO is written in C++.
+
+
+Are there any licensing restrictions?            {#audio_mainpage_license_restriction}
+=====================================
+
+AUDIO is **FREE software** and _all sub-library are FREE and staticly linkable !!!_
+
+
+License (APACHE-2.0)                             {#audio_mainpage_license}
+====================
+
+Copyright AUDIO 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                              {#audio_mainpage_sub_page}
+===========
+
+  - @ref audio_build
+  - [**ewol coding style**](http://atria-soft.github.io/ewol/ewol_coding_style.html)
+

doxy_audio.py

@@ -0,0 +1,31 @@
+#!/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("audio: Basic audio types")
+	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_depend([
+	    'etk',
+	    ])
+	my_module.add_exclude_symbols([
+	    '*operator<<*',
+	    ])
+	my_module.add_exclude_file([
+	    'debug.h',
+	    ])
+	my_module.add_file_patterns([
+	    '*.h',
+	    '*.md',
+	    ])
+	
+	return my_module

monk_audio.py

@@ -1,18 +0,0 @@
-#!/usr/bin/python
-import monkModule as module
-import monkTools as tools
-
-def get_desc():
-	return "audio : Audio basic foramt description"
-
-
-def create():
-	myModule = module.Module(__file__, 'audio', 'LIBRARY')
-	# set documentation properties:
-	myModule.set_website("http://heeroyui.github.io/audio/")
-	myModule.set_website_sources("http://github.com/heeroyui/audio/")
-	myModule.set_path(tools.get_current_path(__file__) + "/audio/")
-	myModule.set_path_general_doc(tools.get_current_path(__file__) + "/doc/")
-	# return the created description:
-	return myModule
-