Feature #1606 Add a new entry to ColorLayerImageView to select the fitting mode betwe...

[creaMaracasVisu.git] / lib / maracasVisuLib / src / interface / wxWindows / widgets / creaButtonContainer / controller / buttonContainerController.h

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/controller/buttonContainerController.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/controller/buttonContainerController.h
index 3ca492aa40ae9296dcb2e4e1d5258818fbb2c6d2..b240cb827c0cdacc1954aa11491f81d193f6cf96 100644 (file)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/controller/buttonContainerController.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/controller/buttonContainerController.h
@@ -1,8 +1,8 @@
 /*!
  * @file buttonContainerController.h
- * @brief This contains the ButtonContainerController class
+ * @brief Contains the ButtonContainerController class
  * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date  2011-05-19
+ * @date  2011-06-02
  */
 
 #ifndef BUTTONCONTAINERCONTROLLER_H_
@@ -25,7 +25,7 @@ namespace creaButtonContainer
        namespace view
        {
                //Predefinition of ButtonContainerPanel FriendClass!!
-               /*! @class ButtonContainerPanel : public wxScrolledWindow buttonContainerPanel.h "buttonContainerPanel.h"
+               /*! @class ButtonContainerPanel buttonContainerPanel.h "buttonContainerPanel.h"
                 *  @brief This class is the container of the creaButtonContainer.
                 *  @details This class derives from wxScrolledWindow and manages the view of the buttonContainer.
                 *  @see <a href="http://docs.wxwidgets.org/stable/wx_wxscrolledwindow.html">wxScrolledWindow</a>
@@ -40,14 +40,14 @@ namespace creaButtonContainer
        {
                /*! @class ButtonContainerController buttonContainerController.h "buttonContainerController.h"
                 *      @brief This class contains the ButtonContainerPanel controller.
-                *  @details This class describes the button events, it derives from wxEvtHandler and it is the
-                *  controller in the MVC.
+                *  @details This class describes the button events, it derives from wxEvtHandler.
                 *  @see <a href="http://docs.wxwidgets.org/stable/wx_wxevthandler.html">wxEvtHandler</a>
                 */
                class ButtonContainerController : public wxEvtHandler
                {
                        public:
                                //typedef definitions
+                               // ----------------------------------------------------------------------------------
                                /*!     @typedef creaButtonContainer::view::ButtonGroup ButtonGroup
                                 *      @brief Defines the ButtonGroup type
                                 */
@@ -88,6 +88,7 @@ namespace creaButtonContainer
                                 *      @brief Defines the BCPanel type
                                 */
                                typedef creaButtonContainer::view::ButtonContainerPanel BCPanel;
+                               // ----------------------------------------------------------------------------------
                                //end of typedef definition
                        public:
                                // ----------------------------------------------------------------------------------
@@ -105,14 +106,14 @@ namespace creaButtonContainer
 
                                // ----------------------------------------------------------------------------------
                                /*! @fn void AddEvents( );
-                                *      @brief This function connect every buttonEvent to the view.
+                                *      @brief This method connect every buttonEvents to the view.
                                 *      @exception std::bad_alloc
                                 */
                                void
                                AddEvents( );
                                // ----------------------------------------------------------------------------------
                                /*! @fn void ButtonExpEvent( wxCommandEvent& event );
-                                *      @brief This function is the button group "+" "-" event.
+                                *      @brief This method is the button group "+" "-" event.
                                 *      @exception std::bad_alloc
                                 *      @param event Button action event.
                                 */
@@ -120,7 +121,7 @@ namespace creaButtonContainer
                                ButtonExpEvent( wxCommandEvent& event );
                                // ----------------------------------------------------------------------------------
                                /*! @fn void ButtonEvent( wxCommandEvent& event );
-                                *      @brief This function calls the events of the buttonContainer buttons
+                                *      @brief This method calls the events of the buttonContainer buttons
                                 *      @exception std::bad_alloc
                                 *      @param event Button action event.
                                 */