Feature #1711

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

diff --git a/lib/creaDevManagerLib/wxCDMProjectActionsPanel.h b/lib/creaDevManagerLib/wxCDMProjectActionsPanel.h
index dc98709501961ba7ee3756231e0c19835c967141..93850e277860202f560ffab39f7b6a095c701087 100755 (executable)
--- a/lib/creaDevManagerLib/wxCDMProjectActionsPanel.h
+++ b/lib/creaDevManagerLib/wxCDMProjectActionsPanel.h
@@ -41,10 +41,23 @@
 
 #include "modelCDMProject.h"
 
+/**
+ * Panel with common actions for an open Crea project.
+ */
 class wxCDMProjectActionsPanel : public wxPanel
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * Project actions panel constructor.
+   * @param parent Parent window reference.
+   * @param project Project 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.
+   */
   wxCDMProjectActionsPanel(
       wxWindow* parent,
       modelCDMProject* project,
@@ -54,7 +67,20 @@ public:
       const wxSize& size = wxDefaultSize,
       long style = wxDEFAULT_FRAME_STYLE
   );
+  /**
+   * Destructor.
+   */
   ~wxCDMProjectActionsPanel();
+  /**
+   * Project actions panel constructor.
+   * @param parent Parent window 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 creation was successful.
+   */
   bool Create(
       wxWindow* parent,
       wxWindowID id = -1,
@@ -65,14 +91,32 @@ public:
   );
 
 protected:
+  /**
+   * Creates the Panel controls (buttons)
+   */
   void CreateControls();
 
+  /**
+   * Handles when the Check Project Structure button is pressed.
+   */
   void OnBtnCheckProjectStructure(wxCommandEvent& event);
+  /**
+   * Handles when the Configure Compilation button is pressed.
+   */
   void OnBtnConfigureBuild(wxCommandEvent& event);
+  /**
+   * Handles when the Compile Project button is pressed.
+   */
   void OnBtnBuildProject(wxCommandEvent& event);
+  /**
+   * Handles when the Plug packages button is pressed.
+   */
   void OnBtnConnectProject(wxCommandEvent& event);
 
 private:
+  /**
+   * Project class reference
+   */
   modelCDMProject* project;
 };