Feature #1711

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

diff --git a/lib/creaDevManagerLib/wxCDMFileDescriptionPanel.h b/lib/creaDevManagerLib/wxCDMFileDescriptionPanel.h
index 01ad44436009bee277d8c5cb91ae8d610d857723..09cc1048f211391a72d0c9ac58c6549ffbed689c 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMFileDescriptionPanel.h
+++ b/lib/creaDevManagerLib/wxCDMFileDescriptionPanel.h
@@ -41,10 +41,23 @@
 
 #include "modelCDMFile.h"
 
+/**
+ * File description panel. Shows the File properties and the available options for it.
+ */
 class wxCDMFileDescriptionPanel : public wxPanel
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * File description panel Constructor.
+   * @param parent Parent window reference.
+   * @param file File 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.
+   */
   wxCDMFileDescriptionPanel(
       wxWindow* parent,
       modelCDMFile* file,
@@ -55,8 +68,22 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Destructor.
+   */
   ~wxCDMFileDescriptionPanel();
 
+  /**
+   * File description panel Constructor.
+   * @param parent Parent window reference.
+   * @param file File 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,
       modelCDMFile* file,
@@ -67,16 +94,32 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Creates all the controls in the panel (property and action controls).
+   */
   void CreateControls();
 
 
 private:
+  /**
+   * File described.
+   */
   modelCDMFile* file;
 
   //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 containing folder button is pressed.
+   */
   void OnBtnOpenFolder(wxCommandEvent& event);
+  /**
+   * Handles when the Open with command button is pressed.
+   */
   void OnBtnOpenWithCommand(wxCommandEvent& event);
 
 };