[DEV] use doxygen documentation

2016-03-30 21:40:01 +02:00 · 2016-03-30 21:40:01 +02:00 · fa92fc0116
commit fa92fc0116
parent c50347cd40
62 changed files with 80 additions and 61 deletions
--- a/doxy_gale.py
+++ b/doxy_gale.py
@ -0,0 +1,19 @@
+#!/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([0,5,"dev"])
+	my_module.set_title("Gale: Graphic Abstraction Layer for Ewol")
+	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.set_path(os.path.join(tools.get_current_path(__file__), module_name))
+	my_module.add_module_depend([
+	    'elog',
+	    'etk'
+	    ])
+	
+	return my_module
--- a/gale/Application.cpp
+++ b/gale/Application.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/Application.h
+++ b/gale/Application.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/Dimension.cpp
+++ b/gale/Dimension.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/Dimension.h
+++ b/gale/Dimension.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/Thread.cpp
+++ b/gale/Thread.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/Thread.h
+++ b/gale/Thread.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/context/Android/Context.cpp
+++ b/gale/context/Android/Context.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN, Kevin BILLONNEAU
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/context/Context.cpp
+++ b/gale/context/Context.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/context/Context.h
+++ b/gale/context/Context.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/context/Fps.h
+++ b/gale/context/Fps.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/context/IOs/AppDelegate.h
+++ b/gale/context/IOs/AppDelegate.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 *
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/context/IOs/Context.cpp
+++ b/gale/context/IOs/Context.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 *
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/context/IOs/Context.h
+++ b/gale/context/IOs/Context.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 *
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/context/IOs/Interface.h
+++ b/gale/context/IOs/Interface.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/context/InputManager.cpp
+++ b/gale/context/InputManager.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/context/InputManager.h
+++ b/gale/context/InputManager.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/context/MacOs/AppDelegate.h
+++ b/gale/context/MacOs/AppDelegate.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/context/MacOs/Context.h
+++ b/gale/context/MacOs/Context.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/context/MacOs/Interface.h
+++ b/gale/context/MacOs/Interface.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/context/MacOs/OpenglView.h
+++ b/gale/context/MacOs/OpenglView.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/context/MacOs/Windows.h
+++ b/gale/context/MacOs/Windows.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 *
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/context/Windows/Context.cpp
+++ b/gale/context/Windows/Context.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/context/X11/Context.cpp
+++ b/gale/context/X11/Context.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/context/clipBoard.cpp
+++ b/gale/context/clipBoard.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/context/clipBoard.h
+++ b/gale/context/clipBoard.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/context/commandLine.cpp
+++ b/gale/context/commandLine.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/context/commandLine.h
+++ b/gale/context/commandLine.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/context/cursor.cpp
+++ b/gale/context/cursor.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/context/cursor.h
+++ b/gale/context/cursor.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/context/directFB/Context.cpp
+++ b/gale/context/directFB/Context.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/debug.cpp
+++ b/gale/debug.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/debug.h
+++ b/gale/debug.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/gale.cpp
+++ b/gale/gale.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/gale.h
+++ b/gale/gale.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/key/Special.cpp
+++ b/gale/key/Special.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/key/Special.h
+++ b/gale/key/Special.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/key/key.h
+++ b/gale/key/key.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/key/keyboard.cpp
+++ b/gale/key/keyboard.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/key/keyboard.h
+++ b/gale/key/keyboard.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/key/status.cpp
+++ b/gale/key/status.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/key/status.h
+++ b/gale/key/status.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/key/type.cpp
+++ b/gale/key/type.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/key/type.h
+++ b/gale/key/type.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/orientation.cpp
+++ b/gale/orientation.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/orientation.h
+++ b/gale/orientation.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/renderer/openGL/openGL-include.h
+++ b/gale/renderer/openGL/openGL-include.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/renderer/openGL/openGL.cpp
+++ b/gale/renderer/openGL/openGL.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/renderer/openGL/openGL.h
+++ b/gale/renderer/openGL/openGL.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/resource/Manager.cpp
+++ b/gale/resource/Manager.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/resource/Manager.h
+++ b/gale/resource/Manager.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/resource/Program.cpp
+++ b/gale/resource/Program.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/resource/Program.h
+++ b/gale/resource/Program.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/resource/Resource.cpp
+++ b/gale/resource/Resource.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/resource/Resource.h
+++ b/gale/resource/Resource.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/resource/Shader.cpp
+++ b/gale/resource/Shader.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/resource/Shader.h
+++ b/gale/resource/Shader.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/resource/Texture.cpp
+++ b/gale/resource/Texture.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/resource/Texture.h
+++ b/gale/resource/Texture.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/resource/VirtualBufferObject.cpp
+++ b/gale/resource/VirtualBufferObject.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/gale/resource/VirtualBufferObject.h
+++ b/gale/resource/VirtualBufferObject.h
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2011, Edouard DUPIN, all right reserved
--- a/sample/basic.cpp
+++ b/sample/basic.cpp
@ -1,4 +1,4 @@
-/**
+/** @file
 * @author Edouard DUPIN
 * 
 * @copyright 2010, Edouard DUPIN, all right reserved