summaryrefslogtreecommitdiff
path: root/plugins-alternative/Listener/dbus/documentation.dox
diff options
context:
space:
mode:
authorThomas Preud'homme <robotux@debian.org>2018-03-01 22:42:01 +0000
committerThomas Preud'homme <robotux@debian.org>2018-03-01 22:42:01 +0000
commit3958fa914c8a524ed4b6a5b035b794e12708fa1d (patch)
tree417868397f3c2c7386773f55096a9aa5f8856990 /plugins-alternative/Listener/dbus/documentation.dox
Import ultracopier_1.4.0.4.orig.tar.xz
[dgit import orig ultracopier_1.4.0.4.orig.tar.xz]
Diffstat (limited to 'plugins-alternative/Listener/dbus/documentation.dox')
-rw-r--r--plugins-alternative/Listener/dbus/documentation.dox36
1 files changed, 36 insertions, 0 deletions
diff --git a/plugins-alternative/Listener/dbus/documentation.dox b/plugins-alternative/Listener/dbus/documentation.dox
new file mode 100644
index 0000000..2eb3c87
--- /dev/null
+++ b/plugins-alternative/Listener/dbus/documentation.dox
@@ -0,0 +1,36 @@
+/* -*- mode: C++ ; c-file-style: "stroustrup" -*- **/
+
+/*
+ This file contains NO source code, just some documentation for doxygen to
+ parse.
+*/
+
+/*!
+ \mainpage dbus
+
+ \section mainpage_overview Overview
+
+ It's alternative listener for linux, it's very more simpler. You send just your copy/move, no more. No return.\n
+ More informations on <a href="http://ultracopier-wiki.first-world.info/">the wiki of ultracopier</a>.
+
+ \section mainpage_platforms Platforms
+
+ Ultracopier might be usable in all environments where you find Qt 5.\n
+ Ultracopier requires Qt 5.0 or newer. Tested on Qt 5.0.
+
+ \section mainpage_downloads Downloads
+
+ You can find the link on <a href="http://ultracopier.first-world.info/">Ultracopier</a> project page, via git, snapshot sources, ...
+
+ \section mainpage_algorithm Dbus method
+
+ you have this method exported to dbus:
+ <ul>
+ <li>void copy(const QStringList &sources,const QString &destination)</li>
+ <li>void move(const QStringList &sources,const QString &destination)</li>
+ </ul>
+
+ \section license GPL Version 3
+ The code source is under GPL3. The image is extacted from Oxygen icon pack of KDE4.
+
+*/