Feature #1711

CreaDevManager application implementation

- View Help Classes documented.

diff --git a/lib/creaDevManagerLib/wxCDMAppliHelpDialog.h b/lib/creaDevManagerLib/wxCDMAppliHelpDialog.h
index e788468aef8b7fb7de2cc668b7076103bd42603b..21cf046d612f81f715a7c233683898ac17ee581b 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMAppliHelpDialog.h
+++ b/lib/creaDevManagerLib/wxCDMAppliHelpDialog.h
@@ -41,45 +41,91 @@
 
 #include "modelCDMAppli.h"
 
+/**
+ * Appli Panel Help Dialog
+ */
 class wxCDMAppliHelpDialog : public wxDialog
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * Appli Panel Help Dialog Constructor.
+   * @param parent Parent window.
+   * @param appli Appli class reference.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "Managing Applications".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 350, 600.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   */
   wxCDMAppliHelpDialog(
       wxWindow* parent,
       modelCDMAppli* appli,
       wxWindowID id = wxID_ANY,
-      const wxString& caption = wxT("Managing Packages"),
+      const wxString& caption = wxT("Managing Applications"),
       const wxPoint& position = wxDefaultPosition,
       const wxSize& size = wxSize(350,600),
       long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
   );
+  /**
+   * Destructor.
+   */
   ~wxCDMAppliHelpDialog();
+  /**
+     * Appli Panel Help Dialog Creator.
+     * @param parent Parent window.
+     * @param id Dialog ID. By default wxID_ANY.
+     * @param caption Dialog label. By default "Managing Applications".
+     * @param position Dialog position. By default wxDefaultPosition.
+     * @param size Dialog size. By default 350, 600.
+     * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+     */
   bool Create(
       wxWindow* parent,
       wxWindowID id = wxID_ANY,
-      const wxString& caption = wxT("Managing Packages"),
+      const wxString& caption = wxT("Managing Applications"),
       const wxPoint& position = wxDefaultPosition,
       const wxSize& size = wxSize(350,600),
       long style = wxDEFAULT_DIALOG_STYLE
   );
 
 protected:
+  /**
+   * Creates the help controls (text and buttons).
+   */
   void CreateControls();
 
 //attributes
 private:
+  /**
+   * Appli class reference.
+   */
   modelCDMAppli* appli;
 
 //handlers
 protected:
+  /**
+   * Handler to close help dialog.
+   */
   void OnFinish(wxCommandEvent& event);
 
+  /**
+   * Handler when a cmakelists button is pressed.
+   */
   void OnEditCMake(wxCommandEvent& event);
 
+  /**
+   * Handler when a cmakelists button is hovered.
+   */
   void OnCMakeListsEnter(wxMouseEvent& event);
+  /**
+   * Handler when a cmakelists button hover finishes.
+   */
   void OnCMakeListsExit(wxMouseEvent& event);
 
+  /**
+   * Handler when the disable help checkbox is changed.
+   */
   void OnDisableHelp(wxCommandEvent& event);
 };
 

diff --git a/lib/creaDevManagerLib/wxCDMApplicationHelpDialog.h b/lib/creaDevManagerLib/wxCDMApplicationHelpDialog.h
index 084c18116b5b96de8b966c564d2d030db186788a..0d891d0a65147c11c8645f539ef4cd7db21cedb8 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMApplicationHelpDialog.h
+++ b/lib/creaDevManagerLib/wxCDMApplicationHelpDialog.h
@@ -23,7 +23,7 @@
 #  The fact that you are presently reading this means that you have had
 #  knowledge of the CeCILL-B license and that you accept its terms.
 # ------------------------------------------------------------------------ 
-*/ 
+ */
 
 
 /*
@@ -43,10 +43,23 @@
 
 #include <vector>
 
+/**
+ * Application Panel Help Dialog
+ */
 class wxCDMApplicationHelpDialog : public wxDialog
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * Application Panel Help Dialog Constructor.
+   * @param parent Parent window.
+   * @param application Application class reference.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "Working with Applications".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 410, 670.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   */
   wxCDMApplicationHelpDialog(
       wxWindow* parent,
       modelCDMApplication* application,
@@ -56,7 +69,19 @@ public:
       const wxSize& size = wxSize(410,670),
       long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
   );
+  /**
+   * Destructor.
+   */
   ~wxCDMApplicationHelpDialog();
