From 7e74567d9d14402cea4fb9872871202dec872d97 Mon Sep 17 00:00:00 2001 From: BRULE Herman Date: Thu, 26 Jan 2012 14:02:57 +0100 Subject: [PATCH] Add doxygen info --- ultracopier.dox | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100755 ultracopier.dox diff --git a/ultracopier.dox b/ultracopier.dox new file mode 100755 index 00000000..134c2767 --- /dev/null +++ b/ultracopier.dox @@ -0,0 +1,35 @@ +/* -*- mode: C++ ; c-file-style: "stroustrup" -*- ***************************** + * Ultracopier + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GPLv3 + *****************************************************************************/ + +/* + This file contains NO source code, just some documentation for doxygen to + parse. +*/ + +/*! + \mainpage Ultracopier + + \section mainpage_overview Overview + + Ultracopier provide an advanced copier with play/pause/resume, with advanced management like playlist. + This documentation is FOR DEVELOPMENT, use the wiki of ultracopier for end user documentation, general documentation, algorithm documentation. + + \section mainpage_platforms Platforms + + Ultracopier might be usable in all environments where you find Qt 4.\n + Ultracopier requires Qt 4.5.x or newer. Tested on Qt 4.7. Due to optimization Qt 4.8 usage will be better. + + \section mainpage_downloads Downloads + + Stable releases are available at the Ultracopier + project page. + + \section license GPL Version 3 + The core, and some default plugin are under GPL Version 3. See into each part to see the license. + +*/ +