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

[creaMaracasVisu.git] / lib / maracasVisuLib / src / interface / wxWindows / widgets / creaButtonContainer / model / containerSettings.h

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/containerSettings.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/containerSettings.h
index d0680e77a1db91ded83b92ff1b687bf70c11ee8b..6362f14d4cb3b4ce6b29f16360f64f393f7aaec2 100644 (file)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/containerSettings.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/containerSettings.h
@@ -1,46 +1,43 @@
-/************************************************************************************//*!
- * Name:      @file containerSettings.h
- * Purpose:   @brief This contains the ContainerSettings class
- * Author:    @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * Modified:  2011-05-18
- * Copyright:
- * License:
- ***************************************************************************************/
+/*!
+ * @file containerSettings.h
+ * @brief This contains the ContainerSettings class
+ * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
+ * @date  2011-05-19
+ */
 
 #ifndef BUTTONGROUPSETTINGS_H_
 #define BUTTONGROUPSETTINGS_H_
 
-//! @include <list>
 #include <list>
-//! @include <map>
 #include <map>
-//! @include <iostream>
 #include <iostream>
-//! @include "system.h"
 #include "system.h"
-//! @include "functor"
 #include "functor.h"
 
-//!    @namespace <creaButtonContainer>
+/*!    @namespace <creaButtonContainer>
+ *     @brief Contains the creaButtonContainer library included in creaMaracasVisu.
+ */
 namespace creaButtonContainer
 {
-       //!     @namespace <model>
+       /*! @namespace <creaButtonContainer::model>
+        *      @brief Contains the implementation of the model in creaButtonContainer library.
+        *      @see <a href="http://en.wikipedia.org/wiki/Model-view-controller">MVC Software Architecture</a>
+        */
        namespace model
        {
                /*! @class ContainerSettings containerSettings.h "containerSettings.h"
                 *      @brief This class contains the settings of the button container.
-                *  This class describes how to add new buttons to the container.
                 */
                class ContainerSettings
                {
                        public:
                                // ----------------------------------------------------------------------------------
-                               /*! @fn void ContainerSettings::ContainerSettings( )
+                               /*! @fn ContainerSettings::ContainerSettings( )
                                 *      @brief This is the constructor.
                                 */
                                ContainerSettings( );
                                // ----------------------------------------------------------------------------------
-                               /*! @fn ContainerSettings::~ContainerSettings( )
+                               /*! @fn virtual ContainerSettings::~ContainerSettings( )
                                 *      @brief This is the destructor.
                                 */
                                virtual