Feature #1711

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

diff --git a/lib/creaDevManagerLib/wxCDMLibHelpDialog.h b/lib/creaDevManagerLib/wxCDMLibHelpDialog.h
index 59a000f53dfb9063ad7fd71c0fe1a17fcfb1eabd..5620dc93f19bc6e60c61e01a90e4b5fd5dfd42a2 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMLibHelpDialog.h
+++ b/lib/creaDevManagerLib/wxCDMLibHelpDialog.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.
 # ------------------------------------------------------------------------ 
-*/ 
+ */
 
 
 /*
@@ -41,10 +41,23 @@
 
 #include "modelCDMLib.h"
 
+/**
+ * Lib Panel Help Dialog
+ */
 class wxCDMLibHelpDialog : public wxDialog
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * Lib Panel Help Dialog Constructor.
+   * @param parent Parent window.
+   * @param lib Library class reference.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "Managing Libraries".
+   * @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.
+   */
   wxCDMLibHelpDialog(
       wxWindow* parent,
       modelCDMLib* lib,
@@ -54,7 +67,19 @@ public:
       const wxSize& size = wxSize(350,600),
       long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
   );
+  /**
+   * Destructor.
+   */
   ~wxCDMLibHelpDialog();
+  /**
+   * Lib Panel Help Dialog Creator.
+   * @param parent Parent window.
+   * @param id Dialog ID. By default wxID_ANY.
+   * @param caption Dialog label. By default "Managing Libraries".
+   * @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.
+   */
   bool Create(
       wxWindow* parent,
       wxWindowID id = wxID_ANY,
@@ -65,21 +90,42 @@ public:
   );
 
 protected:
+  /**
+   * Creates the help controls (text and buttons).
+   */
   void CreateControls();
 
-//attributes
+  //attributes
 private:
+  /**
+   * Lib class reference.
+   */
   modelCDMLib* lib;
 
-//handlers
+  //handlers
 protected:
+  /**
+   * Handler to close help dialog.
+   */
   void OnFinish(wxCommandEvent& event);
 
+  /**
+   * Handler when a cmakelists button is pressed.
+   */
   void OnEditCMake(wxCommandEvent& event);
 
+  /**
+   * Handler when a cmakelists button is hovered.
+   */
   void OnEditCMakeMouseEnter(wxMouseEvent& event);
+  /**
+   * Handler when a cmakelists button hover finishes.
+   */
   void OnEditCMakeMouseExit(wxMouseEvent& event);
 
+  /**
+   * Handler when the disable help checkbox is changed.
+   */
   void OnDisableHelp(wxCommandEvent& event);
 };