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

- View Creation and additional classes documented.

17 files changed:
lib/creaDevManagerLib/wxCDMAppliHelpDialog.h
lib/creaDevManagerLib/wxCDMApplicationHelpDialog.h
lib/creaDevManagerLib/wxCDMBlackBoxHelpDialog.h
lib/creaDevManagerLib/wxCDMLibHelpDialog.h
lib/creaDevManagerLib/wxCDMLibraryHelpDialog.h
lib/creaDevManagerLib/wxCDMMainHelpDialog.h
lib/creaDevManagerLib/wxCDMNewBlackBoxDialog.h
lib/creaDevManagerLib/wxCDMNewPackageDialog.h
lib/creaDevManagerLib/wxCDMNewProjectDialog.h
lib/creaDevManagerLib/wxCDMPackageHelpDialog.h
lib/creaDevManagerLib/wxCDMPackageManagerHelpDialog.h
lib/creaDevManagerLib/wxCDMPackageManagerPanel.h
lib/creaDevManagerLib/wxCDMProjectActionsPanel.h
lib/creaDevManagerLib/wxCDMProjectDescriptionPanel.h
lib/creaDevManagerLib/wxCDMProjectHelpDialog.h
lib/creaDevManagerLib/wxCDMProjectStructureReportDialog.h
lib/creaDevManagerLib/wxCDMProjectsTreeCtrl.h

index 21cf046d612f81f715a7c233683898ac17ee581b..40d8d11ef69d98d1d21aa145bdaee0217b238ceb 100644 (file)
@@ -79,6 +79,7 @@ public:
      * @param position Dialog position. By default wxDefaultPosition.
      * @param size Dialog size. By default 350, 600.
      * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
      * @param position Dialog position. By default wxDefaultPosition.
      * @param size Dialog size. By default 350, 600.
      * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+     * @return if the creation was successful.
      */
   bool Create(
       wxWindow* parent,
      */
   bool Create(
       wxWindow* parent,
@@ -106,25 +107,30 @@ private:
 protected:
   /**
    * Handler to close help dialog.
 protected:
   /**
    * Handler to close help dialog.
+   * @param event Unused.
    */
   void OnFinish(wxCommandEvent& event);
 
   /**
    * Handler when a cmakelists button is pressed.
    */
   void OnFinish(wxCommandEvent& event);
 
   /**
    * Handler when a cmakelists button is pressed.
+   * @param event cmakelists event.
    */
   void OnEditCMake(wxCommandEvent& event);
 
   /**
    * Handler when a cmakelists button is hovered.
    */
   void OnEditCMake(wxCommandEvent& event);
 
   /**
    * Handler when a cmakelists button is hovered.
+   * @param event cmakelists event.
    */
   void OnCMakeListsEnter(wxMouseEvent& event);
   /**
    * Handler when a cmakelists button hover finishes.
    */
   void OnCMakeListsEnter(wxMouseEvent& event);
   /**
    * Handler when a cmakelists button hover finishes.
+   * @param event cmakelists event.
    */
   void OnCMakeListsExit(wxMouseEvent& event);
 
   /**
    * Handler when the disable help checkbox is changed.
    */
   void OnCMakeListsExit(wxMouseEvent& event);
 
   /**
    * Handler when the disable help checkbox is changed.
+   * @param event check box event.
    */
   void OnDisableHelp(wxCommandEvent& event);
 };
    */
   void OnDisableHelp(wxCommandEvent& event);
 };
index 0d891d0a65147c11c8645f539ef4cd7db21cedb8..f9b41315243eee0586ce1a02e119843bd3cf8a14 100644 (file)
@@ -81,6 +81,7 @@ public:
    * @param position Dialog position. By default wxDefaultPosition.
    * @param size Dialog size. By default 410, 670.
    * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
    * @param position Dialog position. By default wxDefaultPosition.
    * @param size Dialog size. By default 410, 670.
    * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   * @return if the creation was successful.
    */
   bool Create(
       wxWindow* parent,
    */
   bool Create(
       wxWindow* parent,
@@ -107,25 +108,30 @@ private:
 protected:
   /**
    * Handler to close help dialog.
 protected:
   /**
    * Handler to close help dialog.
+   * @param event Unused.
    */
   void OnFinish(wxCommandEvent& event);
 
   /**
    * Handler when a cmakelists button is pressed.
    */
   void OnFinish(wxCommandEvent& event);
 
   /**
    * Handler when a cmakelists button is pressed.
+   * @param event cmakelists event.
    */
   void OnCMakeLists(wxCommandEvent& event);
 
   /**
    * Handler when a cmakelists button is hovered.
    */
   void OnCMakeLists(wxCommandEvent& event);
 
   /**
    * Handler when a cmakelists button is hovered.
+   * @param event cmakelists event.
    */
   void OnCMakeListsEnter(wxMouseEvent& event);
   /**
    * Handler when a cmakelists button hover finishes.
    */
   void OnCMakeListsEnter(wxMouseEvent& event);
   /**
    * Handler when a cmakelists button hover finishes.
+   * @param event cmakelists event.
    */
   void OnCMakeListsExit(wxMouseEvent& event);
 
   /**
    * Handler when the disable help checkbox is changed.
    */
   void OnCMakeListsExit(wxMouseEvent& event);
 
   /**
    * Handler when the disable help checkbox is changed.
+   * @param event check box event.
    */
   void OnDisableHelp(wxCommandEvent& event);
 };
    */
   void OnDisableHelp(wxCommandEvent& event);
 };
index 25438c6366fce110375f1a8c62de5b0afca9b08d..66995d515682f29d511110226ae8238825963984 100644 (file)
@@ -81,6 +81,7 @@ public:
    * @param position Dialog position. By default wxDefaultPosition.
    * @param size Dialog size. By default 410, 700.
    * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
    * @param position Dialog position. By default wxDefaultPosition.
    * @param size Dialog size. By default 410, 700.
    * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   * @return if the creation was successful.
    */
   bool Create(
       wxWindow* parent,
    */
   bool Create(
       wxWindow* parent,
@@ -107,25 +108,30 @@ private:
 protected:
   /**
    * Handler to close help dialog.
 protected:
   /**
    * Handler to close help dialog.
+   * @param event Unused.
    */
   void OnFinish(wxCommandEvent& event);
 
   /**
    * Handler when a cmakelists button is pressed.
    */
   void OnFinish(wxCommandEvent& event);
 
   /**
    * Handler when a cmakelists button is pressed.
+   * @param event cmakelists event.
    */
   void OnCMakeLists(wxCommandEvent& event);
 
   /**
    * Handler when a cmakelists button is hovered.
    */
   void OnCMakeLists(wxCommandEvent& event);
 
   /**
    * Handler when a cmakelists button is hovered.
+   * @param event cmakelists event.
    */
   void OnCMakeListsEnter(wxMouseEvent& event);
   /**
    * Handler when a cmakelists button hover finishes.
    */
   void OnCMakeListsEnter(wxMouseEvent& event);
   /**
    * Handler when a cmakelists button hover finishes.
+   * @param event cmakelists event.
    */
   void OnCMakeListsExit(wxMouseEvent& event);
 
   /**
    * Handler when the disable help checkbox is changed.
    */
   void OnCMakeListsExit(wxMouseEvent& event);
 
   /**
    * Handler when the disable help checkbox is changed.
+   * @param event check box event.
    */
   void OnDisableHelp(wxCommandEvent& event);
 };
    */
   void OnDisableHelp(wxCommandEvent& event);
 };
index 5620dc93f19bc6e60c61e01a90e4b5fd5dfd42a2..9d7049a24be60cb5e10ecce60966a7060a7d1317 100644 (file)
@@ -79,6 +79,7 @@ public:
    * @param position Dialog position. By default wxDefaultPosition.
    * @param size Dialog size. By default 350, 600.
    * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
    * @param position Dialog position. By default wxDefaultPosition.
    * @param size Dialog size. By default 350, 600.
    * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   * @return if the creation was successful.
    */
   bool Create(
       wxWindow* parent,
    */
   bool Create(
       wxWindow* parent,
@@ -106,25 +107,30 @@ private:
 protected:
   /**
    * Handler to close help dialog.
 protected:
   /**
    * Handler to close help dialog.
+   * @param event Unused.
    */
   void OnFinish(wxCommandEvent& event);
 
   /**
    * Handler when a cmakelists button is pressed.
    */
   void OnFinish(wxCommandEvent& event);
 
   /**
    * Handler when a cmakelists button is pressed.
+   * @param event cmakelists event.
    */
   void OnEditCMake(wxCommandEvent& event);
 
   /**
    * Handler when a cmakelists button is hovered.
    */
   void OnEditCMake(wxCommandEvent& event);
 
   /**
    * Handler when a cmakelists button is hovered.
+   * @param event cmakelists event.
    */
   void OnEditCMakeMouseEnter(wxMouseEvent& event);
   /**
    * Handler when a cmakelists button hover finishes.
    */
   void OnEditCMakeMouseEnter(wxMouseEvent& event);
   /**
    * Handler when a cmakelists button hover finishes.
+   * @param event cmakelists event.
    */
   void OnEditCMakeMouseExit(wxMouseEvent& event);
 
   /**
    * Handler when the disable help checkbox is changed.
    */
   void OnEditCMakeMouseExit(wxMouseEvent& event);
 
   /**
    * Handler when the disable help checkbox is changed.
+   * @param event check box event.
    */
   void OnDisableHelp(wxCommandEvent& event);
 };
    */
   void OnDisableHelp(wxCommandEvent& event);
 };
index 1d327fa6d48b6efabfadfd36622718415b4ea288..f475b5029e852f4a23571b7a6edf0d491557d596 100644 (file)
@@ -81,6 +81,7 @@ public:
    * @param position Dialog position. By default wxDefaultPosition.
    * @param size Dialog size. By default 410, 650.
    * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
    * @param position Dialog position. By default wxDefaultPosition.
    * @param size Dialog size. By default 410, 650.
    * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   * @return if the creation was successful.
    */
   bool Create(
       wxWindow* parent,
    */
   bool Create(
       wxWindow* parent,
@@ -107,26 +108,31 @@ private:
 protected:
   /**
    * Handler to close help dialog.
 protected:
   /**
    * Handler to close help dialog.
+   * @param event Unused.
    */
   void OnFinish(wxCommandEvent& event);
 
   /**
    * Handler when a cmakelists button is pressed.
    */
   void OnFinish(wxCommandEvent& event);
 
   /**
    * Handler when a cmakelists button is pressed.
+   * @param event cmakelists event.
    */
   void OnCMakeLists(wxCommandEvent& event);
 
   /**
    * Handler when a cmakelists button is hovered.
    */
   void OnCMakeLists(wxCommandEvent& event);
 
   /**
    * Handler when a cmakelists button is hovered.
+   * @param event cmakelists event.
    */
   void OnCMakeListsEnter(wxMouseEvent& event);
 
   /**
    * Handler when a cmakelists button hover finishes.
    */
   void OnCMakeListsEnter(wxMouseEvent& event);
 
   /**
    * Handler when a cmakelists button hover finishes.
+   * @param event cmakelists event.
    */
   void OnCMakeListsExit(wxMouseEvent& event);
 
   /**
    * Handler when the disable help checkbox is changed.
    */
   void OnCMakeListsExit(wxMouseEvent& event);
 
   /**
    * Handler when the disable help checkbox is changed.
+   * @param event check box event.
    */
   void OnDisableHelp(wxCommandEvent& event);
 };
    */
   void OnDisableHelp(wxCommandEvent& event);
 };
index 1fc0e2b49553a8b204eabe87a9569b9cb4ca7be0..a011c245fa4c3ec23a53140ff08ec6bb299682de 100644 (file)
@@ -79,6 +79,7 @@ public:
    * @param position Dialog position. By default wxDefaultPosition.
    * @param size Dialog size. By default 350, 370.
    * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
    * @param position Dialog position. By default wxDefaultPosition.
    * @param size Dialog size. By default 350, 370.
    * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   * @return if the creation was successful.
    */
   bool Create(
       wxWindow* parent,
    */
   bool Create(
       wxWindow* parent,
@@ -106,20 +107,24 @@ private:
 protected:
   /**
    * Handler to close help dialog.
 protected:
   /**
    * Handler to close help dialog.
+   * @param event Unused.
    */
   void OnFinish(wxCommandEvent& event);
 
   /**
    * Handler when new project button is pressed.
    */
   void OnFinish(wxCommandEvent& event);
 
   /**
    * Handler when new project button is pressed.
+   * @param event Unused.
    */
   void OnNewProject(wxCommandEvent& event);
   /**
    * Handler when open project button is pressed.
    */
   void OnNewProject(wxCommandEvent& event);
   /**
    * Handler when open project button is pressed.
+   * @param event Unused.
    */
   void OnOpenProject(wxCommandEvent& event);
 
   /**
    * Handler when the disable help checkbox is changed.
    */
   void OnOpenProject(wxCommandEvent& event);
 
   /**
    * Handler when the disable help checkbox is changed.
+   * @param event check box event.
    */
   void OnDisableHelp(wxCommandEvent& event);
 };
    */
   void OnDisableHelp(wxCommandEvent& event);
 };
index 9d5a7fc222ecb64b486ae3b7c5a0dd2dffd654b7..1c48f9453bb6757580e7a2373040f34f74f5f566 100644 (file)
@@ -23,7 +23,7 @@
 #  The fact that you are presently reading this means that you have had
 #  knowledge of the CeCILL-B license and that you accept its terms.
 # ------------------------------------------------------------------------ 
 #  The fact that you are presently reading this means that you have had
 #  knowledge of the CeCILL-B license and that you accept its terms.
 # ------------------------------------------------------------------------ 
-*/ 
+ */
 
 
 /*
 
 
 /*
 #include <wx/dialog.h>
 #include <wx/choice.h>
 
 #include <wx/dialog.h>
 #include <wx/choice.h>
 
+/**
+ * Dialog to create a new Black Box in a Crea Project.
+ */
 class wxCDMNewBlackBoxDialog : public wxDialog
 {
   DECLARE_EVENT_TABLE()
 public:
 class wxCDMNewBlackBoxDialog : public wxDialog
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * New Black Box Dialog Constructor.
+   * @param parent Parent window reference.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "New Black Box".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 500, 500.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   */
   wxCDMNewBlackBoxDialog(
       wxWindow* parent,
       wxWindowID id = wxID_ANY,
   wxCDMNewBlackBoxDialog(
       wxWindow* parent,
       wxWindowID id = wxID_ANY,
@@ -52,7 +64,20 @@ public:
       const wxSize& size = wxSize(500,500),
       long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
   );
       const wxSize& size = wxSize(500,500),
       long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
   );
+  /**
+   * Destructor.
+   */
   ~wxCDMNewBlackBoxDialog();
   ~wxCDMNewBlackBoxDialog();
+  /**
+   * New Black Box Dialog Constructor.
+   * @param parent Parent window reference.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "New Black Box".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 500, 500.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   * @return True if the creation was successful.
+   */
   bool Create(
       wxWindow* parent,
       wxWindowID id = wxID_ANY,
   bool Create(
       wxWindow* parent,
       wxWindowID id = wxID_ANY,
@@ -62,29 +87,89 @@ public:
       long style = wxDEFAULT_DIALOG_STYLE
   );
 
       long style = wxDEFAULT_DIALOG_STYLE
   );
 
+  /**
+   * Returns the black box name chosen by the user.
+   * @return Black box name.
+   */
   const wxString GetBlackBoxName() const;
   const wxString GetBlackBoxName() const;
+  /**
+   * Returns the black box's author name chosen by the user.
+   * @return Black box's author name.
+   */
   const wxString GetBlackBoxAuthor() const;
   const wxString GetBlackBoxAuthor() const;
+  /**
+   * Returns the black box's author email chosen by the user.
+   * @return Black box's author email.
+   */
   const wxString GetBlackBoxAuthorEmail() const;
   const wxString GetBlackBoxAuthorEmail() const;
+  /**
+   * Returns the black box description chosen by the user.
+   * @return Black box description.
+   */
   const wxString GetBlackBoxDescription() const ;
   const wxString GetBlackBoxDescription() const ;
+  /**
+   * Returns the black box categories chosen by the user.
+   * @return Black box categories.
+   */
   const wxString GetBlackBoxCategories() const ;
   const wxString GetBlackBoxCategories() const ;
+  /**
+   * Returns the black box type chosen by the user.
+   * @return Black box type.
+   */
   const wxString GetBlackBoxType() const;
   const wxString GetBlackBoxType() const;
+  /**
+   * Returns the black box format chosen by the user.
+   * @return Black box format.
+   */
   const wxString GetBlackBoxFormat() const;
 
 protected:
   const wxString GetBlackBoxFormat() const;
 
 protected:
+  /**
+   * Creates the visual controls of the Dialog.
+   */
   void CreateControls();
 
 private:
   void CreateControls();
 
 private:
+  /**
+   * Black box name.
+   */
   wxTextCtrl* blackBoxName;
   wxTextCtrl* blackBoxName;
+  /**
+   * Black box's author name.
+   */
   wxTextCtrl* blackBoxAuthor;
   wxTextCtrl* blackBoxAuthor;
+  /**
+   * Black box's author email.
+   */
   wxTextCtrl* blackBoxAuthorEmail;
   wxTextCtrl* blackBoxAuthorEmail;
+  /**
+   * Black box description.
+   */
   wxTextCtrl* blackBoxDescription;
   wxTextCtrl* blackBoxDescription;
+  /**
+   * Black box categories.
+   */
   wxTextCtrl* blackBoxCategories;
   wxTextCtrl* blackBoxCategories;
+  /**
+   * Black box type.
+   */
   wxChoice* blackBoxType;
   wxChoice* blackBoxType;
+  /**
+   * Black box format.
+   */
   wxChoice* blackBoxFormat;
 
   wxChoice* blackBoxFormat;
 
-//handlers
+  //handlers
 protected:
 protected:
+  /*
+   * Handles when the create black box button is pressed.
+   * @param event Unused event.
+   */
   void OnCreateBlackBox(wxCommandEvent& event);
   void OnCreateBlackBox(wxCommandEvent& event);
+  /*
+   * Handles when the cancel button is pressed.
+   * @param event Unused event.
+   */
   void OnCancel(wxCommandEvent& event);
 };
 
   void OnCancel(wxCommandEvent& event);
 };
 
index 1f0e55f84c6c3d513f4eb5ae545106d691f80df9..eda8a91856335f3a2eded68a89e43c9e8d9ff747 100644 (file)
@@ -23,7 +23,7 @@
 #  The fact that you are presently reading this means that you have had
 #  knowledge of the CeCILL-B license and that you accept its terms.
 # ------------------------------------------------------------------------ 
 #  The fact that you are presently reading this means that you have had
 #  knowledge of the CeCILL-B license and that you accept its terms.
 # ------------------------------------------------------------------------ 
-*/ 
+ */
 
 
 /*
 
 
 /*
 #include <creaWx.h>
 #include <wx/dialog.h>
 
 #include <creaWx.h>
 #include <wx/dialog.h>
 
+/**
+ * Dialog to create a new Package in a Crea Project.
+ */
 class wxCDMNewPackageDialog : public wxDialog
 {
   DECLARE_EVENT_TABLE()
 public:
 class wxCDMNewPackageDialog : public wxDialog
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * New Package Dialog Constructor.
+   * @param parent Parent window reference.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "New Package".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 500, 400.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   */
   wxCDMNewPackageDialog(
       wxWindow* parent,
       wxWindowID id = wxID_ANY,
   wxCDMNewPackageDialog(
       wxWindow* parent,
       wxWindowID id = wxID_ANY,
@@ -51,7 +63,19 @@ public:
       const wxSize& size = wxSize(500,400),
       long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
   );
       const wxSize& size = wxSize(500,400),
       long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
   );
+  /**
+   * Destructor.
+   */
   ~wxCDMNewPackageDialog();
   ~wxCDMNewPackageDialog();
+  /**
+   * New Package Dialog Creator.
+   * @param parent Parent window reference.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "New Package".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 500, 400.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   */
   bool Create(
       wxWindow* parent,
       wxWindowID id = wxID_ANY,
   bool Create(
       wxWindow* parent,
       wxWindowID id = wxID_ANY,
@@ -61,23 +85,62 @@ public:
       long style = wxDEFAULT_DIALOG_STYLE
   );
 
       long style = wxDEFAULT_DIALOG_STYLE
   );
 
+  /**
+   * Returns the package name chosen by the user.
+   * @return Package name.
+   */
   const wxString GetPackageName();
   const wxString GetPackageName();
+  /**
+   * Returns the package author name chosen by the user.
+   * @return Package author name.
+   */
   const wxString GetPackageAuthor();
   const wxString GetPackageAuthor();
+  /**
+   * Returns the package author's email chosen by the user.
+   * @return Package author's email.
+   */
   const wxString GetPackageAuthorEmail();
   const wxString GetPackageAuthorEmail();
+  /**
+   * Returns the package description chosen by the user.
+   * @return Package description.
+   */
   const wxString GetPackageDescription();
 
 protected:
   const wxString GetPackageDescription();
 
 protected:
+  /**
+   * Creates the visual controls of the Dialog.
+   */
   void CreateControls();
 
 private:
   void CreateControls();
 
 private:
+  /**
+   * Package name.
+   */
   wxTextCtrl* packageName;
   wxTextCtrl* packageName;
+  /**
+   * Package author name.
+   */
   wxTextCtrl* packageAuthor;
   wxTextCtrl* packageAuthor;
+  /**
+   * Package author's email.
+   */
   wxTextCtrl* packageAuthorEmail;
   wxTextCtrl* packageAuthorEmail;
+  /**
+   * Package description.
+   */
   wxTextCtrl* packageDescription;
 
   wxTextCtrl* packageDescription;
 
-//handlers
+  //handlers
 protected:
 protected:
+  /**
+   * Handles when the create package button is pressed.
+   * @param event Unused event.
+   */
   void OnCreatePackage(wxCommandEvent& event);
   void OnCreatePackage(wxCommandEvent& event);
+  /**
+   * Handles when the cancel button is pressed.
+   * @param event Unused event.
+   */
   void OnCancel(wxCommandEvent& event);
 };
 
   void OnCancel(wxCommandEvent& event);
 };
 
index 22dec24e9d4a303b19f78d1c4c9bb667511fc47b..be99c950ca69a88c18b14d5ccaaaad7d532f7939 100644 (file)
@@ -23,7 +23,7 @@
 #  The fact that you are presently reading this means that you have had
 #  knowledge of the CeCILL-B license and that you accept its terms.
 # ------------------------------------------------------------------------ 
 #  The fact that you are presently reading this means that you have had
 #  knowledge of the CeCILL-B license and that you accept its terms.
 # ------------------------------------------------------------------------ 
-*/ 
+ */
 
 
 /*
 
 
 /*
 #include <creaWx.h>
 #include <wx/dialog.h>
 
 #include <creaWx.h>
 #include <wx/dialog.h>
 
+/**
+ * Dialog to create a new Crea Project.
+ */
 class wxCDMNewProjectDialog : public wxDialog
 {
   DECLARE_EVENT_TABLE()
 public:
 class wxCDMNewProjectDialog : public wxDialog
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * New Project Dialog Constructor.
+   * @param parent Parent window reference.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "New Project".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 700, 400.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   */
   wxCDMNewProjectDialog(
       wxWindow* parent,
       wxWindowID id = wxID_ANY,
   wxCDMNewProjectDialog(
       wxWindow* parent,
       wxWindowID id = wxID_ANY,
@@ -51,7 +63,20 @@ public:
       const wxSize& size = wxSize(700,400),
       long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
   );
       const wxSize& size = wxSize(700,400),
       long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
   );
+  /**
+   * Destructor.
+   */
   ~wxCDMNewProjectDialog();
   ~wxCDMNewProjectDialog();
+  /**
+   * New Project Dialog Creator.
+   * @param parent Parent window reference.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "New Project".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 700, 400.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   * @return True if the creation was successful.
+   */
   bool Create(
       wxWindow* parent,
       wxWindowID id = wxID_ANY,
   bool Create(
       wxWindow* parent,
       wxWindowID id = wxID_ANY,
@@ -61,24 +86,67 @@ public:
       long style = wxDEFAULT_DIALOG_STYLE
   );
 
       long style = wxDEFAULT_DIALOG_STYLE
   );
 
+  /**
+   * Returns the project location chosen by the user.
+   * @return Project creation path.
+   */
   const wxString GetProjectLocation();
   const wxString GetProjectLocation();
+  /**
+   * Returns the project name chosen by the user.
+   * @return Project name.
+   */
   const wxString GetProjectName();
   const wxString GetProjectName();
+  /**
+   * Returns the default package authors chosen by the user.
+   * @return Default Package authors.
+   */
   const wxString GetPackageAuthor();
   const wxString GetPackageAuthor();
+  /**
+   * Returns the default package description chosen by the user.
+   * @return Default Package description.
+   */
   const wxString GetPackageDescription();
 
 protected:
   const wxString GetPackageDescription();
 
 protected:
+  /**
+   * Creates the visual controls of the Dialog.
+   */
   void CreateControls();
 
 private:
   void CreateControls();
 
 private:
+  /**
+   * Project creation path.
+   */
   wxStaticText* projectLocation;
   wxStaticText* projectLocation;
+  /**
+   * Project Name.
+   */
   wxTextCtrl* projectName;
   wxTextCtrl* projectName;
+  /**
+   * Default Package Author.
+   */
   wxTextCtrl* packageAuthor;
   wxTextCtrl* packageAuthor;
+  /**
+   * Default Package Description.
+   */
   wxTextCtrl* packageDescription;
 
   wxTextCtrl* packageDescription;
 
-//handlers
+  //handlers
 protected:
 protected:
+  /**
+   * Handles when the create project button is pressed. If no path or no author was specified, the dialog shows an error.
+   * @param event Unused event.
+   */
   void OnCreateProject(wxCommandEvent& event);
   void OnCreateProject(wxCommandEvent& event);
+  /**
+   * Handles when the cancel button is pressed.
+   * @param event Unused event.
+   */
   void OnCancel(wxCommandEvent& event);
   void OnCancel(wxCommandEvent& event);
+  /**
+   * Handles when the choose location is pressed. a Directory dialog is shown and the new project location is chosen.
+   * @param event Unused event.
+   */
   void OnChooseLocation(wxCommandEvent& event);
 };
 
   void OnChooseLocation(wxCommandEvent& event);
 };
 
index 9dd08c6e1fd31d85a392e63e63389aebdcec1ff0..870f7a7ceadcb9f8e65a328daf6925c758c16690 100644 (file)
@@ -81,6 +81,7 @@ public:
    * @param position Dialog position. By default wxDefaultPosition.
    * @param size Dialog size. By default 350, 570.
    * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
    * @param position Dialog position. By default wxDefaultPosition.
    * @param size Dialog size. By default 350, 570.
    * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   * @return if the creation was successful.
    */
   bool Create(
       wxWindow* parent,
    */
   bool Create(
       wxWindow* parent,
@@ -107,25 +108,30 @@ private:
 protected:
   /**
    * Handler to close help dialog.
 protected:
   /**
    * Handler to close help dialog.
+   * @param event Unused.
    */
   void OnFinish(wxCommandEvent& event);
 
   /**
    * Handler when a cmakelists button is pressed.
    */
   void OnFinish(wxCommandEvent& event);
 
   /**
    * Handler when a cmakelists button is pressed.
+   * @param event cmakelists event.
    */
   void OnCMakeLists(wxCommandEvent& event);
 
   /**
    * Handler when a cmakelists button is hovered.
    */
   void OnCMakeLists(wxCommandEvent& event);
 
   /**
    * Handler when a cmakelists button is hovered.
+   * @param event cmakelists event.
    */
   void OnCMakeListsEnter(wxMouseEvent& event);
   /**
    * Handler when a cmakelists button hover finishes.
    */
   void OnCMakeListsEnter(wxMouseEvent& event);
   /**
    * Handler when a cmakelists button hover finishes.
+   * @param event cmakelists event.
    */
   void OnCMakeListsExit(wxMouseEvent& event);
 
   /**
    * Handler when the disable help checkbox is changed.
    */
   void OnCMakeListsExit(wxMouseEvent& event);
 
   /**
    * Handler when the disable help checkbox is changed.
+   * @param event check box event.
    */
   void OnDisableHelp(wxCommandEvent& event);
 };
    */
   void OnDisableHelp(wxCommandEvent& event);
 };
index 1f03aa07307d78c13992e74a3d4e94c24714d7d0..50c8ed19e0c2f18ba5fc309a47bebbff8694805b 100644 (file)
@@ -79,6 +79,7 @@ public:
    * @param position Dialog position. By default wxDefaultPosition.
    * @param size Dialog size. By default 350, 450.
    * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
    * @param position Dialog position. By default wxDefaultPosition.
    * @param size Dialog size. By default 350, 450.
    * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   * @return if the creation was successful.
    */
   bool Create(
       wxWindow* parent,
    */
   bool Create(
       wxWindow* parent,
@@ -106,29 +107,35 @@ private:
 protected:
   /**
    * Handler to close help dialog.
 protected:
   /**
    * Handler to close help dialog.
+   * @param event Unused.
    */
   void OnFinish(wxCommandEvent& event);
 
   /**
    * Handler when the create package button is pressed.
    */
   void OnFinish(wxCommandEvent& event);
 
   /**
    * Handler when the create package button is pressed.
+   * @param event Unused.
    */
   void OnCreatePackage(wxCommandEvent& event);
   /**
    * Handler when a cmakelists button is pressed.
    */
   void OnCreatePackage(wxCommandEvent& event);
   /**
    * Handler when a cmakelists button is pressed.
+   * @param event cmakelists event.
    */
   void OnEditCMake(wxCommandEvent& event);
 
   /**
    * Handler when a cmakelists button is hovered.
    */
   void OnEditCMake(wxCommandEvent& event);
 
   /**
    * Handler when a cmakelists button is hovered.
+   * @param event cmakelists event.
    */
   void OnEditCMakeMouseEnter(wxMouseEvent& event);
   /**
    * Handler when a cmakelists button hover finishes.
    */
   void OnEditCMakeMouseEnter(wxMouseEvent& event);
   /**
    * Handler when a cmakelists button hover finishes.
+   * @param event cmakelists event.
    */
   void OnEditCMakeMouseExit(wxMouseEvent& event);
 
   /**
    * Handler when the disable help checkbox is changed.
    */
   void OnEditCMakeMouseExit(wxMouseEvent& event);
 
   /**
    * Handler when the disable help checkbox is changed.
+   * @param event check box event.
    */
   void OnDisableHelp(wxCommandEvent& event);
 };
    */
   void OnDisableHelp(wxCommandEvent& event);
 };
index 899086827d3d596528172dbc4c5cb51f60dceef6..dcf2fd32e3d7efa0b686f9c94d8b3b232c4c89df 100644 (file)
 
 #include "modelCDMProject.h"
 
 
 #include "modelCDMProject.h"
 
-
+/**
+ * Package manager description panel. Shows the available packages in the project and the actions corresponding to package management.
+ */
 class wxCDMPackageManagerPanel : public wxPanel
 {
   DECLARE_EVENT_TABLE()
 public:
 
 class wxCDMPackageManagerPanel : public wxPanel
 {
   DECLARE_EVENT_TABLE()
 public:
 
+  /**
+   * Package manager description 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.
+   */
   wxCDMPackageManagerPanel(
       wxWindow* parent,
       modelCDMProject* project,
   wxCDMPackageManagerPanel(
       wxWindow* parent,
       modelCDMProject* project,
@@ -58,8 +70,21 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Destructor.
+   */
   ~wxCDMPackageManagerPanel();
 
   ~wxCDMPackageManagerPanel();
 
+  /**
+   * Package manager description panel Creator.
+   * @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.
+   */
   bool Create(
       wxWindow* parent,
       modelCDMProject* project,
   bool Create(
       wxWindow* parent,
       modelCDMProject* project,
@@ -70,23 +95,57 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Creates all the controls in the panel (property and action controls).
+   */
   void CreateControls();
 
   void CreateControls();
 
+  /**
+   * Retrieves the described project class reference.
+   * @return Project reference.
+   */
   modelCDMProject* GetProject() const;
 
 private:
   modelCDMProject* GetProject() const;
 
 private:
+  /**
+   * Project described
+   */
   modelCDMProject* project;
 
   //handlers
 protected:
   modelCDMProject* project;
 
   //handlers
 protected:
+  /**
+   * Handles when a return link is pressed.
+   */
   void OnBtnReturn(wxHyperlinkEvent& event);
   void OnBtnReturn(wxHyperlinkEvent& event);
+  /**
+   * Handles when a packages link is pressed.
+   */
   void OnLnkPackageSelect(wxHyperlinkEvent& event);
   void OnLnkPackageSelect(wxHyperlinkEvent& event);
+  /**
+   * Handles when the create package button is pressed.
+   */
   void OnBtnCreatePackage(wxCommandEvent& event);
   void OnBtnCreatePackage(wxCommandEvent& event);
+  /**
+   * Handles when the open package cmakelists file button is pressed.
+   */
   void OnBtnEditCMakeLists(wxCommandEvent& event);
 
   void OnBtnEditCMakeLists(wxCommandEvent& event);
 
+  /**
+   * Handles when a package link is hovered.
+   */
   void OnMouseEnter(wxMouseEvent& event);
   void OnMouseEnter(wxMouseEvent& event);
+  /**
+   * Handles when a package link button finishes hover.
+   */
   void OnMouseExit(wxMouseEvent& event);
   void OnMouseExit(wxMouseEvent& event);
+  /**
+   * Handles when the open cmakelists file button is hovered.
+   */
   void OnCMakeMouseEnter(wxMouseEvent& event);
   void OnCMakeMouseEnter(wxMouseEvent& event);
+  /**
+   * Handles when the open cmakelists file button finishes hover.
+   */
   void OnCMakeMouseExit(wxMouseEvent& event);
 };
 
   void OnCMakeMouseExit(wxMouseEvent& event);
 };
 
index dc98709501961ba7ee3756231e0c19835c967141..93850e277860202f560ffab39f7b6a095c701087 100755 (executable)
 
 #include "modelCDMProject.h"
 
 
 #include "modelCDMProject.h"
 
+/**
+ * Panel with common actions for an open Crea project.
+ */
 class wxCDMProjectActionsPanel : public wxPanel
 {
   DECLARE_EVENT_TABLE()
 public:
 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,
   wxCDMProjectActionsPanel(
       wxWindow* parent,
       modelCDMProject* project,
@@ -54,7 +67,20 @@ public:
       const wxSize& size = wxDefaultSize,
       long style = wxDEFAULT_FRAME_STYLE
   );
       const wxSize& size = wxDefaultSize,
       long style = wxDEFAULT_FRAME_STYLE
   );
+  /**
+   * Destructor.
+   */
   ~wxCDMProjectActionsPanel();
   ~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,
   bool Create(
       wxWindow* parent,
       wxWindowID id = -1,
@@ -65,14 +91,32 @@ public:
   );
 
 protected:
   );
 
 protected:
+  /**
+   * Creates the Panel controls (buttons)
+   */
   void CreateControls();
 
   void CreateControls();
 
+  /**
+   * Handles when the Check Project Structure button is pressed.
+   */
   void OnBtnCheckProjectStructure(wxCommandEvent& event);
   void OnBtnCheckProjectStructure(wxCommandEvent& event);
+  /**
+   * Handles when the Configure Compilation button is pressed.
+   */
   void OnBtnConfigureBuild(wxCommandEvent& event);
   void OnBtnConfigureBuild(wxCommandEvent& event);
+  /**
+   * Handles when the Compile Project button is pressed.
+   */
   void OnBtnBuildProject(wxCommandEvent& event);
   void OnBtnBuildProject(wxCommandEvent& event);
+  /**
+   * Handles when the Plug packages button is pressed.
+   */
   void OnBtnConnectProject(wxCommandEvent& event);
 
 private:
   void OnBtnConnectProject(wxCommandEvent& event);
 
 private:
+  /**
+   * Project class reference
+   */
   modelCDMProject* project;
 };
 
   modelCDMProject* project;
 };
 
index 0341921b7812340a19711396523f3b1e1d14cb88..86726c5dd1296b479776b341abffc827f2725f0a 100644 (file)
 
 #include "modelCDMProject.h"
 
 
 #include "modelCDMProject.h"
 
+/**
+ * Project Description Panel. Shows the project properties and the principal actions for the project.
+ */
 class wxCDMProjectDescriptionPanel : public wxPanel
 {
   DECLARE_EVENT_TABLE()
 public:
 
 class wxCDMProjectDescriptionPanel : public wxPanel
 {
   DECLARE_EVENT_TABLE()
 public:
 
+  /**
+   * Project Description 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.
+   */
   wxCDMProjectDescriptionPanel(
       wxWindow* parent,
       modelCDMProject* project,
   wxCDMProjectDescriptionPanel(
       wxWindow* parent,
       modelCDMProject* project,
@@ -55,8 +68,22 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Destructor.
+   */
   ~wxCDMProjectDescriptionPanel();
 
   ~wxCDMProjectDescriptionPanel();
 
+  /**
+   * Project Description panel Creator.
+   * @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.
+   * @return True if creation was successful.
+   */
   bool Create(
       wxWindow* parent,
       modelCDMProject* project,
   bool Create(
       wxWindow* parent,
       modelCDMProject* project,
@@ -67,31 +94,89 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Creates all the controls in the panel (property and action controls).
+   */
   void CreateControls();
 
   void CreateControls();
 
+  /**
+   * Retrieves the described project class reference.
+   * @return Project reference.
+   */
   modelCDMProject* GetProject() const;
 
 private:
   modelCDMProject* GetProject() const;
 
 private:
+  /**
+   * Project described
+   */
   modelCDMProject* project;
   modelCDMProject* project;
+  /**
+   * Text control showing the project version.
+   */
   wxStaticText* versiontc;
   wxStaticText* versiontc;
+  /**
+   * Text control showing the project version date.
+   */
   wxStaticText* versionDatetc;
   wxStaticText* versionDatetc;
+  /**
+   * Text control showing the project build path.
+   */
   wxStaticText* buildPathtc;
 
   //handlers
 protected:
   wxStaticText* buildPathtc;
 
   //handlers
 protected:
+  /**
+   * Handles when the manage packages button is pressed.
+   */
   void OnBtnManagePackages(wxCommandEvent& event);
   void OnBtnManagePackages(wxCommandEvent& event);
+  /**
+   * Handles when the manage libraries button is pressed.
+   */
   void OnBtnManageLibraries(wxCommandEvent& event);
   void OnBtnManageLibraries(wxCommandEvent& event);
+  /**
+   * Handles when the manage applications button is pressed.
+   */
   void OnBtnManageApplications(wxCommandEvent& event);
   void OnBtnManageApplications(wxCommandEvent& event);
+  /**
+   * Handles when the open cmakelists file button is pressed.
+   */
   void OnBtnEditCMakeLists(wxCommandEvent& event);
   void OnBtnEditCMakeLists(wxCommandEvent& event);
+  /**
+   * Handles when the choose build path button is pressed.
+   */
   void OnBtnSetBuildPath(wxCommandEvent& event);
   void OnBtnSetBuildPath(wxCommandEvent& event);
+  /**
+   * Handles when the open containing folder button is pressed.
+   */
   void OnBtnOpenFolder(wxCommandEvent& event);
   void OnBtnOpenFolder(wxCommandEvent& event);
+  /**
+   * Handles when the set version button is pressed.
+   */
   void OnBtnSetVersion(wxCommandEvent& event);
 
   void OnBtnSetVersion(wxCommandEvent& event);
 
+  /**
+   * Handles when the open cmakelists file button is hovered.
+   */
   void OnCMakeMouseEnter(wxMouseEvent& event);
   void OnCMakeMouseEnter(wxMouseEvent& event);
+  /**
+   * Handles when the open cmakelists file button finishes hover.
+   */
   void OnCMakeMouseExit(wxMouseEvent& event);
   void OnCMakeMouseExit(wxMouseEvent& event);
+  /**
+   * Handles when the manage applications button is hovered.
+   */
   void OnAppliMouseEnter(wxMouseEvent& event);
   void OnAppliMouseEnter(wxMouseEvent& event);
+  /**
+   * Handles when the manage applications file button finishes hover.
+   */
   void OnAppliMouseExit(wxMouseEvent& event);
   void OnAppliMouseExit(wxMouseEvent& event);
+  /**
+   * Handles when the manage libraries button is hovered.
+   */
   void OnLibMouseEnter(wxMouseEvent& event);
   void OnLibMouseEnter(wxMouseEvent& event);
+  /**
+   * Handles when the manage libraries button finishes hover.
+   */
   void OnLibMouseExit(wxMouseEvent& event);
 };
 
   void OnLibMouseExit(wxMouseEvent& event);
 };
 
index bc79bf946c931f497d3e05cb2e7ec965fdbdbe32..2e03c56ff071a499f9f0edaee8eb58cc808a0dd8 100644 (file)
@@ -79,6 +79,7 @@ public:
    * @param position Dialog position. By default wxDefaultPosition.
    * @param size Dialog size. By default 350, 700.
    * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
    * @param position Dialog position. By default wxDefaultPosition.
    * @param size Dialog size. By default 350, 700.
    * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   * @return if the creation was successful.
    */
   bool Create(
       wxWindow* parent,
    */
   bool Create(
       wxWindow* parent,
@@ -106,11 +107,13 @@ private:
 protected:
   /**
    * Handler to close help dialog.
 protected:
   /**
    * Handler to close help dialog.
+   * @param event Unused.
    */
   void OnFinish(wxCommandEvent& event);
 
   /**
    * Handler when the disable help checkbox is changed.
    */
   void OnFinish(wxCommandEvent& event);
 
   /**
    * Handler when the disable help checkbox is changed.
+   * @param event Check box event.
    */
   void OnDisableHelp(wxCommandEvent& event);
 };
    */
   void OnDisableHelp(wxCommandEvent& event);
 };
index 1536e09bb7e2a62d62f4354cdf810ca6f5bd67d1..72fb814f8157a9227d7a988734c31723984be46f 100644 (file)
 
 #include <map>
 
 
 #include <map>
 
+/**
+ * Project Structure Report Dialog. Allows the user to inspect what is compiling and what's not.
+ */
 class wxCDMProjectStructureReportDialog : public wxDialog
 {
   DECLARE_EVENT_TABLE()
 public:
 class wxCDMProjectStructureReportDialog : public wxDialog
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * Project Structure Report Dialog Constructor.
+   * @param parent Parent window.
+   * @param properties Project precompilation check map.
+   * @param id Window ID. By default wxID_ANY.
+   * @param caption Window label. By default "Project Structure Report".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 700, 500.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   */
   wxCDMProjectStructureReportDialog(
       wxWindow* parent,
       const std::map<std::string, bool>& properties,
   wxCDMProjectStructureReportDialog(
       wxWindow* parent,
       const std::map<std::string, bool>& properties,
@@ -54,7 +67,20 @@ public:
       const wxSize& size = wxSize(700,500),
       long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
   );
       const wxSize& size = wxSize(700,500),
       long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
   );
+  /**
+   * Destructor.
+   */
   ~wxCDMProjectStructureReportDialog();
   ~wxCDMProjectStructureReportDialog();
+  /**
+   * Project Structure Report Dialog Creator.
+   * @param parent Parent window.
+   * @param id Window ID. By default wxID_ANY.
+   * @param caption Window label. By default "Project Structure Report".
+   * @param position Dialog position. By default wxDefaultPosition.
+   * @param size Dialog size. By default 700, 500.
+   * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+   * @return if the creation was successful.
+   */
   bool Create(
       wxWindow* parent,
       wxWindowID id = wxID_ANY,
   bool Create(
       wxWindow* parent,
       wxWindowID id = wxID_ANY,
@@ -65,15 +91,29 @@ public:
   );
 
 protected:
   );
 
 protected:
+  /**
+   * Creates the Dialog controls (text and button).
+   */
   void CreateControls();
 
 //attributes
 private:
   void CreateControls();
 
 //attributes
 private:
+  /**
+   * Project check results.
+   */
   std::map<std::string, bool> properties;
 
 //handlers
 protected:
   std::map<std::string, bool> properties;
 
 //handlers
 protected:
+  /**
+   * Handles when the close button is pressed.
+   * @param event Unused.
+   */
   void OnFinish(wxCommandEvent& event);
   void OnFinish(wxCommandEvent& event);
+  /**
+   * Creates the project structure check results processed for showing them. In HTML
+   * @return Report in HTML format.
+   */
   wxString GetContent();
 };
 
   wxString GetContent();
 };
 
index 82a9698c7011a85b37fec8833648b99a09a5b715..87958dda55617c9af8b9b452b6ac1404329e15aa 100755 (executable)
 #include <vector>
 #include <map>
 
 #include <vector>
 #include <map>
 
+/**
+ * Project Tree Control. Shows a project's content in a hierarchy tree control.
+ */
 class wxCDMProjectsTreeCtrl: public wxTreeCtrl
 {
 public:
 class wxCDMProjectsTreeCtrl: public wxTreeCtrl
 {
 public:
+  /**
+   * Project Tree Control Constructor.
+   * @param parent Parent window reference.
+   * @param id Control ID, by default wxID_ANY.
+   * @param pos Control position. By default wxDefaultPosition.
+   * @param size Control size. By default wxDefaultSize.
+   * @param style Control style. By default wxTR_DEFAULT_STYLE.
+   * @param validator Validator. By default wxDefaultValidator.
+   * @param name Control Name. By default "Projects tree".
+   */
   wxCDMProjectsTreeCtrl(
       wxWindow *parent,
       wxWindowID id=wxID_ANY,
   wxCDMProjectsTreeCtrl(
       wxWindow *parent,
       wxWindowID id=wxID_ANY,
@@ -56,7 +69,21 @@ public:
       const wxValidator &validator=wxDefaultValidator,
       const wxString &name=_("Projects tree")
   );
       const wxValidator &validator=wxDefaultValidator,
       const wxString &name=_("Projects tree")
   );
+  /**
+   * Destructor.
+   */
   ~wxCDMProjectsTreeCtrl();
   ~wxCDMProjectsTreeCtrl();
+  /**
+   * Project Tree Control Creator.
+   * @param parent Parent window reference.
+   * @param id Control ID, by default wxID_ANY.
+   * @param pos Control position. By default wxDefaultPosition.
+   * @param size Control size. By default wxDefaultSize.
+   * @param style Control style. By default wxTR_DEFAULT_STYLE.
+   * @param validator Validator. By default wxDefaultValidator.
+   * @param name Control Name. By default "Projects tree".
+   * @return True if the creation was successful.
+   */
   bool Create(
       wxWindow *parent,
       wxWindowID id=wxID_ANY,
   bool Create(
       wxWindow *parent,
       wxWindowID id=wxID_ANY,
@@ -67,23 +94,70 @@ public:
       const wxString &name=_("Projects tree")
   );
 
       const wxString &name=_("Projects tree")
   );
 
+  /**
+   * Builds the tree hierarchy with the given model elements.
+   */
   void BuildTree(std::map< wxTreeItemId, modelCDMIProjectTreeNode* >& modelElements, modelCDMProject* tree = NULL);
 
 private:
 
   void BuildTree(std::map< wxTreeItemId, modelCDMIProjectTreeNode* >& modelElements, modelCDMProject* tree = NULL);
 
 private:
 
+  /**
+   * A Icon ID.
+   */
   int ID_AIcon;
   int ID_AIcon;
+  /**
+   * Ap Icon ID.
+   */
   int ID_ApIcon;
   int ID_ApIcon;
+  /**
+   * BB Icon ID.
+   */
   int ID_BBIcon;
   int ID_BBIcon;
+  /**
+   * C Icon ID.
+   */
   int ID_Cicon;
   int ID_Cicon;
+  /**
+   * CM Icon ID.
+   */
   int ID_CMIcon;
   int ID_CMIcon;
+  /**
+   * Fd Icon ID.
+   */
   int ID_FdIcon;
   int ID_FdIcon;
+  /**
+   * Fl Icon ID.
+   */
   int ID_FlIcon;
   int ID_FlIcon;
+  /**
+   * Lb Icon ID.
+   */
   int ID_LbIcon;
   int ID_LbIcon;
+  /**
+   * L Icon ID.
+   */
   int ID_LIcon;
   int ID_LIcon;
+  /**
+   * Pr Icon ID.
+   */
   int ID_PrIcon;
   int ID_PrIcon;
+  /**
+   * Pk Icon ID.
+   */
   int ID_PkIcon;
 
   int ID_PkIcon;
 
+  /**
+   * Builds the tree with the hierarchy given and fills the modelElements map.
+   * @param tree Root node of the tree.
+   * @param modelElements Id->node map.
+   * @param parent ID of the root node ID.
+   */
   void BuildTree(const std::vector<modelCDMIProjectTreeNode*>& tree, std::map< wxTreeItemId, modelCDMIProjectTreeNode* >& modelElements, wxTreeItemId parent);
   void BuildTree(const std::vector<modelCDMIProjectTreeNode*>& tree, std::map< wxTreeItemId, modelCDMIProjectTreeNode* >& modelElements, wxTreeItemId parent);
+  /**
+   * Retrieves the icon ID of the given node by its type.
+   * @param node Node to search its icon.
+   * @return Icon ID
+   */
   int GetIconId(modelCDMIProjectTreeNode* node);
 };
 
   int GetIconId(modelCDMIProjectTreeNode* node);
 };