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

[creaMaracasVisu.git] / lib / maracasVisuLib / src / interface / wxWindows / widgets / creaButtonContainer / view / buttonGroup.h

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonGroup.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonGroup.h
index 74ec0f8aa33bd19beabe21f10f7bfd4139201141..bb6b774bc141a0ea046c67ff69061a93379316d9 100644 (file)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonGroup.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonGroup.h
@@ -1,11 +1,9 @@
-/***************************************************************
- * Name:      ButtonGroup.h
- * Purpose:   Defines a group of buttons in wxWidgets
- * Author:    Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * Modified:  2011-05-09
- * Copyright: Diego CACERES (http://www.creatis.insa-lyon.fr/~caceres/)
- * License:
- **************************************************************/
+/*!
+ * @file buttonGroup.h
+ * @brief This contains the ButtonGroup class.
+ * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
+ * @date  2011-05-19
+ */
 
 #ifndef BUTTONGROUP_H
 #define BUTTONGROUP_H
@@ -17,32 +15,77 @@
 
 #include "button.h"
 
+/*!    @namespace <creaButtonContainer>
+ *     @brief Contains the creaButtonContainer library included in creaMaracasVisu.
+ */
 namespace creaButtonContainer
 {
+       /*! @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
        {
-               /**
-                Class Description: This class defines a ButtonGroup.
-                **/
                class ButtonGroup
                {
                        public:
                                //Typedef definition
+                               /*!     @typedef creaButtonContainer::model::TFunctor TFunctor;
+                                *      @brief Defines the TFunctor type.
+                                */
                                typedef creaButtonContainer::view::Button Button;
+                               /*!     @typedef creaButtonContainer::model::TFunctor TFunctor;
+                                *      @brief Defines the TFunctor type.
+                                */
                                typedef std::map< long, Button* > ButtonContainer;
+                               /*!     @typedef creaButtonContainer::model::TFunctor TFunctor;
+                                *      @brief Defines the TFunctor type.
+                                */
                                typedef std::list< long > IdButtonContainer;
                        public:
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn ButtonGroup( wxStaticText* groupName, ButtonContainer buttons );
+                                *
+                                * @param groupName
+                                * @param buttons
+                                */
                                ButtonGroup( wxStaticText* groupName, ButtonContainer buttons );
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn ~ButtonGroup( );
+                                *
+                                */
                                virtual
                                ~ButtonGroup( );
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn GetButton( long id );
+                                *
+                                * @param id
+                                * @return
+                                */
                                Button*
                                GetButton( long id );
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn GetButtonContainer( );
+                                *
+                                * @return
+                                */
                                ButtonContainer
                                GetButtonContainer( );
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn GetButtonIdContainer( );
+                                *
+                                * @return
+                                */
                                IdButtonContainer
                                GetButtonIdContainer( );
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn GetGroupName( );
+                                *
+                                * @return
+                                */
                                wxStaticText*
                                GetGroupName( );
+                               // ----------------------------------------------------------------------------------
                        private:
                                wxStaticText* m_GroupName;
                                ButtonContainer m_Buttons;