Feature #1711 CreaDevManager application implementation

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

diff --git a/lib/creaDevManagerLib/wxCDMNewBlackBoxDialog.h b/lib/creaDevManagerLib/wxCDMNewBlackBoxDialog.h
index 9d5a7fc222ecb64b486ae3b7c5a0dd2dffd654b7..1c48f9453bb6757580e7a2373040f34f74f5f566 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMNewBlackBoxDialog.h
+++ b/lib/creaDevManagerLib/wxCDMNewBlackBoxDialog.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.
 # ------------------------------------------------------------------------ 
-*/ 
+ */
 
 
 /*
@@ -40,10 +40,22 @@
 #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:
+  /**
+   * 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,
@@ -52,7 +64,20 @@ public:
       const wxSize& size = wxSize(500,500),
       long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
   );
+  /**
+   * Destructor.
+   */
   ~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,
@@ -62,29 +87,89 @@ public:
       long style = wxDEFAULT_DIALOG_STYLE
   );
 
+  /**
+   * Returns the black box name chosen by the user.
+   * @return Black box name.
+   */
   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;
+  /**
+   * Returns the black box's author email chosen by the user.
+   * @return Black box's author email.
+   */
   const wxString GetBlackBoxAuthorEmail() const;
+  /**
+   * Returns the black box description chosen by the user.
+   * @return Black box description.
+   */
   const wxString GetBlackBoxDescription() const ;
+  /**
+   * Returns the black box categories chosen by the user.
+   * @return Black box categories.
+   */
   const wxString GetBlackBoxCategories() const ;
+  /**
+   * Returns the black box type chosen by the user.
+   * @return Black box type.
+   */
   const wxString GetBlackBoxType() const;
+  /**
+   * Returns the black box format chosen by the user.
+   * @return Black box format.
+   */
   const wxString GetBlackBoxFormat() const;
 
 protected:
+  /**
+   * Creates the visual controls of the Dialog.
+   */
   void CreateControls();
 
 private:
+  /**
+   * Black box name.
+   */
   wxTextCtrl* blackBoxName;
+  /**
+   * Black box's author name.
+   */
   wxTextCtrl* blackBoxAuthor;
+  /**
+   * Black box's author email.
+   */
   wxTextCtrl* blackBoxAuthorEmail;
+  /**
+   * Black box description.
+   */
   wxTextCtrl* blackBoxDescription;
+  /**
+   * Black box categories.
+   */
   wxTextCtrl* blackBoxCategories;
+  /**
+   * Black box type.
+   */
   wxChoice* blackBoxType;
+  /**
+   * Black box format.
+   */
   wxChoice* blackBoxFormat;
 
-//handlers
+  //handlers
 protected:
+  /*
+   * Handles when the create black box button is pressed.
+   * @param event Unused event.
+   */
   void OnCreateBlackBox(wxCommandEvent& event);
+  /*
+   * Handles when the cancel button is pressed.
+   * @param event Unused event.
+   */
   void OnCancel(wxCommandEvent& event);
 };