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

[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 3358cf3d46bae3fa3f02ca58886f31d46c743c46..349a22eee7ab6386693bc3ccf7e2c806559d707b 100644 (file)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/groupManager.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/groupManager.h
@@ -1,11 +1,9 @@
-/***************************************************************
- * Name:      GroupManager.h
- * Purpose:   Defines the Group Manager
- * Author:    Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * Created:   2011-05-09
- * Copyright: Diego CACERES (http://www.creatis.insa-lyon.fr/~caceres/)
- * License:
- **************************************************************/
+/*!
+ * @file groupManager.h
+ * @brief This contains the GroupManager class
+ * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
+ * @date  2011-05-19
+ */
 
 #ifndef GROUPMANAGER_H
 #define GROUPMANAGER_H
@@ -13,40 +11,98 @@
 #include <wx/sizer.h>
 #include <wx/button.h>
 #include <wx/stattext.h>
+#include <wx/event.h>
 #include <list>
+#include <iostream>
 #include "buttonManager.h"
 #include "buttonGroup.h"
 #include <wx/event.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 GroupManager : public wxFlexGridSizer
                {
                        public:
+                               //typedef definition
+                               /*!     @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 wxButton ExpansionButton;
+                               //end of typedef definition.
                        public:
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn GroupManager( wxWindow* parent, ButtonGroup* buttonGroup );
+                                *
+                                * @param parent
+                                * @param buttonGroup
+                                */
                                GroupManager( wxWindow* parent, ButtonGroup* buttonGroup );
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn
+                                * ~GroupManager( );
+                                */
                                virtual
                                ~GroupManager( );
                                //Getters and Setters
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn
+                                *  @return
+                                */
                                long
                                GetButtonID( );
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn GetButton( );
+                                *
+                                * @return
+                                */
                                ExpansionButton*
                                GetButton( );
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn GetButtonManager( );
+                                *
+                                * @return
+                                */
                                ButtonManager*
                                GetButtonManager( );
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn SetButtonID( long id );
+                                *
+                                * @param id
+                                */
                                void
                                SetButtonID( long id );
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn SetButton( ExpansionButton* button );
+                                *
+                                * @param button
+                                */
                                void
                                SetButton( ExpansionButton* button );
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn SetButtonManager( ButtonManager* manager );
+                                *
+                                * @param manager
+                                */
                                void
                                SetButtonManager( ButtonManager* manager );
+                               // ----------------------------------------------------------------------------------
+                               /*! @fn HideSubPanel( bool hide );
+                                *
+                                * @param hide
+                                */
                                void
                                HideSubPanel( bool hide );