+  /**
+   * Application Panel Help Dialog Creator.
+   * @param parent Parent window.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "Working with Applications".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 410, 670.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   */
   bool Create(
       wxWindow* parent,
       wxWindowID id = wxID_ANY,
@@ -67,20 +92,41 @@ public:
   );
 
 protected:
+  /**
+   * Creates the help controls (text and buttons).
+   */
   void CreateControls();
 
 private:
+  /**
+   * Application class reference.
+   */
   modelCDMApplication* application;
 
-//handlers
+  //handlers
 protected:
+  /**
+   * Handler to close help dialog.
+   */
   void OnFinish(wxCommandEvent& event);
 
+  /**
+   * Handler when a cmakelists button is pressed.
+   */
   void OnCMakeLists(wxCommandEvent& event);
 
+  /**
+   * Handler when a cmakelists button is hovered.
+   */
   void OnCMakeListsEnter(wxMouseEvent& event);
+  /**
+   * Handler when a cmakelists button hover finishes.
+   */
   void OnCMakeListsExit(wxMouseEvent& event);
 
+  /**
+   * Handler when the disable help checkbox is changed.
+   */
   void OnDisableHelp(wxCommandEvent& event);
 };
 

diff --git a/lib/creaDevManagerLib/wxCDMBlackBoxHelpDialog.h b/lib/creaDevManagerLib/wxCDMBlackBoxHelpDialog.h
index 40fca3246ee50eefc382495bae65da56965e81ef..25438c6366fce110375f1a8c62de5b0afca9b08d 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMBlackBoxHelpDialog.h
+++ b/lib/creaDevManagerLib/wxCDMBlackBoxHelpDialog.h
@@ -43,10 +43,23 @@
 
 #include <vector>
 
+/**
+ * Black Box Panel Help Dialog
+ */
 class wxCDMBlackBoxHelpDialog : public wxDialog
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * Black Box Panel Help Dialog Constructor.
+   * @param parent Parent window.
+   * @param blackBox Black Box class reference.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "Working with Black Boxes".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 410, 700.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   */
   wxCDMBlackBoxHelpDialog(
       wxWindow* parent,
       modelCDMBlackBox* blackBox,
@@ -56,7 +69,19 @@ public:
       const wxSize& size = wxSize(410,700),
       long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
   );
+  /**
+   * Destructor.
+   */
   ~wxCDMBlackBoxHelpDialog();
+  /**
+   * Black Box Panel Help Dialog Creator.
+   * @param parent Parent window.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "Working with Black Boxes".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 410, 700.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   */
   bool Create(
       wxWindow* parent,
       wxWindowID id = wxID_ANY,
@@ -67,20 +92,41 @@ public:
   );
 
 protected:
+  /**
+   * Creates the help controls (text and buttons).
+   */
   void CreateControls();
 
 private:
+  /**
+   * Black Box class reference.
+   */
   modelCDMBlackBox* blackBox;
 
 //handlers
 protected:
+  /**
+   * Handler to close help dialog.
+   */
   void OnFinish(wxCommandEvent& event);
 
+  /**
+   * Handler when a cmakelists button is pressed.
+   */
   void OnCMakeLists(wxCommandEvent& event);
 
+  /**
+   * Handler when a cmakelists button is hovered.
+   */
   void OnCMakeListsEnter(wxMouseEvent& event);
+  /**
+   * Handler when a cmakelists button hover finishes.
+   */
   void OnCMakeListsExit(wxMouseEvent& event);
 
+  /**
+   * Handler when the disable help checkbox is changed.
+   */
   void OnDisableHelp(wxCommandEvent& event);
 };
 

diff --git a/lib/creaDevManagerLib/wxCDMLibHelpDialog.h b/lib/creaDevManagerLib/wxCDMLibHelpDialog.h
index 59a000f53dfb9063ad7fd71c0fe1a17fcfb1eabd..5620dc93f19bc6e60c61e01a90e4b5fd5dfd42a2 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMLibHelpDialog.h
+++ b/lib/creaDevManagerLib/wxCDMLibHelpDialog.h
@@ -23,7 +23,7 @@
 #  The fact that you are presently reading this means that you have had
 #  knowledge of the CeCILL-B license and that you accept its terms.
 # ------------------------------------------------------------------------ 
