creaButtonContainer: doxygen 90%

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

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/groupManager.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/groupManager.h
index 349a22eee7ab6386693bc3ccf7e2c806559d707b..aeb8dfd79c1a6434b245a56b06646bf3b7baf02b 100644 (file)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/groupManager.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/groupManager.h
@@ -33,83 +33,85 @@ namespace creaButtonContainer
                {
                        public:
                                //typedef definition
-                               /*!     @typedef creaButtonContainer::model::TFunctor TFunctor;
-                                *      @brief Defines the TFunctor type.
+                               /*!     @typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
+                                *      @brief Defines the ButtonGroup type.
                                 */
                                typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
-                               /*!     @typedef creaButtonContainer::model::TFunctor TFunctor;
-                                *      @brief Defines the TFunctor type.
+                               // ----------------------------------------------------------------------------------
+                               /*!     @typedef wxButton ExpansionButton;
+                                *      @brief Defines the ExpansionButton type.
                                 */
                                typedef wxButton ExpansionButton;
+                               // ----------------------------------------------------------------------------------
                                //end of typedef definition.
                        public:
                                // ----------------------------------------------------------------------------------
                                /*! @fn GroupManager( wxWindow* parent, ButtonGroup* buttonGroup );
-                                *
-                                * @param parent
-                                * @param buttonGroup
+                                *      @brief This is the parameterized constructor.
+                                *      @param parent The wxWindow* parent
+                                *      @param buttonGroup The pointer to the ButtonGroup.
                                 */
                                GroupManager( wxWindow* parent, ButtonGroup* buttonGroup );
                                // ----------------------------------------------------------------------------------
-                               /*! @fn
-                                * ~GroupManager( );
+                               /*! @fn ~GroupManager( );
+                                *  @brief This is the destructor.
                                 */
                                virtual
                                ~GroupManager( );
-                               //Getters and Setters
                                // ----------------------------------------------------------------------------------
-                               /*! @fn
+                               /*! @fn GetButtonID( );
+                                *  @brief This method returns the Button ID.
                                 *  @return
                                 */
                                long
                                GetButtonID( );
                                // ----------------------------------------------------------------------------------
                                /*! @fn GetButton( );
-                                *
+                                *      @brief This method returns the expansion button.
                                 * @return
                                 */
                                ExpansionButton*
                                GetButton( );
                                // ----------------------------------------------------------------------------------
                                /*! @fn GetButtonManager( );
-                                *
-                                * @return
+                                *      @brief This method returns the manager of the buttons.
+                                *      @return
                                 */
                                ButtonManager*
                                GetButtonManager( );
                                // ----------------------------------------------------------------------------------
                                /*! @fn SetButtonID( long id );
-                                *
+                                *      @brief This method sets the ID of the expansion button.
                                 * @param id
                                 */
                                void
                                SetButtonID( long id );
                                // ----------------------------------------------------------------------------------
                                /*! @fn SetButton( ExpansionButton* button );
-                                *
+                                *      @brief This method sets the expansion button.
                                 * @param button
                                 */
                                void
                                SetButton( ExpansionButton* button );
                                // ----------------------------------------------------------------------------------
                                /*! @fn SetButtonManager( ButtonManager* manager );
-                                *
-                                * @param manager
+                                *      @brief This method Sets the ButtonManager
+                                * @param manager A pointer with the manager.
                                 */
                                void
                                SetButtonManager( ButtonManager* manager );
                                // ----------------------------------------------------------------------------------
                                /*! @fn HideSubPanel( bool hide );
-                                *
-                                * @param hide
+                                *      @brief This method hides the subPanel (Hides the buttons).
+                                * @param hide True if you need to hide the buttons.
                                 */
                                void
                                HideSubPanel( bool hide );
 
                        private:
-                               long m_IDExpButton;
-                               ExpansionButton* m_ExpansionButton;
-                               ButtonManager* m_ButtonManager;
+                               long m_IDExpButton; //!<ID of "+""-" expansion button.
+                               ExpansionButton* m_ExpansionButton; //!<The expansion button.
+                               ButtonManager* m_ButtonManager; //!<The button manager.
                };
        }//ecapseman
 }//ecapseman