Feature #1711

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

diff --git a/lib/creaDevManagerLib/wxCDMApplicationDescriptionPanel.h b/lib/creaDevManagerLib/wxCDMApplicationDescriptionPanel.h
index 823272b7b28b2903c04b95c935b4fb99b5eacb8a..741eb44e9c4d4aaffd7966291b580dc820a0aab6 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMApplicationDescriptionPanel.h
+++ b/lib/creaDevManagerLib/wxCDMApplicationDescriptionPanel.h
@@ -41,10 +41,23 @@
 
 #include "modelCDMApplication.h"
 
+/**
+ * Application description panel. Shows the properties and actions available for the described application.
+ */
 class wxCDMApplicationDescriptionPanel : public wxPanel
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * Application description panel Constructor.
+   * @param parent Parent window reference.
+   * @param application Application 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.
+   */
   wxCDMApplicationDescriptionPanel(
       wxWindow* parent,
       modelCDMApplication* application,
@@ -55,8 +68,21 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Destructor.
+   */
   ~wxCDMApplicationDescriptionPanel();
 
+  /**
+   * Application description panel Creator.
+   * @param parent Parent window reference.
+   * @param application Application 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.
+   */
   bool Create(
       wxWindow* parent,
       modelCDMApplication* application,
@@ -67,24 +93,68 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Creates all the controls in the panel (property and action controls).
+   */
   void CreateControls();
 
 private:
+  /**
+   * Application described.
+   */
   modelCDMApplication* application;
+  /**
+   * described application's executable name control.
+   */
   wxStaticText* executableNametc;
 
   //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 executable name button is pressed.
+   */
   void OnBtnSetExeName(wxCommandEvent& event);
+  /**
+   * Handles when the create class button is pressed.
+   */
   void OnBtnCreateClass(wxCommandEvent& event);
+  /**
+   * Handles when the create folder button is pressed.
+   */
   void OnBtnCreateFolder(wxCommandEvent& event);
+  /**
+   * Handles when the open package cmakelists file button is pressed.
+   */
   void OnBtnEditCMakeLists(wxCommandEvent& event);
+  /**
+   * Handles when the open containing folder button is pressed.
+   */
   void OnBtnOpenFolder(wxCommandEvent& event);
+  /**
+   * Handles when the open cmakelists file button is hovered.
+   */
   void OnCMakeMouseEnter(wxMouseEvent& event);
+  /**
+   * Handles when the open cmakelists file button finishes hover.
+   */
   void OnCMakeMouseExit(wxMouseEvent& event);
+  /**
+   * Handles when the open Main file button is pressed.
+   */
   void OnBtnOpenMain(wxCommandEvent& event);
+  /**
+   * Handles when the open Main file button is hovered.
+   */
   void OnMainMouseEnter(wxMouseEvent& event);
+  /**
+   * Handles when the open Main file button finishes hover.
+   */
   void OnMainMouseExit(wxMouseEvent& event);
 
 };