Feature #1711

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

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