-*/ 
+ */
 
 
 /*
@@ -41,10 +41,23 @@
 
 #include "modelCDMLib.h"
 
+/**
+ * Lib Panel Help Dialog
+ */
 class wxCDMLibHelpDialog : public wxDialog
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * Lib Panel Help Dialog Constructor.
+   * @param parent Parent window.
+   * @param lib Library class reference.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "Managing Libraries".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 350, 600.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   */
   wxCDMLibHelpDialog(
       wxWindow* parent,
       modelCDMLib* lib,
@@ -54,7 +67,19 @@ public:
       const wxSize& size = wxSize(350,600),
       long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
   );
+  /**
+   * Destructor.
+   */
   ~wxCDMLibHelpDialog();
+  /**
+   * Lib Panel Help Dialog Creator.
+   * @param parent Parent window.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "Managing Libraries".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 350, 600.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   */
   bool Create(
       wxWindow* parent,
       wxWindowID id = wxID_ANY,
@@ -65,21 +90,42 @@ public:
   );
 
 protected:
+  /**
+   * Creates the help controls (text and buttons).
+   */
   void CreateControls();
 
-//attributes
+  //attributes
 private:
+  /**
+   * Lib class reference.
+   */
   modelCDMLib* lib;
 
-//handlers
+  //handlers
 protected:
+  /**
+   * Handler to close help dialog.
+   */
   void OnFinish(wxCommandEvent& event);
 
+  /**
+   * Handler when a cmakelists button is pressed.
+   */
   void OnEditCMake(wxCommandEvent& event);
 
+  /**
+   * Handler when a cmakelists button is hovered.
+   */
   void OnEditCMakeMouseEnter(wxMouseEvent& event);
+  /**
+   * Handler when a cmakelists button hover finishes.
+   */
   void OnEditCMakeMouseExit(wxMouseEvent& event);
 
+  /**
+   * Handler when the disable help checkbox is changed.
+   */
   void OnDisableHelp(wxCommandEvent& event);
 };
 

diff --git a/lib/creaDevManagerLib/wxCDMLibraryHelpDialog.h b/lib/creaDevManagerLib/wxCDMLibraryHelpDialog.h
index 328ee4dde320acfd178584c080a71d615eac0c52..1d327fa6d48b6efabfadfd36622718415b4ea288 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMLibraryHelpDialog.h
+++ b/lib/creaDevManagerLib/wxCDMLibraryHelpDialog.h
@@ -43,10 +43,23 @@
 
 #include <vector>
 
+/**
+ * Library Panel Help Dialog
+ */
 class wxCDMLibraryHelpDialog : public wxDialog
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * Library Panel Help Dialog Constructor.
+   * @param parent Parent window.
+   * @param library Library class reference.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "Working with Libraries".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 410, 650.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   */
   wxCDMLibraryHelpDialog(
       wxWindow* parent,
       modelCDMLibrary* library,
@@ -56,7 +69,19 @@ public:
       const wxSize& size = wxSize(410,650),
       long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
   );
+  /**
+   * Destructor.
+   */
   ~wxCDMLibraryHelpDialog();
+  /**
+   * Library Panel Help Dialog Creator.
+   * @param parent Parent window.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "Working with Libraries".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 410, 650.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   */
   bool Create(
       wxWindow* parent,
       wxWindowID id = wxID_ANY,
@@ -67,20 +92,42 @@ public:
   );
 
 protected:
+  /**
+   * Creates the help controls (text and buttons).
+   */
   void CreateControls();
 
 private:
+  /**
+   * Library class reference.
+   */
   modelCDMLibrary* library;
 
 //handlers
 protected:
+  /**
+   * Handler to close help dialog.
+   */
   void OnFinish(wxCommandEvent& event);
 
+  /**
+   * Handler when a cmakelists button is pressed.
+   */
   void OnCMakeLists(wxCommandEvent& event);
 
+  /**
+   * Handler when a cmakelists button is hovered.
+   */
   void OnCMakeListsEnter(wxMouseEvent& event);
+
+  /**
+   * Handler when a cmakelists button hover finishes.
+   */
   void OnCMakeListsExit(wxMouseEvent& event);
 
+  /**
+   * Handler when the disable help checkbox is changed.
+   */
   void OnDisableHelp(wxCommandEvent& event);
 };
 

