Feature #1711

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

diff --git a/lib/creaDevManagerLib/wxCDMBlackBoxDescriptionPanel.h b/lib/creaDevManagerLib/wxCDMBlackBoxDescriptionPanel.h
index 4eeef1ab0853e39b20de5aa07bf1deeb08a72b5f..94d3071a422d9f7271d69e4a151618c57be6b1c5 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMBlackBoxDescriptionPanel.h
+++ b/lib/creaDevManagerLib/wxCDMBlackBoxDescriptionPanel.h
@@ -41,10 +41,23 @@
 
 #include "modelCDMBlackBox.h"
 
+/**
+ * Black box description panel. Shows the properties and available actions for the described black box.
+ */
 class wxCDMBlackBoxDescriptionPanel : public wxPanel
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * Black box description panel Constructor.
+   * @param parent Parent window reference.
+   * @param blackBox Black box class reference.
+   * @param id Panel ID. By default -1.
+   * @param caption Panel label. By default "Description Frame".
+   * @param pos Panel position. By default wxDefaultPosition.
+   * @param size Panel size. By default wxDefaultSize.
+   * @param style Panel style. By default wxDEFAULT_FRAME_STYLE.
+   */
   wxCDMBlackBoxDescriptionPanel(
       wxWindow* parent,
       modelCDMBlackBox* blackBox,
@@ -55,8 +68,22 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Destructor.
+   */
   ~wxCDMBlackBoxDescriptionPanel();
 
+  /**
+   * Black box description panel Creator.
+   * @param parent Parent window reference.
+   * @param blackBox Black box class reference.
+   * @param id Panel ID. By default -1.
+   * @param caption Panel label. By default "Description Frame".
+   * @param pos Panel position. By default wxDefaultPosition.
+   * @param size Panel size. By default wxDefaultSize.
+   * @param style Panel style. By default wxDEFAULT_FRAME_STYLE.
+   * @return True if the creatios was successful.
+   */
   bool Create(
       wxWindow* parent,
       modelCDMBlackBox* blackBox,
@@ -67,27 +94,76 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Creates all the controls in the panel (property and action controls).
+   */
   void CreateControls();
 
 private:
+  /**
+   * Black box described.
+   */
   modelCDMBlackBox* blackBox;
+  /**
+   * Black box author control.
+   */
   wxStaticText* authortc;
+  /**
+   * Black box description control
+   */
   wxStaticText* descriptiontc;
+  /**
+   * Black box categories control.
+   */
   wxStaticText* categoriestc;
 
   //handlers
 protected:
+  /**
+   * Handles when a return link is pressed.
+   * @param event Has the link reference to know where to return
+   */
   void OnBtnReturn(wxHyperlinkEvent& event);
+  /**
+   * Handles when the set author button is pressed.
+   */
   void OnBtnSetAuthor(wxCommandEvent& event);
+  /**
+   * Handles when the set description button is pressed.
+   */
   void OnBtnSetDescription(wxCommandEvent& event);
+  /**
+   * Handles when the set categories button is pressed.
+   */
   void OnBtnSetCategories(wxCommandEvent& event);
+  /**
+   * Handles when the open Cxx button is pressed.
+   */
   void OnBtnOpenCxx(wxCommandEvent& event);
+  /**
+   * Handles when the open Hxx button is pressed.
+   */
   void OnBtnOpenHxx(wxCommandEvent& event);
+  /**
+   * Handles when the open Folder button is pressed.
+   */
   void OnBtnOpenFolder(wxCommandEvent& event);
 
+  /**
+   * Handles when the open Cxx button is hovered.
+   */
   void OnCxxMouseEnter(wxMouseEvent& event);
+  /**
+   * Handles when the open Cxx button finishes hover.
+   */
   void OnCxxMouseExit(wxMouseEvent& event);
+  /**
+   * Handles when the open Hxx button is hovered.
+   */
   void OnHxxMouseEnter(wxMouseEvent& event);
+  /**
+   * Handles when the open Hxx button finishes hover.
+   */
   void OnHxxMouseExit(wxMouseEvent& event);