creaButtonContainer: doxygen 90%

[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 bb6b774bc141a0ea046c67ff69061a93379316d9..fd1c3b80241a48906eab42c2b706dbb1f4265d95 100644 (file)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonGroup.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonGroup.h
@@ -26,69 +26,74 @@ namespace creaButtonContainer
         */
        namespace view
        {
+               /*! @class ButtonGroup buttonGroup.h "buttonGroup.h"
+                                *      @brief This class contains the group of buttons.
+                                */
                class ButtonGroup
                {
                        public:
                                //Typedef definition
-                               /*!     @typedef creaButtonContainer::model::TFunctor TFunctor;
-                                *      @brief Defines the TFunctor type.
+                               /*!     @typedef creaButtonContainer::view::Button Button;
+                                *      @brief Defines the Button type.
                                 */
                                typedef creaButtonContainer::view::Button Button;
-                               /*!     @typedef creaButtonContainer::model::TFunctor TFunctor;
-                                *      @brief Defines the TFunctor type.
+                               // ----------------------------------------------------------------------------------
+                               /*!     @typedef std::map< long, Button* > ButtonContainer;
+                                *      @brief Defines the ButtonContainer type.
                                 */
                                typedef std::map< long, Button* > ButtonContainer;
-                               /*!     @typedef creaButtonContainer::model::TFunctor TFunctor;
-                                *      @brief Defines the TFunctor type.
+                               // ----------------------------------------------------------------------------------
+                               /*!     typedef std::list< long > IdButtonContainer;
+                                *      @brief Defines the IdButtonContainer type.
                                 */
                                typedef std::list< long > IdButtonContainer;
                        public:
                                // ----------------------------------------------------------------------------------
                                /*! @fn ButtonGroup( wxStaticText* groupName, ButtonContainer buttons );
-                                *
-                                * @param groupName
-                                * @param buttons
+                                *      @brief This is the parameterized constructor.
+                                * @param groupName wxStatigText* with the name of the group.
+                                * @param buttons A container with buttons.
                                 */
                                ButtonGroup( wxStaticText* groupName, ButtonContainer buttons );
                                // ----------------------------------------------------------------------------------
                                /*! @fn ~ButtonGroup( );
-                                *
+                                * @brief This is the destructor.
                                 */
                                virtual
                                ~ButtonGroup( );
                                // ----------------------------------------------------------------------------------
                                /*! @fn GetButton( long id );
-                                *
-                                * @param id
-                                * @return
+                                * @brief This method returns a Button*
+                                * @param id The ID of the button.
+                                * @return Button*
                                 */
                                Button*
                                GetButton( long id );
                                // ----------------------------------------------------------------------------------
                                /*! @fn GetButtonContainer( );
-                                *
-                                * @return
+                                * @brief This method returns the button container.
+                                * @return ButtonContainer.
                                 */
                                ButtonContainer
                                GetButtonContainer( );
                                // ----------------------------------------------------------------------------------
                                /*! @fn GetButtonIdContainer( );
-                                *
+                                * @brief This method returns a list of button IDs.
                                 * @return
                                 */
                                IdButtonContainer
                                GetButtonIdContainer( );
                                // ----------------------------------------------------------------------------------
                                /*! @fn GetGroupName( );
-                                *
+                                * @brief This method returns the name of the group.
                                 * @return
                                 */
                                wxStaticText*
                                GetGroupName( );
                                // ----------------------------------------------------------------------------------
                        private:
-                               wxStaticText* m_GroupName;
-                               ButtonContainer m_Buttons;
+                               wxStaticText* m_GroupName; //!<A pointer with the name of the group.
+                               ButtonContainer m_Buttons; //!<A container with buttons.
                };
        }//ecapseman
 }//ecapseman