X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=lib%2FcreaDevManagerLib%2FwxCDMProjectHelpDialog.h;h=0087dd06946d6e6ba326a6560abde3cb80e2419b;hb=9f11db34cb1acacf545f819d6b552a95835d93bd;hp=789d81223f42f8ade40b40b9080662a6d1a23c7e;hpb=4e0312091408bc9bd77f3f70ade44d207365cdbe;p=crea.git

diff --git a/lib/creaDevManagerLib/wxCDMProjectHelpDialog.h b/lib/creaDevManagerLib/wxCDMProjectHelpDialog.h
index 789d812..0087dd0 100644
--- a/lib/creaDevManagerLib/wxCDMProjectHelpDialog.h
+++ b/lib/creaDevManagerLib/wxCDMProjectHelpDialog.h
@@ -41,40 +41,80 @@
 
 #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,
       wxWindowID id = wxID_ANY,
       const wxString& caption = wxT("Project Ready"),
       const wxPoint& position = wxDefaultPosition,
-      const wxSize& size = wxSize(350,550),
+      const wxSize& size = wxSize(350,730),
       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.
+   * @return if the creation was successful.
+   */
   bool Create(
       wxWindow* parent,
       wxWindowID id = wxID_ANY,
       const wxString& caption = wxT("Project Ready"),
       const wxPoint& position = wxDefaultPosition,
-      const wxSize& size = wxSize(350,550),
+      const wxSize& size = wxSize(350,730),
       long style = wxDEFAULT_DIALOG_STYLE
   );
 
 protected:
+  /**
+   * Creates the help controls (text and buttons).
+   */
   void CreateControls();
 
 //attributes
 private:
+  /**
+   * Project class reference.
+   */
   modelCDMProject* project;
 
 //handlers
 protected:
+  /**
+   * Handler to close help dialog.
+   * @param event Unused.
+   */
   void OnFinish(wxCommandEvent& event);
 
+  /**
+   * Handler when the disable help checkbox is changed.
+   * @param event Check box event.
+   */
   void OnDisableHelp(wxCommandEvent& event);
 };