[DOC] add basic documentation handle

This commit is contained in:
Edouard DUPIN 2016-09-14 21:19:34 +02:00
parent bfa5caba0c
commit 4e3bcee633
3 changed files with 77 additions and 0 deletions

View File

@ -7,6 +7,9 @@
#include <etk/types.h>
/**
* @brief Basic Algue library namespace
*/
namespace algue {
namespace md5 {
std::vector<uint8_t> encode(const uint8_t* _data, int32_t _len);

39
doc/mainpage.md Normal file
View File

@ -0,0 +1,39 @@
ALGUE library {#mainpage}
===============
@tableofcontents
What is ALGUE, and how can I use it? {#algue_mainpage_what}
====================================
Algorithm interface base64, sha1, md5
this use the library openSSL to generate these algorithm (better c++ interface)
What languages are supported? {#algue_mainpage_lang}
=============================
ALGUE is written in C++.
Are there any licensing restrictions? {#algue_mainpage_license_restriction}
=====================================
ALGUE is **FREE software** and _all sub-library are FREE and staticly linkable !!!_
License (APACHE-2.0) {#algue_mainpage_license}
====================
Copyright algue 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.

35
doxy_algue.py Normal file
View File

@ -0,0 +1,35 @@
#!/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("algue: ewol basic simple algo (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([
module_name,
"doc"
])
my_module.add_depend([
'etk',
'elog'
])
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