creaButtonContainer & creaPanelButtonContainer: Updates in doxygen documentation...

[creaMaracasVisu.git] / lib / maracasVisuLib / src / interface / wxWindows / widgets / creaPanelButtonContainer / buttonContainerSettings.h

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/buttonContainerSettings.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/buttonContainerSettings.h
index fa94fd1d2342afb5d266d2643d07de944b847918..92391e1b719048c460f5eef967af7a75aede9e43 100644 (file)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/buttonContainerSettings.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/buttonContainerSettings.h
@@ -2,15 +2,16 @@
  * @file buttonContainerSettings.h
  * @brief This contains the ButtonContainerSettings class.
  * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date  2011-05-24
+ * @date  2011-06-02
  */
 
 #ifndef BUTTONCONTAINERSETTINGS_H_
 #define BUTTONCONTAINERSETTINGS_H_
 
+#include <wx/panel.h>
+
 #include <list>
 #include <map>
-#include <wx/panel.h>
 #include <vector>
 #include <iostream>
 
@@ -30,6 +31,12 @@ namespace creaPanelButtonContainer
        {
                public:
                        //typedef definition.
+                       // ----------------------------------------------------------------------------------
+                       /*!     @typedef std::string* StringType;
+                        *      @brief Defines the StringType type.
+                        */
+                       typedef std::string StringType;
+                       // ----------------------------------------------------------------------------------
                        /*!     typedef creaButtonContainer::model::TFunctor TFunctor;
                         *      @brief Defines the TFunctor type.
                         */
@@ -124,7 +131,7 @@ namespace creaPanelButtonContainer
                        // ----------------------------------------------------------------------------------
                        /*! @fn ButtonGroupSettings* GetButtonGroupSettings( TFunctor* functor );
                         *      @brief this method return the settings the generic settings for creaButtonContainer.
-                        * @param functor
+                        * @param functor The function to be called in the action button.
                         * @exception std::bad_alloc
                         * @return
                         */
@@ -149,11 +156,11 @@ namespace creaPanelButtonContainer
                         const std::string &iconpath, const std::string &buttonDescription,
                         PanelButton panel );
                         * @brief This method adds a new button into a group of buttons.
-                        * @param groupName
-                        * @param buttonName
-                        * @param iconpath
-                        * @param buttonDescription
-                        * @param panel
+                        * @param groupName The button groupName
+                        * @param buttonName The buttonName
+                        * @param iconpath The path of the icon
+                        * @param buttonDescription The button tooltip
+                        * @param panel The panel to be called when the button is clicked
                         * @exception std::bad_alloc
                         */
                        void
@@ -163,7 +170,7 @@ namespace creaPanelButtonContainer
                        // ----------------------------------------------------------------------------------
                        /*! @fn void AddButton( BCPSettingsStruct* info );
                         * @brief This method adds a new button into a group of buttons.
-                        * @param info
+                        * @param info The pointer to BCPSettingsStruct.
                         * @exception std::bad_alloc
                         */
                        void
@@ -171,7 +178,7 @@ namespace creaPanelButtonContainer
                        // ----------------------------------------------------------------------------------
                        /*! @fn void AddButtons( BCStructVectorType infoList );
                         * @brief This method adds new buttons into the container.
-                        * @param infoList
+                        * @param infoList The BCStructVectorType
                         * @exception std::bad_alloc
                         */
                        void