diff --git a/lib/creaDevManagerLib/wxCDMMainHelpDialog.h b/lib/creaDevManagerLib/wxCDMMainHelpDialog.h
index 9ac5e7100575a4f7800d7d14592eeacb9c7b06e8..1fc0e2b49553a8b204eabe87a9569b9cb4ca7be0 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMMainHelpDialog.h
+++ b/lib/creaDevManagerLib/wxCDMMainHelpDialog.h
@@ -41,10 +41,23 @@
 
 #include "wxCDMMainDescriptionPanel.h"
 
+/**
+ * Main Panel Help Dialog
+ */
 class wxCDMMainHelpDialog : public wxDialog
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * Main Panel Help Dialog Constructor.
+   * @param parent Parent window.
+   * @param packageManager Main panel reference.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "Welcome".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 350, 370.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   */
   wxCDMMainHelpDialog(
       wxWindow* parent,
       wxCDMMainDescriptionPanel* packageManager,
@@ -54,7 +67,19 @@ public:
       const wxSize& size = wxSize(350,370),
       long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
   );
+  /**
+   * Destructor.
+   */
   ~wxCDMMainHelpDialog();
+  /**
+   * Main Panel Help Dialog Creator.
+   * @param parent Parent window.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "Welcome".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 350, 370.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   */
   bool Create(
       wxWindow* parent,
       wxWindowID id = wxID_ANY,
@@ -65,19 +90,37 @@ public:
   );
 
 protected:
+  /**
+   * Creates the help controls (text and buttons).
+   */
   void CreateControls();
 
 //attributes
 private:
+  /**
+   * Main panel reference.
+   */
   wxCDMMainDescriptionPanel* mainDescription;
 
 //handlers
 protected:
+  /**
+   * Handler to close help dialog.
+   */
   void OnFinish(wxCommandEvent& event);
 
+  /**
+   * Handler when new project button is pressed.
+   */
   void OnNewProject(wxCommandEvent& event);
+  /**
+   * Handler when open project button is pressed.
+   */
   void OnOpenProject(wxCommandEvent& event);
 
+  /**
+   * Handler when the disable help checkbox is changed.
+   */
   void OnDisableHelp(wxCommandEvent& event);
 };
 

diff --git a/lib/creaDevManagerLib/wxCDMPackageHelpDialog.h b/lib/creaDevManagerLib/wxCDMPackageHelpDialog.h
index 1db7ffabf8299af2b554e17d3a3b8706b9738dfd..9dd08c6e1fd31d85a392e63e63389aebdcec1ff0 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMPackageHelpDialog.h
+++ b/lib/creaDevManagerLib/wxCDMPackageHelpDialog.h
@@ -43,10 +43,23 @@
 
 #include <vector>
 
+/**
+ * Package Panel Help Dialog
+ */
 class wxCDMPackageHelpDialog : public wxDialog
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * Package Panel Help Dialog Constructor.
+   * @param parent Parent window.
+   * @param package Package class reference.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "Working with Packages".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 350, 570.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   */
   wxCDMPackageHelpDialog(
       wxWindow* parent,
       modelCDMPackage* package,
@@ -56,7 +69,19 @@ public:
       const wxSize& size = wxSize(350,570),
       long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
   );
+  /**
+   * Destructor.
+   */
   ~wxCDMPackageHelpDialog();
+  /**
+   * Package Panel Help Dialog Constructor.
+   * @param parent Parent window.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "Working with Packages".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 350, 570.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   */
   bool Create(
       wxWindow* parent,
       wxWindowID id = wxID_ANY,
@@ -67,20 +92,41 @@ public:
   );
 
 protected:
+  /**
+   * Creates the help controls (text and buttons).
+   */
   void CreateControls();
 
 private:
+  /**
+   * Package class reference.
+   */
   modelCDMPackage* package;
 
 //handlers
 protected:
+  /**
+   * Handler to close help dialog.
+   */
   void OnFinish(wxCommandEvent& event);
 
+  /**
+   * Handler when a cmakelists button is pressed.
+   */
   void OnCMakeLists(wxCommandEvent& event);
 
+  /**
+   * Handler when a cmakelists button is hovered.
+   */
   void OnCMakeListsEnter(wxMouseEvent& event);
+  /**
+   * Handler when a cmakelists button hover finishes.
+   */
   void OnCMakeListsExit(wxMouseEvent& event);
 
+  /**
+   * Handler when the disable help checkbox is changed.
+   */
   void OnDisableHelp(wxCommandEvent& event);
 };
 

