Feature #1711

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

diff --git a/lib/creaDevManagerLib/wxCDMPackageHelpDialog.h b/lib/creaDevManagerLib/wxCDMPackageHelpDialog.h
index 9dd08c6e1fd31d85a392e63e63389aebdcec1ff0..870f7a7ceadcb9f8e65a328daf6925c758c16690 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMPackageHelpDialog.h
+++ b/lib/creaDevManagerLib/wxCDMPackageHelpDialog.h
@@ -81,6 +81,7 @@ public:
    * @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,
@@ -107,25 +108,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 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);
 };