Feature #1711

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

diff --git a/lib/creaDevManagerLib/wxCDMCMakeListsDescriptionPanel.h b/lib/creaDevManagerLib/wxCDMCMakeListsDescriptionPanel.h
index 67ac0ccd623bd3aaa213701fb0d8e8171ca366e1..ac6f73ffd7c8217423610de3f221b895a934e0a4 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMCMakeListsDescriptionPanel.h
+++ b/lib/creaDevManagerLib/wxCDMCMakeListsDescriptionPanel.h
@@ -41,10 +41,23 @@
 
 #include "modelCDMCMakeListsFile.h"
 
+/**
+ * CMakeLists File description panel. Shows the file properties and the available actions for it.
+ */
 class wxCDMCMakeListsDescriptionPanel : public wxPanel
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * CMakeLists File description panel Constructor.
+   * @param parent Parent window reference.
+   * @param makefile CMakeLists 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.
+   */
   wxCDMCMakeListsDescriptionPanel(
       wxWindow* parent,
       modelCDMCMakeListsFile* makefile,
@@ -55,11 +68,25 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Destructor.
+   */
   ~wxCDMCMakeListsDescriptionPanel();
 
+  /**
+   * CMakeLists File description panel Constructor.
+   * @param parent Parent window reference.
+   * @param makefile CMakeLists 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 creation was successful.
+   */
   bool Create(
       wxWindow* parent,
-      modelCDMCMakeListsFile* blackBox,
+      modelCDMCMakeListsFile* makefile,
       wxWindowID id = -1,
       const wxString& caption = _("Description Frame"),
       const wxPoint& pos = wxDefaultPosition,
@@ -67,15 +94,31 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Creates all the controls in the panel (property and action controls).
+   */
   void CreateControls();
 
 private:
+  /**
+   * CMakeLists file described.
+   */
   modelCDMCMakeListsFile* cMakeLists;
 
   //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 open file in text editor button is pressed.
+   */
   void OnBtnOpenInEditor(wxCommandEvent& event);
+  /**
+   * Handles when the open containing folder button is pressed.
+   */
   void OnBtnOpenFolder(wxCommandEvent& event);
 };