Skip to content

Commit

Permalink
Add more comment, mainly about the class information
Browse files Browse the repository at this point in the history
  • Loading branch information
alphaonex86 committed Jan 23, 2012
1 parent 7afb96e commit a25fff8
Show file tree
Hide file tree
Showing 14 changed files with 37 additions and 0 deletions.
1 change: 1 addition & 0 deletions AuthPlugin.h
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

#include "Environment.h"

/** \brief allow authentify the plugin */
class AuthPlugin : public QThread
{
Q_OBJECT
Expand Down
1 change: 1 addition & 0 deletions CliParser.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
#include <QObject>
#include <QMessageBox>

/** \brief class to parse all command line options */
class CliParser : public QObject
{
Q_OBJECT
Expand Down
1 change: 1 addition & 0 deletions CopyEngineManager.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ namespace Ui {
class CopyEngineOptions;
}

/** \brief Manage copy engine plugins and their instance */
class CopyEngineManager : public QObject, public GlobalClass
{
Q_OBJECT
Expand Down
1 change: 1 addition & 0 deletions ExtraSocket.h
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
#include <windows.h>
#endif

/** \brief class to have general socket options */
class ExtraSocket
{
public:
Expand Down
4 changes: 4 additions & 0 deletions FacilityEngine.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions HelpDialog.h
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions LocalListener.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions LocalPluginOptions.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions LogThread.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions OptionDialog.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions OptionEngine.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions PluginInformation.h
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ namespace Ui {
class PluginInformation;
}

/** \brief to show the plugin information */
class PluginInformation : public QDialog
{
Q_OBJECT
Expand Down
6 changes: 6 additions & 0 deletions PluginLoader.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions SessionLoader.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit a25fff8

Please sign in to comment.