Feature #1711 CreaDevManager application implementation

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

diff --git a/lib/creaDevManagerLib/wxCDMBlackBoxHelpDialog.h b/lib/creaDevManagerLib/wxCDMBlackBoxHelpDialog.h
index 40fca3246ee50eefc382495bae65da56965e81ef..66995d515682f29d511110226ae8238825963984 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMBlackBoxHelpDialog.h
+++ b/lib/creaDevManagerLib/wxCDMBlackBoxHelpDialog.h
@@ -43,10 +43,23 @@
 
 #include <vector>
 
+/**
+ * Black Box Panel Help Dialog
+ */
 class wxCDMBlackBoxHelpDialog : public wxDialog
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * Black Box Panel Help Dialog Constructor.
+   * @param parent Parent window.
+   * @param blackBox Black Box class reference.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "Working with Black Boxes".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 410, 700.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   */
   wxCDMBlackBoxHelpDialog(
       wxWindow* parent,
       modelCDMBlackBox* blackBox,
@@ -56,7 +69,20 @@ public:
       const wxSize& size = wxSize(410,700),
       long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
   );
+  /**
+   * Destructor.
+   */
   ~wxCDMBlackBoxHelpDialog();
+  /**
+   * Black Box Panel Help Dialog Creator.
+   * @param parent Parent window.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "Working with Black Boxes".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 410, 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,
@@ -67,20 +93,46 @@ public:
   );
 
 protected:
+  /**
+   * Creates the help controls (text and buttons).
+   */
   void CreateControls();
 
 private:
+  /**
+   * Black Box class reference.
+   */
   modelCDMBlackBox* blackBox;
 
 //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 OnCMakeLists(wxCommandEvent& 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);
 };