Feature #1711

[crea.git] / lib / creaDevManagerLib / wxCDMPackageManagerHelpDialog.h

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);
 };