Feature #1711

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

diff --git a/lib/creaDevManagerLib/wxCDMAppliHelpDialog.h b/lib/creaDevManagerLib/wxCDMAppliHelpDialog.h
index 4f60da9694502c96834d779657c6dda3f4a6617f..40d8d11ef69d98d1d21aa145bdaee0217b238ceb 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMAppliHelpDialog.h
+++ b/lib/creaDevManagerLib/wxCDMAppliHelpDialog.h
@@ -41,45 +41,97 @@
 
 #include "modelCDMAppli.h"
 
+/**
+ * Appli Panel Help Dialog
+ */
 class wxCDMAppliHelpDialog : public wxDialog
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * Appli Panel Help Dialog Constructor.
+   * @param parent Parent window.
+   * @param appli Appli class reference.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "Managing Applications".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 350, 600.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   */
   wxCDMAppliHelpDialog(
       wxWindow* parent,
       modelCDMAppli* appli,
       wxWindowID id = wxID_ANY,
-      const wxString& caption = wxT("Managing Packages"),
+      const wxString& caption = wxT("Managing Applications"),
       const wxPoint& position = wxDefaultPosition,
       const wxSize& size = wxSize(350,600),
       long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
   );
+  /**
+   * Destructor.
+   */
   ~wxCDMAppliHelpDialog();
+  /**
+     * Appli Panel Help Dialog Creator.
+     * @param parent Parent window.
+     * @param id Dialog ID. By default wxID_ANY.
+     * @param caption Dialog label. By default "Managing Applications".
+     * @param position Dialog position. By default wxDefaultPosition.
+     * @param size Dialog size. By default 350, 600.
+     * @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("Managing Packages"),
+      const wxString& caption = wxT("Managing Applications"),
       const wxPoint& position = wxDefaultPosition,
       const wxSize& size = wxSize(350,600),
       long style = wxDEFAULT_DIALOG_STYLE
   );
 
 protected:
+  /**
+   * Creates the help controls (text and buttons).
+   */
   void CreateControls();
 
 //attributes
 private:
+  /**
+   * Appli class reference.
+   */
   modelCDMAppli* appli;
 
 //handlers
 protected:
+  /**
+   * Handler to close help dialog.
+   * @param event Unused.
+   */
   void OnFinish(wxCommandEvent& event);
 
+  /**
+   * Handler when a cmakelists button is pressed.
+   * @param event cmakelists event.
+   */
   void OnEditCMake(wxCommandEvent& event);
 
-  void OnEditCMakeMouseEnter(wxMouseEvent& event);
-  void OnEditCMakeMouseExit(wxMouseEvent& event);
+  /**
+   * Handler when a cmakelists button is hovered.
+   * @param event cmakelists event.
+   */
+  void OnCMakeListsEnter(wxMouseEvent& event);
+  /**
+   * Handler when a cmakelists button hover finishes.
+   * @param event cmakelists event.
+   */
+  void OnCMakeListsExit(wxMouseEvent& event);
 
+  /**
+   * Handler when the disable help checkbox is changed.
+   * @param event check box event.
+   */
   void OnDisableHelp(wxCommandEvent& event);
 };