DFCH

[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 920dfd260c997c763b178566ed485531aae8aa41..0172389155754da83ced5df4136da4718407fd98 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,51 +1,104 @@
-/***************************************************************
- * 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-06-02
+ */
 
 #ifndef BUTTONGROUP_H
 #define BUTTONGROUP_H
 
 //Library Definition
+#include <wx/stattext.h>
+
 #include <map>
 #include <list>
-#include <wx/stattext.h>
+#include <exception>
 
 #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
        {
-               //Typedef definition
-               typedef creaButtonContainer::view::Button Button;
-               typedef std::map< long, Button* > ButtonContainer;
-               typedef std::list< long > IdButtonContainer;
-
-               /**
-                Class Description: This class defines a ButtonGroup.
-                **/
+               /*! @class ButtonGroup buttonGroup.h "buttonGroup.h"
+                *      @brief This class contains the group of buttons.
+                */
                class ButtonGroup
                {
                        public:
+                               //Typedef definition
+                               // ----------------------------------------------------------------------------------
+                               /*!     @typedef creaButtonContainer::view::Button Button;
+                                *      @brief Defines the Button type.
+                                */
+                               typedef creaButtonContainer::view::Button Button;
+                               // ----------------------------------------------------------------------------------
+                               /*!     @typedef std::map< long, Button* > ButtonContainer;
+                                *      @brief Defines the ButtonContainer type.
+                                */
+                               typedef std::map< long, Button* > ButtonContainer;
+                               // ----------------------------------------------------------------------------------
+                               /*!     typedef std::list< long > IdButtonContainer;
+                                *      @brief Defines the IdButtonContainer type.
+                                */
+                               typedef std::list< long > IdButtonContainer;
+                       public:
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn ButtonGroup( wxStaticText* groupName, ButtonContainer 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 );
+                                * @brief This method returns a Button*
+                                * @param id The ID of the button.
+                                * @return Button*
+                                */
                                Button*
                                GetButton( long id );
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn GetButtonContainer( );
+                                * @brief This method returns the button container.
+                                * @exception std::bad_alloc
+                                * @return ButtonContainer.
+                                */
                                ButtonContainer
                                GetButtonContainer( );
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn GetButtonIdContainer( );
+                                * @brief This method returns a list of button IDs.
+                                * @exception std::bad_alloc
+                                * @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 wxStaticText of name of the group.
+                               ButtonContainer m_Buttons; //!<A container with buttons.
                };
        }//ecapseman
 }//ecapseman