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

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

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/buttonGroupFactory.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/buttonGroupFactory.h
index cb29a68992c9f285de3fb5d19aafdaa0d3f86347..246a6f2b1c88f859e2faea5165d5671e60162f79 100644 (file)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/buttonGroupFactory.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/buttonGroupFactory.h
@@ -1,47 +1,41 @@
-/************************************************************************************//*!
- * Name:      @file buttonGroupFactory.h
- * Purpose:   @brief This contains ButtonGroupFactory class
- * Author:    @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * Modified:  2011-05-17
- * Copyright:
- * License:
- ***************************************************************************************/
+/*!
+ * @file buttonGroupFactory.h
+ * @brief This contains ButtonGroupFactory class
+ * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
+ * @date  2011-05-19
+ */
 
 #ifndef BUTTONGROUPFACTORY_H
 #define BUTTONGROUPFACTORY_H
 
-//! @include <wx/window.h>
 #include <wx/window.h>
-//! @include <list>
 #include <list>
-//! @include <map>
 #include <map>
-//! @include <iostream>
 #include <iostream>
-//! @include <exception>
 #include <exception>
 
-//! @include "system.h"
 #include "system.h"
-//! @include "button.h"
 #include "button.h"
-//! @include "buttonGroup.h"
 #include "buttonGroup.h"
-//! @include "containerSettings.h"
 #include "containerSettings.h"
-//! @include "functor.h"
 #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 ButtonGroupFactory buttonGroupFactory.h "buttonGroupFactory.h"
-                *      @brief This class contains the ButtonContainer factory.
-                *  This class describes the factory of the ButtonContainer using design patterns.
+                *      @brief This class contains the ButtonGroup factory.
+                *  @details This class creates a container of group of buttons.
+                *  @see <a href="http://en.wikipedia.org/wiki/Factory_method_pattern">Factory Pattern</a>
                 */
                class ButtonGroupFactory
                {
@@ -72,13 +66,14 @@ namespace creaButtonContainer
                                 */
                                typedef std::map< long, Button* > ButtonContainer;
                                // ----------------------------------------------------------------------------------
+                               //end of typedef definition
                        public:
-                               /*!     @fn ButtonGroupFactory::ButtonGroupFactory( )
+                               /*!     @fn ButtonGroupFactory::ButtonGroupFactory( );
                                 *      @brief This is the default constructor.
                                 */
                                ButtonGroupFactory( );
                                // -------------------------------------------------------------------------------
-                               /*!     @fn virtual ButtonGroupFactory::~ButtonGroupFactory( )
+                               /*!     @fn virtual ButtonGroupFactory::~ButtonGroupFactory( );
                                 *      @brief This is the destructor.
                                 */
                                virtual