[DOC] basic documantation

audio/drain/Algo.h

@@ -19,7 +19,13 @@
 #include <audio/Duration.h>
 #include "debug.h"
 
+/**
+ * @brief Audio library namespace
+ */
 namespace audio {
+	/**
+	 * @brief audio-algo library namespace
+	 */
 	namespace drain{
 		typedef std::function<void (const std::string& _origin, const std::string& _status)> algoStatusFunction;
 		class Algo : public ememory::EnableSharedFromThis<Algo> {

doc/build.md

@@ -0,0 +1,85 @@
+Build lib & build sample                           {#audio_algo_build}
+========================
+
+@tableofcontents
+
+Download:                                          {#audio_algo_build_download}
+=========
+
+ege use some tools to manage source and build it:
+
+need google repo:                                  {#audio_algo_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_algo_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_algo_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_algo_build_download_sources}
+--------
+
+They are already download in the repo manifest in:
+
+```{.sh}
+	cd WORKING_DIRECTORY/framework/musicdsp/audio-drain
+```
+
+Build:                                             {#audio_algo_build_build}
+======
+
+you must stay in your working directory...
+```{.sh}
+	cd WORKING_DIRECTORY
+```
+
+library:                                           {#audio_algo_build_build_library}
+--------
+
+```{.sh}
+	lutin -mdebug audio-drain
+```
+
+Test sample:                                            {#audio_algo_build_build_sample}
+------------
+
+```{.sh}
+	lutin -mdebug audio-drain-test?build?run
+```
+

doc/mainpage.md

@@ -0,0 +1,56 @@
+AUDIO-ALGO library                                {#mainpage}
+=============
+
+@tableofcontents
+
+What is AUDIO-ALGO:                               {#audio_algo_mainpage_what}
+==============
+
+AUDIO-ALGO, Is a single Pipeline processing to simply update format, framerate, channel maps ...
+
+What it does:                               {#audio_algo_mainpage_what_it_does}
+-------------
+
+  - Change format
+  - Change framerate
+  - change number of channel
+
+AUDIO-ALGO is dependent of the STL (compatible with MacOs stl (CXX))
+
+
+What languages are supported?                    {#audio_algo_mainpage_language}
+=============================
+
+AUDIO-ALGO is written in C++.
+
+
+Are there any licensing restrictions?            {#audio_algo_mainpage_license_restriction}
+=====================================
+
+AUDIO-ALGO is **FREE software** and _all sub-library are FREE and staticly linkable !!!_
+
+
+License (APACHE-2.0)                             {#audio_algo_mainpage_license}
+====================
+
+Copyright AUDIO-ALGO 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_algo_mainpage_sub_page}
+===========
+
+  - @ref audio_algo_build
+  - [**ewol coding style**](http://atria-soft.github.io/ewol/ewol_coding_style.html)
+

doxy_audio-drain.py

@@ -0,0 +1,33 @@
+#!/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("Basic audio algo interface single pipe to process data")
+	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([
+	    "audio",
+	    "doc"
+	    ])
+	my_module.add_depend([
+	    'etk',
+	    'audio',
+	    'ejson'
+	    ])
+	my_module.add_exclude_symbols([
+	    '*operator<<*',
+	    ])
+	my_module.add_exclude_file([
+	    'debug.h',
+	    ])
+	my_module.add_file_patterns([
+	    '*.h',
+	    '*.md',
+	    ])
+	
+	return my_module

lutin_audio-drain.py

@@ -69,7 +69,13 @@ def create(target, module_name):
 	
 	# TODO: my_module.add_optional_module_depend('speexdsp', "HAVE_SPEEX_DSP_RESAMPLE")
 	my_module.add_flag('c++', "-DHAVE_SPEEX_DSP_RESAMPLE")
-	my_module.add_depend(['etk', 'audio', 'ejson', 'speex-dsp', 'audio-algo-drain'])
+	my_module.add_depend([
+	    'etk',
+	    'audio',
+	    'ejson',
+	    'speex-dsp',
+	    'audio-algo-drain'
+	    ])
 	my_module.add_path(tools.get_current_path(__file__))
 	return my_module