[DOC] add basic documentation

README.md

@@ -1,8 +1,7 @@
 dollar
 ======
 
-`dollar` is a $1 and $N gesture recognition
+`dollar` is a $1, $N, $P and $P+ gesture recognition
-
 
 Instructions
 ============

authors.txt

@@ -0,0 +1 @@
+Mr DUPIN Edouard <yui.heero@gmail.com>

doc/mainpage.md

@@ -0,0 +1,39 @@
+DOLLAR library                                {#mainpage}
+===============
+
+@tableofcontents
+
+What is DOLLAR, and how can I use it?         {#dollar_mainpage_what}
+====================================
+
+`dollar` is a $1, $N, $P and $P+ gesture recognition
+
+the dollar library is base on the [dollar research](http://depts.washington.edu/aimgroup/proj/dollar/).
+
+What languages are supported?                 {#dollar_mainpage_lang}
+=============================
+
+DOLLAR is written in C++.
+
+Are there any licensing restrictions?         {#dollar_mainpage_license_restriction}
+=====================================
+
+DOLLAR is **FREE software** and _all sub-library are FREE and staticly linkable !!!_
+
+License (APACHE-2.0)                          {#dollar_mainpage_license}
+====================
+
+Copyright dollar 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.
+

dollar/Engine.h

@@ -14,6 +14,9 @@
 #include <dollar/Gesture.h>
 #include <ememory/memory.h>
 
+/**
+ * @brief dollar library main namespace
+ */
 namespace dollar {
 	class Engine {
 		protected:

doxy_dollar.py

@@ -0,0 +1,38 @@
+#!/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("$N gesture recognition")
+	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([
+	    'elog',
+	    'etk',
+	    'ejson',
+	    'esvg',
+	    'ememory',
+	    ])
+	my_module.add_exclude_symbols([
+	    '*operator<<*',
+	    ])
+	my_module.add_exclude_file([
+	    'debug.h',
+	    ])
+	my_module.add_file_patterns([
+	    '*.h',
+	    '*.md',
+	    ])
+	my_module.add_module_define([
+	    "PARSE_DOXYGEN",
+	    ])
+	
+	return my_module

lutin_dollar-bench-corpus.py

@@ -22,7 +22,7 @@ def get_compagny_name():
 	return "atria-soft"
 
 def get_maintainer():
-	return ["Mr DUPIN Edouard <yui.heero@gmail.com>"]
+	return "authors.txt"
 
 def create(target, module_name):
 	my_module = module.Module(__file__, module_name, get_type())

lutin_dollar-converter.py

@@ -22,7 +22,7 @@ def get_compagny_name():
 	return "atria-soft"
 
 def get_maintainer():
-	return ["Mr DUPIN Edouard <yui.heero@gmail.com>"]
+	return "authors.txt"
 
 def create(target, module_name):
 	my_module = module.Module(__file__, module_name, get_type())

lutin_dollar-data.py

@@ -19,7 +19,7 @@ def get_compagny_name():
 	return "atria-soft"
 
 def get_maintainer():
-	return ["Mr DUPIN Edouard <yui.heero@gmail.com>"]
+	return "authors.txt"
 
 def create(target, module_name):
 	my_module = module.Module(__file__, module_name, get_type())

lutin_dollar-generate-form.py

@@ -22,7 +22,7 @@ def get_compagny_name():
 	return "atria-soft"
 
 def get_maintainer():
-	return ["Mr DUPIN Edouard <yui.heero@gmail.com>"]
+	return "authors.txt"
 
 def create(target, module_name):
 	my_module = module.Module(__file__, module_name, get_type())

lutin_dollar-test.py

@@ -22,7 +22,7 @@ def get_compagny_name():
 	return "atria-soft"
 
 def get_maintainer():
-	return ["Mr DUPIN Edouard <yui.heero@gmail.com>"]
+	return "authors.txt"
 
 def create(target, module_name):
 	my_module = module.Module(__file__, module_name, get_type())

lutin_dollar.py

@@ -19,10 +19,10 @@ def get_compagny_name():
 	return "atria-soft"
 
 def get_maintainer():
-	return ["Mr DUPIN Edouard <yui.heero@gmail.com>"]
+	return "authors.txt"
 
 def get_version():
-	return [0,2,"dev"]
+	return "version.txt"
 
 def create(target, module_name):
 	my_module = module.Module(__file__, module_name, get_type())

version.txt

@@ -0,0 +1 @@
+0.2-dev