]> Creatis software - crea.git/commitdiff
Feature #1711
authorDaniel Gonzalez <daniel.gonzalez@creatis.insa-lyon.fr>
Mon, 21 Jan 2013 14:34:24 +0000 (15:34 +0100)
committerDaniel Gonzalez <daniel.gonzalez@creatis.insa-lyon.fr>
Mon, 21 Jan 2013 14:34:24 +0000 (15:34 +0100)
CreaDevManager application implementation

- View of model classes documented.

lib/creaDevManagerLib/wxCDMAppliDescriptionPanel.h
lib/creaDevManagerLib/wxCDMApplicationDescriptionPanel.h
lib/creaDevManagerLib/wxCDMBlackBoxDescriptionPanel.h
lib/creaDevManagerLib/wxCDMCMakeListsDescriptionPanel.h
lib/creaDevManagerLib/wxCDMFileDescriptionPanel.h
lib/creaDevManagerLib/wxCDMFolderDescriptionPanel.h
lib/creaDevManagerLib/wxCDMLibDescriptionPanel.h
lib/creaDevManagerLib/wxCDMLibraryDescriptionPanel.h
lib/creaDevManagerLib/wxCDMMainDescriptionPanel.h
lib/creaDevManagerLib/wxCDMPackageDescriptionPanel.h
lib/creaDevManagerLib/wxCDMPackageManagerPanel.h

index 2a1a9fe8ca46cb8a027b373860ff911b46520a39..88c2cf94b3333c1afa091b57dcc95b7f5dfc911e 100644 (file)
 
 #include "modelCDMAppli.h"
 
+/**
+ * Application manager description panel. Shows the available applications in the project and the actions corresponding to application management.
+ */
 class wxCDMAppliDescriptionPanel : public wxPanel
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * Application manager description panel Constructor.
+   * @param parent Parent window reference.
+   * @param appli Application manager 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.
+   */
   wxCDMAppliDescriptionPanel(
       wxWindow* parent,
       modelCDMAppli* appli,
@@ -57,6 +70,17 @@ public:
 
   ~wxCDMAppliDescriptionPanel();
 
+  /**
+   * Application manager description panel Creator.
+   * @param parent Parent window reference.
+   * @param appli Application manager 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,
       modelCDMAppli* appli,
@@ -67,22 +91,59 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Creates all the controls in the panel (property and action controls).
+   */
   void CreateControls();
 
 private:
+  /**
+   * Application manager described.
+   */
   modelCDMAppli* appli;
 
   //handlers
 protected:
+  /**
+   * Handles when the create application button is pressed.
+   */
   void OnBtnCreateApplication(wxCommandEvent& event);
+  /**
+   * Handles when the open package cmakelists file button is pressed.
+   */
   void OnBtnEditCMakeLists(wxCommandEvent& event);
+  /**
+   * Handles when an application link is pressed.
+   * @param event Has the link reference to know which application was selected.
+   */
   void OnLnkApplicationSelect(wxHyperlinkEvent& event);
+  /**
+   * 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 folder button is pressed.
+   */
   void OnBtnOpenFolder(wxCommandEvent& event);
 
+  /**
+   * Handles when a application link is hovered.
+   * @param event Has the link reference to know which application was selected.
+   */
   void OnMouseEnter(wxMouseEvent& event);
+  /**
+   * Handles when a application link button finishes hover.
+   * @param event Has the link reference to know which application was selected.
+   */
   void OnMouseExit(wxMouseEvent& 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);
 
 };
index 823272b7b28b2903c04b95c935b4fb99b5eacb8a..741eb44e9c4d4aaffd7966291b580dc820a0aab6 100644 (file)
 
 #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);
 
 };
index 4eeef1ab0853e39b20de5aa07bf1deeb08a72b5f..94d3071a422d9f7271d69e4a151618c57be6b1c5 100644 (file)
 
 #include "modelCDMBlackBox.h"
 
