Feature #1711

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

diff --git a/lib/creaDevManagerLib/wxCDMBlackBoxHelpDialog.h b/lib/creaDevManagerLib/wxCDMBlackBoxHelpDialog.h
index 25438c6366fce110375f1a8c62de5b0afca9b08d..66995d515682f29d511110226ae8238825963984 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMBlackBoxHelpDialog.h
+++ b/lib/creaDevManagerLib/wxCDMBlackBoxHelpDialog.h
@@ -81,6 +81,7 @@ public:
    * @param position Dialog position. By default wxDefaultPosition.
    * @param size Dialog size. By default 410, 700.
    * @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);
 };