From a25fff819519e770198212e1752fe9e9df4cd765 Mon Sep 17 00:00:00 2001
From: BRULE Herman <alpha_one_x86@first-world.info>
Date: Mon, 23 Jan 2012 17:44:08 +0100
Subject: [PATCH] Add more comment, mainly about the class information

---
 AuthPlugin.h         | 1 +
 CliParser.h          | 1 +
 CopyEngineManager.h  | 1 +
 ExtraSocket.h        | 1 +
 FacilityEngine.h     | 4 ++++
 HelpDialog.h         | 1 +
 LocalListener.h      | 1 +
 LocalPluginOptions.h | 6 ++++++
 LogThread.h          | 3 +++
 OptionDialog.h       | 5 +++++
 OptionEngine.h       | 5 +++++
 PluginInformation.h  | 1 +
 PluginLoader.h       | 6 ++++++
 SessionLoader.h      | 1 +
 14 files changed, 37 insertions(+)

diff --git a/AuthPlugin.h b/AuthPlugin.h
index e551b805..a73524a9 100644
--- a/AuthPlugin.h
+++ b/AuthPlugin.h
@@ -16,6 +16,7 @@
 
 #include "Environment.h"
 
+/** \brief allow authentify the plugin */
 class AuthPlugin : public QThread
 {
 	Q_OBJECT
diff --git a/CliParser.h b/CliParser.h
index 586935b3..bcc36aa0 100644
--- a/CliParser.h
+++ b/CliParser.h
@@ -4,6 +4,7 @@
 #include <QObject>
 #include <QMessageBox>
 
+/** \brief class to parse all command line options */
 class CliParser : public QObject
 {
 	Q_OBJECT
diff --git a/CopyEngineManager.h b/CopyEngineManager.h
index 7ba0345c..4bfdf3e8 100644
--- a/CopyEngineManager.h
+++ b/CopyEngineManager.h
@@ -23,6 +23,7 @@ namespace Ui {
 	class CopyEngineOptions;
 }
 
+/** \brief Manage copy engine plugins and their instance */
 class CopyEngineManager : public QObject, public GlobalClass
 {
 	Q_OBJECT
diff --git a/ExtraSocket.h b/ExtraSocket.h
index ffc89da3..1c4c0d07 100644
--- a/ExtraSocket.h
+++ b/ExtraSocket.h
@@ -16,6 +16,7 @@
 	#include <windows.h>
 #endif
 
+/** \brief class to have general socket options */
 class ExtraSocket
 {
 public:
diff --git a/FacilityEngine.h b/FacilityEngine.h
index 0dad6ea8..5d654323 100644
--- a/FacilityEngine.h
+++ b/FacilityEngine.h
@@ -4,6 +4,10 @@
 #include "interface/FacilityInterface.h"
 #include "Environment.h"
 
+/** \brief Class to group general function for the plugin
+
+This class is used into some plugin like copy engine plugin, to all into one place all common function, group the traduction, and all what it can grouped across all plugin into Ultracopier core application.
+*/
 class FacilityEngine : public FacilityInterface
 {
 	Q_OBJECT
diff --git a/HelpDialog.h b/HelpDialog.h
index b7c0f0ed..9a330b46 100644
--- a/HelpDialog.h
+++ b/HelpDialog.h
@@ -21,6 +21,7 @@ namespace Ui {
 	class HelpDialog;
 }
 
+/** \brief Help dialog, and some user oriented repport/debug function */
 class HelpDialog : public QDialog, public GlobalClass {
 	Q_OBJECT
 	public:
diff --git a/LocalListener.h b/LocalListener.h
index 3e25d2df..34fc957b 100644
--- a/LocalListener.h
+++ b/LocalListener.h
@@ -15,6 +15,7 @@
 #include "Environment.h"
 #include "ExtraSocket.h"
 
+/** \brief To have unique instance, and pass arguments to the existing instance if needed */
 class LocalListener : public QObject
 {
     Q_OBJECT
diff --git a/LocalPluginOptions.h b/LocalPluginOptions.h
index 656c6120..86a7ff22 100644
--- a/LocalPluginOptions.h
+++ b/LocalPluginOptions.h
@@ -6,6 +6,12 @@
 #include "interface/OptionInterface.h"
 #include "OptionEngine.h"
 
+/** \brief To store the options
+
+  That's allow to have mutualised way to store the options. Then the plugins just keep Ultracopier manage it, the portable version will store on the disk near the application, and the normal version will keep at the normal location.
+
+  \see OptionEngine::OptionEngine()
+*/
 class LocalPluginOptions : public OptionInterface
 {
 	Q_OBJECT
diff --git a/LogThread.h b/LogThread.h
index 304b6d1d..800329ea 100644
--- a/LogThread.h
+++ b/LogThread.h
@@ -10,7 +10,10 @@
 #include "Environment.h"
 #include "StructEnumDefinition.h"
 
+/** \brief Log all the user oriented activity
 
+It use thread based storage to prevent gui thread freeze on log file writing when is out of the disk buffer. That's allow to async the event.
+*/
 class LogThread : public QThread, public GlobalClass
 {
     Q_OBJECT
diff --git a/OptionDialog.h b/OptionDialog.h
index 70b65e50..b82b4652 100755
--- a/OptionDialog.h
+++ b/OptionDialog.h
@@ -10,6 +10,11 @@ namespace Ui {
     class OptionDialog;
 }
 
+/** \brief Dialog for the options
+
+  It's need manage the ultracopier options, plugins selection, plugin prority.
+  It's need manage too the plugin options and plugins informations.
+  */
 class OptionDialog : public QDialog, public GlobalClass
 {
 	Q_OBJECT
diff --git a/OptionEngine.h b/OptionEngine.h
index daac1d7f..90a8e57b 100644
--- a/OptionEngine.h
+++ b/OptionEngine.h
@@ -27,6 +27,11 @@
 #include "Singleton.h"
 #include "ResourcesManager.h"
 
+/** \brief To store the options
+
+  That's allow to have mutualised way to store the options. Then the plugins just keep Ultracopier manage it, the portable version will store on the disk near the application, and the normal version will keep at the normal location.
+  That's allow to have cache and buffer to not slow down Ultracopier when it's doing heavy copy/move.
+*/
 class OptionEngine : public QObject, public Singleton<OptionEngine>
 {
 	Q_OBJECT
diff --git a/PluginInformation.h b/PluginInformation.h
index 30f44226..0e3ac047 100644
--- a/PluginInformation.h
+++ b/PluginInformation.h
@@ -16,6 +16,7 @@ namespace Ui {
     class PluginInformation;
 }
 
+/** \brief to show the plugin information */
 class PluginInformation : public QDialog
 {
 	Q_OBJECT
diff --git a/PluginLoader.h b/PluginLoader.h
index 5c5f459c..915a2c33 100755
--- a/PluginLoader.h
+++ b/PluginLoader.h
@@ -27,6 +27,12 @@ namespace Ui {
 /// \todo PluginLoader -> put plugin by plugin loading to add plugin no reload all
 /// \todo async the plugin call
 
+/** \brief Load the plugin
+
+  It use ResourcesManager(), but it provide more higher abstraction. It parse the plugins information, check it, check the dependancies.
+
+  \see ResourcesManager::ResourcesManager()
+  */
 class PluginLoader : public QObject, GlobalClass
 {
 	Q_OBJECT
diff --git a/SessionLoader.h b/SessionLoader.h
index 5b55150d..9c8458b6 100644
--- a/SessionLoader.h
+++ b/SessionLoader.h
@@ -23,6 +23,7 @@ This class load ALL plugin compatible to listen and catch the copy/move
 /// \todo SessionLoader -> put plugin by plugin loading to add plugin no reload all
 /// \todo async the plugin call
 
+/** \brief manage all SessionLoader plugin */
 class SessionLoader : public QObject, GlobalClass
 {
 	Q_OBJECT