+/**
+ * Black box description panel. Shows the properties and available actions for the described black box.
+ */
 class wxCDMBlackBoxDescriptionPanel : public wxPanel
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * Black box description panel Constructor.
+   * @param parent Parent window reference.
+   * @param blackBox Black box 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.
+   */
   wxCDMBlackBoxDescriptionPanel(
       wxWindow* parent,
       modelCDMBlackBox* blackBox,
@@ -55,8 +68,22 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Destructor.
+   */
   ~wxCDMBlackBoxDescriptionPanel();
 
+  /**
+   * Black box description panel Creator.
+   * @param parent Parent window reference.
+   * @param blackBox Black box 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 creatios was successful.
+   */
   bool Create(
       wxWindow* parent,
       modelCDMBlackBox* blackBox,
@@ -67,27 +94,76 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Creates all the controls in the panel (property and action controls).
+   */
   void CreateControls();
 
 private:
+  /**
+   * Black box described.
+   */
   modelCDMBlackBox* blackBox;
+  /**
+   * Black box author control.
+   */
   wxStaticText* authortc;
+  /**
+   * Black box description control
+   */
   wxStaticText* descriptiontc;
+  /**
+   * Black box categories control.
+   */
   wxStaticText* categoriestc;
 
   //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 author button is pressed.
+   */
   void OnBtnSetAuthor(wxCommandEvent& event);
+  /**
+   * Handles when the set description button is pressed.
+   */
   void OnBtnSetDescription(wxCommandEvent& event);
+  /**
+   * Handles when the set categories button is pressed.
+   */
   void OnBtnSetCategories(wxCommandEvent& event);
+  /**
+   * Handles when the open Cxx button is pressed.
+   */
   void OnBtnOpenCxx(wxCommandEvent& event);
+  /**
+   * Handles when the open Hxx button is pressed.
+   */
   void OnBtnOpenHxx(wxCommandEvent& event);
+  /**
+   * Handles when the open Folder button is pressed.
+   */
   void OnBtnOpenFolder(wxCommandEvent& event);
 
+  /**
+   * Handles when the open Cxx button is hovered.
+   */
   void OnCxxMouseEnter(wxMouseEvent& event);
+  /**
+   * Handles when the open Cxx button finishes hover.
+   */
   void OnCxxMouseExit(wxMouseEvent& event);
+  /**
+   * Handles when the open Hxx button is hovered.
+   */
   void OnHxxMouseEnter(wxMouseEvent& event);
+  /**
+   * Handles when the open Hxx button finishes hover.
+   */
   void OnHxxMouseExit(wxMouseEvent& event);
 
 
index 67ac0ccd623bd3aaa213701fb0d8e8171ca366e1..ac6f73ffd7c8217423610de3f221b895a934e0a4 100644 (file)
 
 #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);
 };
 
index 01ad44436009bee277d8c5cb91ae8d610d857723..09cc1048f211391a72d0c9ac58c6549ffbed689c 100644 (file)
 
 #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);
 
 };
index b4f60832548292b64a95217ccd261fcf6fe523a3..fafe66ed5cfd2985b3d25900cfa8a1369d7511b9 100644 (file)
 
 #include "modelCDMFolder.h"
 
