By Leonardo Florez

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

diff --git a/lib/creaDevManagerLib/wxCDMPackageHelpDialog.h b/lib/creaDevManagerLib/wxCDMPackageHelpDialog.h
index 1db7ffabf8299af2b554e17d3a3b8706b9738dfd..870f7a7ceadcb9f8e65a328daf6925c758c16690 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMPackageHelpDialog.h
+++ b/lib/creaDevManagerLib/wxCDMPackageHelpDialog.h
@@ -43,10 +43,23 @@
 
 #include <vector>
 
+/**
+ * Package Panel Help Dialog
+ */
 class wxCDMPackageHelpDialog : public wxDialog
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * Package Panel Help Dialog Constructor.
+   * @param parent Parent window.
+   * @param package Package class reference.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "Working with Packages".
+   * @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.
+   */
   wxCDMPackageHelpDialog(
       wxWindow* parent,
       modelCDMPackage* package,
@@ -56,7 +69,20 @@ public:
       const wxSize& size = wxSize(350,570),
       long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
   );
+  /**
+   * Destructor.
+   */
   ~wxCDMPackageHelpDialog();
+  /**
+   * Package Panel Help Dialog Constructor.
+   * @param parent Parent window.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "Working with Packages".
+   * @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,
       wxWindowID id = wxID_ANY,
@@ -67,20 +93,46 @@ public:
   );
 
 protected:
+  /**
+   * Creates the help controls (text and buttons).
+   */
   void CreateControls();
 
 private:
+  /**
+   * Package class reference.
+   */
   modelCDMPackage* package;
 
 //handlers
 protected:
+  /**
+   * Handler to close help dialog.
+   * @param event Unused.
+   */
   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.
+   * @param event cmakelists event.
+   */
   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.
+   * @param event check box event.
+   */
   void OnDisableHelp(wxCommandEvent& event);
 };