diff --git a/lib/creaDevManagerLib/wxCDMPackageManagerHelpDialog.h b/lib/creaDevManagerLib/wxCDMPackageManagerHelpDialog.h
index e20e377feabeea3e749143cb1ebed3fa66681c95..1f03aa07307d78c13992e74a3d4e94c24714d7d0 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMPackageManagerHelpDialog.h
+++ b/lib/creaDevManagerLib/wxCDMPackageManagerHelpDialog.h
@@ -41,10 +41,23 @@
 
 #include "wxCDMPackageManagerPanel.h"
 
+/**
+ * Package Manager Panel Help Dialog
+ */
 class wxCDMPackageManagerHelpDialog : public wxDialog
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * Package Manager Panel Help Dialog Constructor.
+   * @param parent Parent window.
+   * @param packageManager Package Manager panel reference.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "Managing Packages".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 350, 450.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   */
   wxCDMPackageManagerHelpDialog(
       wxWindow* parent,
       wxCDMPackageManagerPanel* packageManager,
@@ -54,7 +67,19 @@ public:
       const wxSize& size = wxSize(350,450),
       long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
   );
+  /**
+   * Destructor.
+   */
   ~wxCDMPackageManagerHelpDialog();
+  /**
+   * Package Manager Panel Help Dialog Creator.
+   * @param parent Parent window.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "Managing Packages".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 350, 450.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   */
   bool Create(
       wxWindow* parent,
       wxWindowID id = wxID_ANY,
@@ -65,22 +90,46 @@ public:
   );
 
 protected:
+  /**
+   * Creates the help controls (text and buttons).
+   */
   void CreateControls();
 
 //attributes
 private:
+  /**
+   * Package Manager panel reference.
+   */
   wxCDMPackageManagerPanel* packageManager;
 
 //handlers
 protected:
+  /**
+   * Handler to close help dialog.
+   */
   void OnFinish(wxCommandEvent& event);
 
+  /**
+   * Handler when the create package button is pressed.
+   */
   void OnCreatePackage(wxCommandEvent& event);
+  /**
+   * Handler when a cmakelists button is pressed.
+   */
   void OnEditCMake(wxCommandEvent& event);
 
+  /**
+   * Handler when a cmakelists button is hovered.
+   */
   void OnEditCMakeMouseEnter(wxMouseEvent& event);
+  /**
+   * Handler when a cmakelists button hover finishes.
+   */
   void OnEditCMakeMouseExit(wxMouseEvent& event);
 
+  /**
+   * Handler when the disable help checkbox is changed.
+   */
   void OnDisableHelp(wxCommandEvent& event);
 };
 

diff --git a/lib/creaDevManagerLib/wxCDMProjectHelpDialog.h b/lib/creaDevManagerLib/wxCDMProjectHelpDialog.h
index b9631a776afc138cb9795178eb12f448be239ea8..bc79bf946c931f497d3e05cb2e7ec965fdbdbe32 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMProjectHelpDialog.h
+++ b/lib/creaDevManagerLib/wxCDMProjectHelpDialog.h
@@ -41,10 +41,23 @@
 
 #include "wxCDMProjectDescriptionPanel.h"
 
+/**
+ * Project Panel Help Dialog
+ */
 class wxCDMProjectHelpDialog : public wxDialog
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * Project Panel Help Dialog Constructor.
+   * @param parent Parent window.
+   * @param project Project class reference.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "Project Ready".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 350, 700.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   */
   wxCDMProjectHelpDialog(
       wxWindow* parent,
       modelCDMProject* project,
@@ -54,7 +67,19 @@ public:
       const wxSize& size = wxSize(350,700),
       long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
   );
+  /**
+   * Destructor.
+   */
   ~wxCDMProjectHelpDialog();
+  /**
+   * Project Panel Help Dialog Creator.
+   * @param parent Parent window.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "Project Ready".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 350, 700.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   */
   bool Create(
       wxWindow* parent,
       wxWindowID id = wxID_ANY,
@@ -65,16 +90,28 @@ public:
   );
 
 protected:
+  /**
+   * Creates the help controls (text and buttons).
+   */
   void CreateControls();
 
 //attributes
 private:
+  /**
+   * Project class reference.
+   */
   modelCDMProject* project;
 
 //handlers
 protected:
+  /**
+   * Handler to close help dialog.
+   */
   void OnFinish(wxCommandEvent& event);
 
+  /**
+   * Handler when the disable help checkbox is changed.
+   */
   void OnDisableHelp(wxCommandEvent& event);
 };