From 1ab071e3ce8b45d9d7d90dbe2705290b453c99c4 Mon Sep 17 00:00:00 2001 From: Edouard DUPIN Date: Wed, 14 Sep 2016 21:46:53 +0200 Subject: [PATCH] [DOC] add basic documentation --- README.md | 3 +-- authors.txt | 1 + doc/mainpage.md | 39 +++++++++++++++++++++++++++++++++++ dollar/Engine.h | 3 +++ doxy_dollar.py | 38 ++++++++++++++++++++++++++++++++++ lutin_dollar-bench-corpus.py | 2 +- lutin_dollar-converter.py | 2 +- lutin_dollar-data.py | 2 +- lutin_dollar-generate-form.py | 2 +- lutin_dollar-test.py | 2 +- lutin_dollar.py | 4 ++-- version.txt | 1 + 12 files changed, 90 insertions(+), 9 deletions(-) create mode 100644 authors.txt create mode 100644 doc/mainpage.md create mode 100644 doxy_dollar.py create mode 100644 version.txt diff --git a/README.md b/README.md index 57d5e88..25e3b2c 100644 --- a/README.md +++ b/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 ============ diff --git a/authors.txt b/authors.txt new file mode 100644 index 0000000..9743ba6 --- /dev/null +++ b/authors.txt @@ -0,0 +1 @@ +Mr DUPIN Edouard \ No newline at end of file diff --git a/doc/mainpage.md b/doc/mainpage.md new file mode 100644 index 0000000..74b851c --- /dev/null +++ b/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 + + + +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. + diff --git a/dollar/Engine.h b/dollar/Engine.h index 1742da2..305d558 100644 --- a/dollar/Engine.h +++ b/dollar/Engine.h @@ -14,6 +14,9 @@ #include #include +/** + * @brief dollar library main namespace + */ namespace dollar { class Engine { protected: diff --git a/doxy_dollar.py b/doxy_dollar.py new file mode 100644 index 0000000..d0b0c18 --- /dev/null +++ b/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 \ No newline at end of file diff --git a/lutin_dollar-bench-corpus.py b/lutin_dollar-bench-corpus.py index e9f7086..cef3f73 100644 --- a/lutin_dollar-bench-corpus.py +++ b/lutin_dollar-bench-corpus.py @@ -22,7 +22,7 @@ def get_compagny_name(): return "atria-soft" def get_maintainer(): - return ["Mr DUPIN Edouard "] + return "authors.txt" def create(target, module_name): my_module = module.Module(__file__, module_name, get_type()) diff --git a/lutin_dollar-converter.py b/lutin_dollar-converter.py index c3c1d68..1b3f833 100644 --- a/lutin_dollar-converter.py +++ b/lutin_dollar-converter.py @@ -22,7 +22,7 @@ def get_compagny_name(): return "atria-soft" def get_maintainer(): - return ["Mr DUPIN Edouard "] + return "authors.txt" def create(target, module_name): my_module = module.Module(__file__, module_name, get_type()) diff --git a/lutin_dollar-data.py b/lutin_dollar-data.py index f0dfdad..aad7adf 100644 --- a/lutin_dollar-data.py +++ b/lutin_dollar-data.py @@ -19,7 +19,7 @@ def get_compagny_name(): return "atria-soft" def get_maintainer(): - return ["Mr DUPIN Edouard "] + return "authors.txt" def create(target, module_name): my_module = module.Module(__file__, module_name, get_type()) diff --git a/lutin_dollar-generate-form.py b/lutin_dollar-generate-form.py index f7d8f46..8a9c421 100644 --- a/lutin_dollar-generate-form.py +++ b/lutin_dollar-generate-form.py @@ -22,7 +22,7 @@ def get_compagny_name(): return "atria-soft" def get_maintainer(): - return ["Mr DUPIN Edouard "] + return "authors.txt" def create(target, module_name): my_module = module.Module(__file__, module_name, get_type()) diff --git a/lutin_dollar-test.py b/lutin_dollar-test.py index b7aec38..f8033eb 100644 --- a/lutin_dollar-test.py +++ b/lutin_dollar-test.py @@ -22,7 +22,7 @@ def get_compagny_name(): return "atria-soft" def get_maintainer(): - return ["Mr DUPIN Edouard "] + return "authors.txt" def create(target, module_name): my_module = module.Module(__file__, module_name, get_type()) diff --git a/lutin_dollar.py b/lutin_dollar.py index 076f560..e492e73 100644 --- a/lutin_dollar.py +++ b/lutin_dollar.py @@ -19,10 +19,10 @@ def get_compagny_name(): return "atria-soft" def get_maintainer(): - return ["Mr DUPIN Edouard "] + 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()) diff --git a/version.txt b/version.txt new file mode 100644 index 0000000..3d16010 --- /dev/null +++ b/version.txt @@ -0,0 +1 @@ +0.2-dev \ No newline at end of file