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

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

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonManager.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonManager.h
index 848204c3885030e9a6bfdcfc1e707b6956f99823..2a61580d5a2e025006d6cb3b570341b3c2ab7cb2 100644 (file)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonManager.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonManager.h
@@ -1,11 +1,9 @@
-/***************************************************************
- * Name:      ButtonManager.h
- * Purpose:   Defines the button group container
- * 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 buttonManager.h
+ * @brief This contains the ButtonManager class.
+ * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
+ * @date  2011-05-19
+ */
 
 #ifndef CARTOBUTTONCONTAINER_H
 #define CARTOBUTTONCONTAINER_H
@@ -18,33 +16,81 @@
 #include "button.h"
 #include "buttonGroup.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:
-                **/
                class ButtonManager : public wxFlexGridSizer
                {
                        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 creaButtonContainer::view::ButtonGroup ButtonGroup;
+                               /*!     @typedef creaButtonContainer::model::TFunctor TFunctor;
+                                *      @brief Defines the TFunctor type.
+                                */
                                typedef std::map< long, Button* > ButtonContainer;
+                               //end of typedef definition.
                        public:
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn ButtonManager( );
+                                *
+                                */
                                ButtonManager( );
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn ButtonManager( ButtonGroup* buttonGroup );
+                                *
+                                * @param buttonGroup
+                                */
                                ButtonManager( ButtonGroup* buttonGroup );
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn ~ButtonManager( );
+                                *
+                                */
                                virtual
                                ~ButtonManager( );
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn SetGroupName( wxStaticText* groupName );
+                                *
+                                * @param groupName
+                                */
                                void
                                SetGroupName( wxStaticText* groupName );
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn ShowButtonManager( );
+                                *
+                                */
                                void
                                ShowButtonManager( );
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn HideButtonManager( );
+                                *
+                                */
                                void
                                HideButtonManager( );
+                               // ----------------------------------------------------------------------------------
                        private:
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn SetButtonManager( ButtonContainer buttonContainer );
+                                *
+                                * @param buttonContainer
+                                */
                                void
                                SetButtonManager( ButtonContainer buttonContainer );
+                               // ----------------------------------------------------------------------------------
                        private:
                                wxStaticText* m_GroupName;
                                wxGridSizer* m_GridSizer;