Feature #1711

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

diff --git a/lib/creaDevManagerLib/wxCDMApplicationHelpDialog.h b/lib/creaDevManagerLib/wxCDMApplicationHelpDialog.h
index 084c18116b5b96de8b966c564d2d030db186788a..0d891d0a65147c11c8645f539ef4cd7db21cedb8 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMApplicationHelpDialog.h
+++ b/lib/creaDevManagerLib/wxCDMApplicationHelpDialog.h
@@ -23,7 +23,7 @@
 #  The fact that you are presently reading this means that you have had
 #  knowledge of the CeCILL-B license and that you accept its terms.
 # ------------------------------------------------------------------------ 
-*/ 
+ */
 
 
 /*
@@ -43,10 +43,23 @@
 
 #include <vector>
 
+/**
+ * Application Panel Help Dialog
+ */
 class wxCDMApplicationHelpDialog : public wxDialog
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * Application Panel Help Dialog Constructor.
+   * @param parent Parent window.
+   * @param application Application class reference.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "Working with Applications".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 410, 670.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   */
   wxCDMApplicationHelpDialog(
       wxWindow* parent,
       modelCDMApplication* application,
@@ -56,7 +69,19 @@ public:
       const wxSize& size = wxSize(410,670),
       long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
   );
+  /**
+   * Destructor.
+   */
   ~wxCDMApplicationHelpDialog();
+  /**
+   * Application Panel Help Dialog Creator.
+   * @param parent Parent window.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "Working with Applications".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 410, 670.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   */
   bool Create(
       wxWindow* parent,
       wxWindowID id = wxID_ANY,
@@ -67,20 +92,41 @@ public:
   );
 
 protected:
+  /**
+   * Creates the help controls (text and buttons).
+   */
   void CreateControls();
 
 private:
+  /**
+   * Application class reference.
+   */
   modelCDMApplication* application;
 
-//handlers
+  //handlers
 protected:
+  /**
+   * Handler to close help dialog.
+   */
   void OnFinish(wxCommandEvent& event);
 
+  /**
+   * Handler when a cmakelists button is pressed.
+   */
   void OnCMakeLists(wxCommandEvent& event);
 
+  /**
+   * Handler when a cmakelists button is hovered.
+   */
   void OnCMakeListsEnter(wxMouseEvent& event);
+  /**
+   * Handler when a cmakelists button hover finishes.
+   */
   void OnCMakeListsExit(wxMouseEvent& event);
 
+  /**
+   * Handler when the disable help checkbox is changed.
+   */
   void OnDisableHelp(wxCommandEvent& event);
 };