creaButtonContainer & creaPanelButtonContainer: Updates in doxygen documentation...

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

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/button.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/button.h
index 67d2861a2b35be8d5f1aeed49ce3b99a101b97ea..8462034bb47f89adbd9101b805239988d740191d 100644 (file)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/button.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/button.h
@@ -2,7 +2,7 @@
  * @file button.h
  * @brief Contains the Button class.
  * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date  2011-05-24
+ * @date  2011-06-02
  */
 
 #ifndef BUTTON_H
@@ -11,10 +11,7 @@
 #include <wx/bmpbuttn.h>
 #include <wx/image.h>
 #include <wx/string.h>
-#include <string>
-#include <iostream>
-#include <exception>
-#include "functor.h"
+
 #include "system.h"
 
 /*!    @namespace <creaButtonContainer>
@@ -37,6 +34,7 @@ namespace creaButtonContainer
                {
                        public:
                                //typedef definition
+                               // ----------------------------------------------------------------------------------
                                /*!     @typedef creaButtonContainer::model::TFunctor TFunctor;
                                 *      @brief Defines the TFunctor type.
                                 */
@@ -70,21 +68,21 @@ namespace creaButtonContainer
                                 *      @brief This method returns the name of the button.
                                 *      @return std::string The name of the button.
                                 */
-                               std::string
+                               StringType
                                GetButtonName( );
                                // ----------------------------------------------------------------------------------
                                /*! @fn std::string Button::GetIconPath( );
                                 *      @brief This method returns the iconPath of the button.
                                 *      @return std::string The path of the icon.
                                 */
-                               std::string
+                               StringType
                                GetIconPath( );
                                // ----------------------------------------------------------------------------------
                                /*! @fn std::string Button::GetDescription( );
                                 *      @brief This method returns a the description of the button.
                                 *      @return std::string The tooltip of the button.
                                 */
-                               std::string
+                               StringType
                                GetDescription( );
                                // ----------------------------------------------------------------------------------
                                /*! @fn void Button::Execute( );
@@ -98,7 +96,7 @@ namespace creaButtonContainer
                                Execute( );
                                // ----------------------------------------------------------------------------------
                        private:
-                               ButtonPair* m_ButtonPair; //! <ButtonPair* ButtonPair pointer.
+                               ButtonPair* m_ButtonPair; //! <The pair with the button information.
                };
        }//ecapseman
 }//ecapseman