Feature #1711

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

diff --git a/lib/creaDevManagerLib/wxCDMLibHelpDialog.h b/lib/creaDevManagerLib/wxCDMLibHelpDialog.h
index 5620dc93f19bc6e60c61e01a90e4b5fd5dfd42a2..9d7049a24be60cb5e10ecce60966a7060a7d1317 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMLibHelpDialog.h
+++ b/lib/creaDevManagerLib/wxCDMLibHelpDialog.h
@@ -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.
+   * @return if the creation was successful.
    */
   bool Create(
       wxWindow* parent,
@@ -106,25 +107,30 @@ private:
 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 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.
+   * @param event cmakelists event.
    */
   void OnEditCMakeMouseExit(wxMouseEvent& event);
 
   /**
    * Handler when the disable help checkbox is changed.
+   * @param event check box event.
    */
   void OnDisableHelp(wxCommandEvent& event);
 };