summaryrefslogtreecommitdiff
path: root/test-client-catchcopy/catchcopy-api-0002/documentation.dox
diff options
context:
space:
mode:
Diffstat (limited to 'test-client-catchcopy/catchcopy-api-0002/documentation.dox')
-rwxr-xr-xtest-client-catchcopy/catchcopy-api-0002/documentation.dox31
1 files changed, 31 insertions, 0 deletions
diff --git a/test-client-catchcopy/catchcopy-api-0002/documentation.dox b/test-client-catchcopy/catchcopy-api-0002/documentation.dox
new file mode 100755
index 0000000..8ee4177
--- /dev/null
+++ b/test-client-catchcopy/catchcopy-api-0002/documentation.dox
@@ -0,0 +1,31 @@
+/* -*- mode: C++ ; c-file-style: "stroustrup" -*- **/
+
+/*
+ This file contains NO source code, just some documentation for doxygen to
+ parse.
+*/
+
+/*!
+ \mainpage Catchcopy API
+
+ \section mainpage_overview Overview
+
+ This code is to interface with the catchcopy protocol, the code is provided by the catchcopy projet: <a href="http://catchcopy.first-world.info/">Catchcopy web site</a>
+
+ \section mainpage_platforms Platforms
+
+ This plugin might be usable in all environments where you find Qt 4.\n
+
+ \section mainpage_downloads Downloads
+
+ You can found link on <a href="http://ultracopier.first-world.info/">Ultracopier (Supercopier/Teracopy)</a> project page, via git, snapshot sources, ...
+
+ \section mainpage_algorithm Protocol
+
+ The protocol in version 0.0.0.2 is used, you can see the documentation on <a href="http://catchcopy.first-world.info/">Catchcopy web site</a>
+
+ \section license GPL Version 3
+ The code source is under GPL3. The image is extacted from Oxygen icon pack of KDE4.
+
+*/
+