creaButtonContainer: Documentation updates :) :). If you turns on the documentation...

[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 260f44be20ecde29b00aa97654fcc5cdf85176dd..3ca492aa40ae9296dcb2e4e1d5258818fbb2c6d2 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,42 +1,48 @@
-/************************************************************************************//*!
- * Name:      @file buttonContainerController.h
- * Purpose:   @brief This contains the ButtonContainerController class
- * Author:    @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * Modified:  2011-05-17
- * Copyright:
- * License:
- ***************************************************************************************/
+/*!
+ * @file buttonContainerController.h
+ * @brief This contains the ButtonContainerController class
+ * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
+ * @date  2011-05-19
+ */
 
 #ifndef BUTTONCONTAINERCONTROLLER_H_
 #define BUTTONCONTAINERCONTROLLER_H_
 
-//! @include <wx/event.h>
 #include <wx/event.h>
-//! @include <iostream>
 #include <iostream>
-//! @include <exception>
 #include <exception>
-
-//! @include "buttonContainerPanel.h"
 #include "buttonContainerPanel.h"
 
-//!    @namespace<creaButtonContainer>
+/*!    @namespace <creaButtonContainer>
+ *     @brief Contains the creaButtonContainer library included in creaMaracasVisu.
+ */
 namespace creaButtonContainer
 {
-       //! @namespace<view>
+       /*! @namespace <creaButtonContainer::view>
+        *      @brief Contains the implementation of the view in creaButtonContainer library.
+        *      @see <a href="http://en.wikipedia.org/wiki/Model-view-controller">MVC Software Architecture</a>
+        */
        namespace view
        {
                //Predefinition of ButtonContainerPanel FriendClass!!
-               //! @class ButtonContainerPanel buttonContainerPanel.h "buttonContainerPanel.h"
-
+               /*! @class ButtonContainerPanel : public wxScrolledWindow 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>
+                */
                class ButtonContainerPanel;
        }
-       //!     @namespace<controller>
+       /*!     @namespace<creaButtonContainer::controller>
+        *      @brief Contains the implementation of the controller in creaButtonContainer library.
+        *      @see <a href="http://en.wikipedia.org/wiki/Model-view-controller">MVC Software Architecture</a>
+        */
        namespace controller
        {
                /*! @class ButtonContainerController buttonContainerController.h "buttonContainerController.h"
-                *      @brief This class contains the ButtonContainerPanel controller
-                *  This class describes button events.
+                *      @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.
+                *  @see <a href="http://docs.wxwidgets.org/stable/wx_wxevthandler.html">wxEvtHandler</a>
                 */
                class ButtonContainerController : public wxEvtHandler
                {
@@ -58,7 +64,7 @@ namespace creaButtonContainer
                                typedef std::list< ButtonGroup* > ButtonGroupList;
                                // ----------------------------------------------------------------------------------
                                /*!     @typedef std::map< long, GroupManager* > GroupManagerList
-                                * @brief Defines the GroupManagerList type
+                                *      @brief Defines the GroupManagerList type
                                 */
                                typedef std::map< long, GroupManager* > GroupManagerList;
                                // ----------------------------------------------------------------------------------
@@ -84,26 +90,28 @@ namespace creaButtonContainer
                                typedef creaButtonContainer::view::ButtonContainerPanel BCPanel;
                                //end of typedef definition
                        public:
-                               /*!     @fn ButtonContainerController::ButtonContainerController( BCPanel* )
+                               // ----------------------------------------------------------------------------------
+                               /*!     @fn ButtonContainerController( BCPanel* );
                                 *      @brief This is the Parameterized constructor.
-                                *      @param BCPanel*
+                                *      @param BCPanel* The connection with the view (wxPanel link).
                                 */
                                ButtonContainerController( BCPanel* );
                                // ----------------------------------------------------------------------------------
-                               /*! @fn virtual ButtonContainerController::~ButtonContainerController( )
+                               /*! @fn ~ButtonContainerController( );
                                 *      @brief This is the destructor.
                                 */
                                virtual
                                ~ButtonContainerController( );
+
                                // ----------------------------------------------------------------------------------
-                               /*! @fn void ButtonContainerController::AddEvents( )
+                               /*! @fn void AddEvents( );
                                 *      @brief This function connect every buttonEvent to the view.
                                 *      @exception std::bad_alloc
                                 */
                                void
                                AddEvents( );
                                // ----------------------------------------------------------------------------------
-                               /*! @fn void ButtonContainerController::ButtonExpEvent( wxCommandEvent& event )
+                               /*! @fn void ButtonExpEvent( wxCommandEvent& event );
                                 *      @brief This function is the button group "+" "-" event.
                                 *      @exception std::bad_alloc
                                 *      @param event Button action event.
@@ -111,7 +119,7 @@ namespace creaButtonContainer
                                void
                                ButtonExpEvent( wxCommandEvent& event );
                                // ----------------------------------------------------------------------------------
-                               /*! @fn void ButtonContainerController::ButtonEvent( wxCommandEvent& event )
+                               /*! @fn void ButtonEvent( wxCommandEvent& event );
                                 *      @brief This function calls the events of the buttonContainer buttons
                                 *      @exception std::bad_alloc
                                 *      @param event Button action event.