Feature #1711

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

diff --git a/lib/creaDevManagerLib/wxCDMPackageDescriptionPanel.h b/lib/creaDevManagerLib/wxCDMPackageDescriptionPanel.h
index 1601f041460fa903349b2495a57ee4a0e1418d31..8e88f9a5b79a5690771639edaa5fd635f268e846 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMPackageDescriptionPanel.h
+++ b/lib/creaDevManagerLib/wxCDMPackageDescriptionPanel.h
@@ -41,10 +41,23 @@
 
 #include "modelCDMPackage.h"
 
+/**
+ * Package description panel. Shows the package's properties and the available actions for a package.
+ */
 class wxCDMPackageDescriptionPanel : public wxPanel
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * Package description panel Constructor.
+   * @param parent Parent window reference.
+   * @param package Package 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.
+   */
   wxCDMPackageDescriptionPanel(
       wxWindow* parent,
       modelCDMPackage* package,
@@ -55,8 +68,22 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Destructor
+   */
   ~wxCDMPackageDescriptionPanel();
 
+  /**
+   * Package description panel Creator.
+   * @param parent Parent window reference.
+   * @param package Package 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 creation was successful.
+   */
   bool Create(
       wxWindow* parent,
       modelCDMPackage* package,
@@ -67,30 +94,81 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Creates all the controls in the panel (property and action controls).
+   */
   void CreateControls();
 
 private:
+  /**
+   * Package described.
+   */
   modelCDMPackage* package;
+  /**
+   * Control with the package author.
+   */
   wxStaticText* authortc;
+  /**
+   * Control with the package version.
+   */
   wxStaticText* versiontc;
+  /**
+   * Control with the package description.
+   */
   wxStaticText* descriptiontc;
 
   //handlers
 protected:
+  /**
+   * Handles when a return link is pressed.
+   */
   void OnBtnReturn(wxHyperlinkEvent& event);
 
+  /**
+   * Handles when the Set author button is pressed.
+   */
   void OnBtnSetAuthor(wxCommandEvent& event);
+  /**
+   * Handles when the Set version button is pressed.
+   */
   void OnBtnSetVersion(wxCommandEvent& event);
+  /**
+   * Handles when the Change description button is pressed.
+   */
   void OnBtnSetDescription(wxCommandEvent& event);
 
+  /**
+   * Handles when a black box link is pressed.
+   */
   void OnLnkBlackBoxSelect(wxHyperlinkEvent& event);
 
+  /**
+   * Handles when the create black box button is pressed.
+   */
   void OnBtnCreateBlackBox(wxCommandEvent& event);
+  /**
+   * Handles when the edit cmakelists file button is pressed.
+   */
   void OnBtnEditCMakeLists(wxCommandEvent& event);
+  /**
+   * Handles when the open folder button is pressed.
+   */
   void OnBtnOpenFolder(wxCommandEvent& event);
+  /**
+   * Handles when a black box link is hovered.
+   */
   void OnMouseEnter(wxMouseEvent& event);
+  /**
+   * Handles when a black box link exits hover.
+   */
   void OnMouseExit(wxMouseEvent& event);
+  /**
+   * Handles when the edit cmakelists file button is hovered.
+   */
   void OnCMakeMouseEnter(wxMouseEvent& event);
+  /**
+   * Handles when the edit cmakelists file button exits hover.
+   */
   void OnCMakeMouseExit(wxMouseEvent& event);
 
 };