+/**
+ * Folder description panel. Shows the properties of the referenced folder and the available actions.
+ */
 class wxCDMFolderDescriptionPanel : public wxPanel
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * Folder description panel Constructor.
+   * @param parent Parent window reference.
+   * @param folder Folder 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.
+   */
   wxCDMFolderDescriptionPanel(
       wxWindow* parent,
       modelCDMFolder* folder,
@@ -55,8 +68,22 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Destructor.
+   */
   ~wxCDMFolderDescriptionPanel();
 
+  /**
+   * Folder description panel Creator.
+   * @param parent Parent window reference.
+   * @param folder Folder 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 is successful.
+   */
   bool Create(
       wxWindow* parent,
       modelCDMFolder* folder,
@@ -67,20 +94,48 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Creates all the controls in the panel (property and action controls).
+   */
   void CreateControls();
 
 private:
+  /**
+   * Folder described.
+   */
   modelCDMFolder* folder;
 
   //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 package cmakelists file button is pressed.
+   */
   void OnBtnEditCMakeLists(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 in explorer button is pressed.
+   */
   void OnBtnOpenInExplorer(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);
 
 };
index dca3cea77ff703c43ed5e4bab730583200ede1c9..2483c9aaec3d299bc97ee23c7c6111fa683f4ad3 100644 (file)
 
 #include "modelCDMLib.h"
 
+/**
+ * Library manager description panel. Shows the available libraries in the project and the actions corresponding to library management.
+ */
 class wxCDMLibDescriptionPanel : public wxPanel
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * Library manager description panel Constructor.
+   * @param parent Parent window reference.
+   * @param lib Lib 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.
+   */
   wxCDMLibDescriptionPanel(
       wxWindow* parent,
       modelCDMLib* lib,
@@ -55,8 +68,22 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Destructor.
+   */
   ~wxCDMLibDescriptionPanel();
 
+  /**
+   * Library manager description panel Creator.
+   * @param parent Parent window reference.
+   * @param lib Lib 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,
       modelCDMLib* lib,
@@ -67,22 +94,59 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Creates all the controls in the panel (property and action controls).
+   */
   void CreateControls();
 
 private:
+  /**
+   * Library manager described.
+   */
   modelCDMLib* lib;
 
   //handlers
 protected:
+  /**
+   * Handles when the create library button is pressed.
+   */
   void OnBtnCreateLibrary(wxCommandEvent& event);
+  /**
+   * Handles when the open package cmakelists file button is pressed.
+   */
   void OnBtnEditCMakeLists(wxCommandEvent& event);
+  /**
+   * Handles when a library link is pressed.
+   * @param event Has the link reference to know which library was selected.
+   */
   void OnLnkLibrarySelect(wxHyperlinkEvent& event);
+  /**
+   * 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 a library link is hovered.
+   * @param event Has the link reference to know which library was selected.
+   */
   void OnMouseEnter(wxMouseEvent& event);
+  /**
+   * Handles when a library link button finishes hover.
+   * @param event Has the link reference to know which library was selected.
+   */
   void OnMouseExit(wxMouseEvent& 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);
 
 };
index 66e3063c002e7d2e10a514ed7375202ff3056b05..724e4850135a83a9f4ee494cc7547b1d53592857 100644 (file)
 
 #include "modelCDMLibrary.h"
 
+/**
+ * Library description panel. Shows the available actions on the described library.
+ */
 class wxCDMLibraryDescriptionPanel : public wxPanel
 {
   DECLARE_EVENT_TABLE()
 public:
+
+  /**
+   * Library description panel Constructor.
+   * @param parent Parent window reference.
+   * @param library 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.
+   */
   wxCDMLibraryDescriptionPanel(
       wxWindow* parent,
       modelCDMLibrary* library,
@@ -55,8 +69,22 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Destructor.
+   */
   ~wxCDMLibraryDescriptionPanel();
 
+  /**
+   * Library description panel Creator.
+   * @param parent Parent window reference.
+   * @param library 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.
+   * @return True if creation was successful.
+   */
   bool Create(
       wxWindow* parent,
       modelCDMLibrary* library,
@@ -67,21 +95,62 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Creates all the controls in the panel (property and action controls).
+   */
   void CreateControls();
 
 private:
+  /**
+   * Library described.
+   */
   modelCDMLibrary* library;
+  /**
+   * Control with the described library name.
+   */
   wxStaticText* libraryNametc;
 
   //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.
+   * @param event Unused.
+   */
   void OnBtnSetExeName(wxCommandEvent& event);
+  /**
+   * Handles when the create class button is pressed.
+   * @param event Unused.
+   */
   void OnBtnCreateClass(wxCommandEvent& event);
+  /**
+   * Handles when the create folder buttonis pressed.
+   * @param event Unused.
+   */
   void OnBtnCreateFolder(wxCommandEvent& event);
+  /**
+   * Handles when Edit Cmakelists button is pressed.
+   * @param event Unused.
+   */
   void OnBtnEditCMakeLists(wxCommandEvent& event);
+  /**
+   * Handles when the open containing folder button is pressed.
+   * @param event Unused.
+   */
   void OnBtnOpenFolder(wxCommandEvent& event);
+  /**
+   * Handles when the edit cmakelists button is hovered.
+   * @param event Unused.
+   */
   void OnCMakeMouseEnter(wxMouseEvent& event);
+  /**
+   * Handles when the edit cmakelists button exits hover.
+   * @param event Unused.
+   */
   void OnCMakeMouseExit(wxMouseEvent& event);
 
 };
index 0e384fd0b627f6e62f483dff22763902ee91f1fe..fb0defaa7b1fac0d60af5fc83bfa4187e02a8616 100644 (file)
 
 #include <creaWx.h>
 #include <wx/panel.h>
-
+/**
+ * Main View description panel. Shows the welcome message and allows to open or create Crea projects.
+ */
 class wxCDMMainDescriptionPanel : public wxPanel
 {
   DECLARE_EVENT_TABLE()
 
 public:
+  /**
+   * Main description 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.
+   */
     wxCDMMainDescriptionPanel(
         wxWindow* parent,
         wxWindowID id = -1,
@@ -53,8 +64,20 @@ public:
         long style = wxDEFAULT_FRAME_STYLE
     );
 
+    /**
+     * Destructor.
+     */
     ~wxCDMMainDescriptionPanel();
 
+    /**
+     * Main description 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.
+     */
     bool Create(
         wxWindow* parent,
         wxWindowID id = -1,
@@ -64,11 +87,20 @@ public:
         long style = wxDEFAULT_FRAME_STYLE
     );
 
+    /**
+     * Creates all the controls in the panel (property and action controls).
+     */
     void CreateControls();
 
 //handlers
 protected:
+    /**
+     * Handles when the create new project button is pressed.
+     */
     void OnBtnNewProject(wxCommandEvent& event);
+    /**
+     * Handles when the open project button is pressed.
+     */
     void OnBtnOpenProject(wxCommandEvent& event);
 };
 
index 1601f041460fa903349b2495a57ee4a0e1418d31..8e88f9a5b79a5690771639edaa5fd635f268e846 100644 (file)
 
 #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);
 
 };
index dcf2fd32e3d7efa0b686f9c94d8b3b232c4c89df..66a1d1c54228d390ed5420b5ec2a9fec1fd4f8fd 100644 (file)
@@ -108,7 +108,7 @@ public:
 
 private:
   /**
-   * Project described
+   * Project described.
    */
   modelCDMProject* project;
 
@@ -116,10 +116,12 @@ private:
 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 a packages link is pressed.
+   * @param event Has the link reference to know which package was selected.
    */
   void OnLnkPackageSelect(wxHyperlinkEvent& event);
   /**
@@ -133,10 +135,12 @@ protected:
 
   /**
    * Handles when a package link is hovered.
+   * @param event Has the link reference to know which package was selected.
    */
   void OnMouseEnter(wxMouseEvent& event);
   /**
    * Handles when a package link button finishes hover.
+   * @param event Has the link reference to know which package was selected.
    */
   void OnMouseExit(wxMouseEvent& event);
   /**