From ecb2b4d99e6405d66377b36ed420685e36d39ca8 Mon Sep 17 00:00:00 2001
From: Edouard DUPIN <yui.heero@gmail.com>
Date: Wed, 14 Sep 2016 22:00:12 +0200
Subject: [PATCH] [DOC] basic documantation

---
 audio/orchestra/Api.h    |  7 +++-
 doc/build.md             | 83 ++++++++++++++++++++++++++++++++++++++++
 doc/mainpage.md          | 50 ++++++++++++++++++++++++
 doxy_audio-orchestra.py  | 32 ++++++++++++++++
 lutin_audio-orchestra.py |  5 ++-
 5 files changed, 175 insertions(+), 2 deletions(-)
 create mode 100644 doc/build.md
 create mode 100644 doc/mainpage.md
 create mode 100644 doxy_audio-orchestra.py

diff --git a/audio/orchestra/Api.h b/audio/orchestra/Api.h
index 872f74f..9e28676 100644
--- a/audio/orchestra/Api.h
+++ b/audio/orchestra/Api.h
@@ -14,8 +14,13 @@
 #include <audio/Time.h>
 #include <audio/Duration.h>
 #include <ememory/memory.h>
-
+/**
+ * @brief Audio library namespace
+ */
 namespace audio {
+	/**
+	 * @brief Audio-orchestra library namespace
+	 */
 	namespace orchestra {
 		const std::vector<uint32_t>& genericSampleRate();
 		/**
diff --git a/doc/build.md b/doc/build.md
new file mode 100644
index 0000000..0868198
--- /dev/null
+++ b/doc/build.md
@@ -0,0 +1,83 @@
+Build lib & build sample                           {#audio_orchestra_build}
+========================
+
+@tableofcontents
+
+Download:                                          {#audio_orchestra_build_download}
+=========
+
+ege use some tools to manage source and build it:
+
+need google repo:                                  {#audio_orchestra_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_orchestra_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_orchestra_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_orchestra_build_download_sources}
+--------
+
+They are already download in the repo manifest in:
+
+```{.sh}
+	cd WORKING_DIRECTORY/framework/atria-soft/audio_orchestra
+```
+
+Build:                                             {#audio_orchestra_build_build}
+======
+
+you must stay in zour working directory...
+```{.sh}
+	cd WORKING_DIRECTORY
+```
+
+library:                                           {#audio_orchestra_build_build_library}
+--------
+
+```{.sh}
+	lutin -mdebug audio-orchestra
+```
+
+Sample:                                            {#audio_orchestra_build_build_sample}
+-------
+
+No smaple availlable for now ...
+
diff --git a/doc/mainpage.md b/doc/mainpage.md
new file mode 100644
index 0000000..0e0fd2a
--- /dev/null
+++ b/doc/mainpage.md
@@ -0,0 +1,50 @@
+AUDIO-ORCHESTRA library                                {#mainpage}
+=======================
+
+@tableofcontents
+
+What is AUDIO-ORCHESTRA:                               {#audio_orchestra_mainpage_what}
+========================
+
+AUDIO-ORCHESTRA, is a fork of RTAudio lib (with port for Android, and IOs).
+
+This is a cross API of Audio wrapping the Hardware.
+
+This library is not friendy usable, use audio-river to have a correct and simple multiple-flow API
+
+What it does:                               {#audio_orchestra_mainpage_what_it_does}
+-------------
+
+  - Open a strem audio in Input or output
+  - synchronise 2 flow
+  - open on some platform: Android, Linux, MacOs, Ios, Windows
+
+AUDIO-ORCHESTRA is dependent of the STL (compatible with MacOs stl (CXX))
+
+
+What languages are supported?                    {#audio_orchestra_mainpage_language}
+=============================
+
+AUDIO-ORCHESTRA is written in C++.
+
+
+Are there any licensing restrictions?            {#audio_orchestra_mainpage_license_restriction}
+=====================================
+
+AUDIO-ORCHESTRA is **FREE software** and _all sub-library are FREE and staticly linkable !!!_
+
+
+License (MIT)                             {#audio_orchestra_mainpage_license}
+=============
+
+Copyright AUDIO-ORCHESTRA Edouard DUPIN
+
+MIT ...
+
+
+Other pages                              {#audio_orchestra_mainpage_sub_page}
+===========
+
+  - @ref audio_orchestra_build
+  - [**ewol coding style**](http://atria-soft.github.io/ewol/ewol_coding_style.html)
+
diff --git a/doxy_audio-orchestra.py b/doxy_audio-orchestra.py
new file mode 100644
index 0000000..c7361f1
--- /dev/null
+++ b/doxy_audio-orchestra.py
@@ -0,0 +1,32 @@
+#!/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("Orchestra: audio interface wrapper")
+	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',
+	    ])
+	my_module.add_exclude_symbols([
+	    '*operator<<*',
+	    ])
+	my_module.add_exclude_file([
+	    'debug.h',
+	    ])
+	my_module.add_file_patterns([
+	    '*.h',
+	    '*.md',
+	    ])
+	
+	return my_module
\ No newline at end of file
diff --git a/lutin_audio-orchestra.py b/lutin_audio-orchestra.py
index 1e3dd9b..ce7412b 100644
--- a/lutin_audio-orchestra.py
+++ b/lutin_audio-orchestra.py
@@ -58,7 +58,10 @@ def create(target, module_name):
 		'audio/orchestra/CallbackInfo.h',
 		'audio/orchestra/StreamParameters.h'
 		])
-	my_module.add_depend(['audio', 'etk'])
+	my_module.add_depend([
+	    'audio',
+	    'etk'
+	    ])
 	# add all the time the dummy interface
 	my_module.add_flag('c++', ['-DORCHESTRA_BUILD_DUMMY'], export=True)
 	# TODO : Add a FILE interface: