Feature #1711

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

diff --git a/lib/creaDevManagerLib/wxCDMNewPackageDialog.h b/lib/creaDevManagerLib/wxCDMNewPackageDialog.h
index 1f0e55f84c6c3d513f4eb5ae545106d691f80df9..eda8a91856335f3a2eded68a89e43c9e8d9ff747 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMNewPackageDialog.h
+++ b/lib/creaDevManagerLib/wxCDMNewPackageDialog.h
@@ -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.
 # ------------------------------------------------------------------------ 
-*/ 
+ */
 
 
 /*
@@ -39,10 +39,22 @@
 #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:
+  /**
+   * 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,
@@ -51,7 +63,19 @@ public:
       const wxSize& size = wxSize(500,400),
       long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
   );
+  /**
+   * Destructor.
+   */
   ~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,
@@ -61,23 +85,62 @@ public:
       long style = wxDEFAULT_DIALOG_STYLE
   );
 
+  /**
+   * Returns the package name chosen by the user.
+   * @return Package name.
+   */
   const wxString GetPackageName();
+  /**
+   * Returns the package author name chosen by the user.
+   * @return Package author name.
+   */
   const wxString GetPackageAuthor();
+  /**
+   * Returns the package author's email chosen by the user.
+   * @return Package author's email.
+   */
   const wxString GetPackageAuthorEmail();
+  /**
+   * Returns the package description chosen by the user.
+   * @return Package description.
+   */
   const wxString GetPackageDescription();
 
 protected:
+  /**
+   * Creates the visual controls of the Dialog.
+   */
   void CreateControls();
 
 private:
+  /**
+   * Package name.
+   */
   wxTextCtrl* packageName;
+  /**
+   * Package author name.
+   */
   wxTextCtrl* packageAuthor;
+  /**
+   * Package author's email.
+   */
   wxTextCtrl* packageAuthorEmail;
+  /**
+   * Package description.
+   */
   wxTextCtrl* packageDescription;
 
-//handlers
+  //handlers
 protected:
+  /**
+   * Handles when the create package button is pressed.
+   * @param event Unused event.
+   */
   void OnCreatePackage(wxCommandEvent& event);
+  /**
+   * Handles when the cancel button is pressed.
+   * @param event Unused event.
+   */
   void OnCancel(wxCommandEvent& event);
 };