Feature #1711 CreaDevManager application implementation

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

diff --git a/lib/creaDevManagerLib/wxCDMMainHelpDialog.h b/lib/creaDevManagerLib/wxCDMMainHelpDialog.h
index 7f9e5d29b6c04afea236b3b0b4a8c4faf7ba3a52..a011c245fa4c3ec23a53140ff08ec6bb299682de 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMMainHelpDialog.h
+++ b/lib/creaDevManagerLib/wxCDMMainHelpDialog.h
@@ -41,44 +41,92 @@
 
 #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,
       wxWindowID id = wxID_ANY,
       const wxString& caption = wxT("Welcome"),
       const wxPoint& position = wxDefaultPosition,
-      const wxSize& size = wxSize(350,450),
+      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,
       const wxString& caption = wxT("Welcome"),
       const wxPoint& position = wxDefaultPosition,
-      const wxSize& size = wxSize(350,450),
+      const wxSize& size = wxSize(350,370),
       long style = wxDEFAULT_DIALOG_STYLE
   );
 
 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);
 };
 
-#endif /* WXCDMPACKAGEMANAGERHELPDIALOG_H_ */
+#endif /* WXCDMMAINHELPDIALOG_H_ */