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

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

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/functor.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/functor.h
index 82137738b149ddc1370af261d0dcca4cc1c48f95..8489cea12741ff02e56480ce2b0843fba70ea17f 100644 (file)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/functor.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/functor.h
@@ -1,29 +1,32 @@
-/************************************************************************************//*!
- * Name:      @file functor.h
- * Purpose:   @brief defines TFunctor class
- * Author:    @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * Modified:  2011-05-18
- * Copyright:
- * License:
- ***************************************************************************************/
+/*!
+ * @file functor.h
+ * @brief defines TFunctor class
+ * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
+ * @date  2011-05-19
+ */
 
 #ifndef TFUNCTOR_H_
 #define TFUNCTOR_H_
 
-//! @include <string>
 #include <string>
 
-//!    @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
        {
+               //typedef definition.
                /*!     @typedef std::string ButtonIDType;
                 *      @brief Defines the ButtonIDType type.
                 */
                typedef std::string ButtonIDType;
-
+               //end of typedef definition
                /*! @class TFunctor functor.h "functor.h"
                 *      @brief This is an abstract class for call_back functions.
                 */
@@ -50,12 +53,11 @@ namespace creaButtonContainer
 
                // derived template class
                /*! @tparam <typename TClass>
-                *      @brief It makes TConcreteFunctor usable for all Classes.
+                *      @brief TClass makes TConcreteFunctor usable for all Classes.
                 */
                template< typename TClass >
                        /*! @class TConcreteFunctor: public TFunctor  functor.h "functor.h"
-                        *      @brief This class contains the ButtonContainer factory.
-                        *  This class describes the factory of the ButtonContainer using design patterns.
+                        *      @brief This class allows to make call_back functions.
                         */
                        class TConcreteFunctor : public TFunctor
                        {
@@ -88,7 +90,8 @@ namespace creaButtonContainer
                                        Call( const ButtonIDType &buttonName );
                                        // -------------------------------------------------------------------------------
                                private:
-                                       void (TClass::*fpt)( const ButtonIDType &buttonName ); //! <void (TClass::*fpt) Pointer to member function.
+                                       void
+                                       (TClass::*fpt)( const ButtonIDType &buttonName ); //! <void (TClass::*fpt) Pointer to member function.
                                        TClass* pt2Object; //! <TClass* pointer to object.
                        };