X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=lib%2FcreaDevManagerLib%2FwxCDMMainHelpDialog.h;h=a011c245fa4c3ec23a53140ff08ec6bb299682de;hb=175a81477d0476f53162766202df7be421afe3aa;hp=9ac5e7100575a4f7800d7d14592eeacb9c7b06e8;hpb=9db5150d933dff7a6b833c54847d1c35ac38a9c6;p=crea.git

diff --git a/lib/creaDevManagerLib/wxCDMMainHelpDialog.h b/lib/creaDevManagerLib/wxCDMMainHelpDialog.h
index 9ac5e71..a011c24 100644
--- 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,20 @@ 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.
+   * @return if the creation was successful.
+   */
   bool Create(
       wxWindow* parent,
       wxWindowID id = wxID_ANY,
@@ -65,19 +91,41 @@ 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.
+   * @param event Unused.
+   */
   void OnFinish(wxCommandEvent& event);
 
+  /**
+   * Handler when new project button is pressed.
+   * @param event Unused.
+   */
   void OnNewProject(wxCommandEvent& event);
+  /**
+   * Handler when open project button is pressed.
+   * @param event Unused.
+   */
   void OnOpenProject(wxCommandEvent& event);
 
+  /**
+   * Handler when the disable help checkbox is changed.
+   * @param event check box event.
+   */
   void OnDisableHelp(wxCommandEvent& event);
 };