From c1b7d6e874f1bfcac251e852ae37229c12c61656 Mon Sep 17 00:00:00 2001 From: Diego Caceres Date: Fri, 20 May 2011 15:43:42 +0000 Subject: [PATCH] creaButtonContainer: doxygen 90% --- .../model/buttonGroupFactory.cxx | 2 +- .../model/buttonGroupFactory.h | 2 +- .../model/containerSettings.cxx | 2 +- .../model/containerSettings.h | 2 +- .../creaButtonContainer/model/functor.h | 2 +- .../creaButtonContainer/model/system.h | 2 +- .../creaButtonContainer/view/button.cxx | 2 +- .../widgets/creaButtonContainer/view/button.h | 2 +- .../view/buttonContainerPanel.cxx | 2 +- .../view/buttonContainerPanel.h | 74 +++++++++++-------- .../creaButtonContainer/view/buttonGroup.cxx | 2 +- .../creaButtonContainer/view/buttonGroup.h | 43 ++++++----- .../view/buttonManager.cxx | 2 +- .../creaButtonContainer/view/buttonManager.h | 41 ++++++---- .../creaButtonContainer/view/groupManager.cxx | 2 +- .../creaButtonContainer/view/groupManager.h | 48 ++++++------ 16 files changed, 131 insertions(+), 99 deletions(-) diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/buttonGroupFactory.cxx b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/buttonGroupFactory.cxx index 9a76e9b..62287f3 100644 --- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/buttonGroupFactory.cxx +++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/buttonGroupFactory.cxx @@ -1,6 +1,6 @@ /*! * @file buttonGroupFactory.cxx - * @brief This contains the ButtonGroupFactory class implementation. + * @brief Implements the ButtonGroupFactory class. * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr) * @date 2011-05-19 */ 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 246a6f2..e9825bb 100644 --- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/buttonGroupFactory.h +++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/buttonGroupFactory.h @@ -1,6 +1,6 @@ /*! * @file buttonGroupFactory.h - * @brief This contains ButtonGroupFactory class + * @brief Contains ButtonGroupFactory class * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr) * @date 2011-05-19 */ diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/containerSettings.cxx b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/containerSettings.cxx index e6437ae..188d089 100644 --- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/containerSettings.cxx +++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/containerSettings.cxx @@ -1,6 +1,6 @@ /*! * @file containerSettings.cxx - * @brief This contains the ContainerSettings class implementation + * @brief Implements the ContainerSettings class. * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr) * @date 2011-05-19 */ 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 6362f14..4e259b0 100644 --- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/containerSettings.h +++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/containerSettings.h @@ -1,6 +1,6 @@ /*! * @file containerSettings.h - * @brief This contains the ContainerSettings class + * @brief Contains the ContainerSettings class * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr) * @date 2011-05-19 */ 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 8489cea..aab0713 100644 --- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/functor.h +++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/functor.h @@ -1,6 +1,6 @@ /*! * @file functor.h - * @brief defines TFunctor class + * @brief Defines TFunctor class * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr) * @date 2011-05-19 */ diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/system.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/system.h index 94a2cd3..6aea190 100644 --- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/system.h +++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/system.h @@ -1,6 +1,6 @@ /*! * @file system.h - * @brief contains a system typedefs used to reuse code. + * @brief Contains a system typedefs used to reuse code. * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr) * @date 2011-05-19 */ diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/button.cxx b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/button.cxx index 1edce54..8f65b03 100644 --- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/button.cxx +++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/button.cxx @@ -1,6 +1,6 @@ /*! * @file button.cxx - * @brief This contains the Button class implementation. + * @brief Implements the Button class implementation. * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr) * @date 2011-05-19 */ 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 7d83a71..0bcf6ae 100644 --- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/button.h +++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/button.h @@ -1,6 +1,6 @@ /*! * @file button.h - * @brief This contains the Button class. + * @brief Contains the Button class. * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr) * @date 2011-05-19 */ diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonContainerPanel.cxx b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonContainerPanel.cxx index 8640038..eb7acca 100644 --- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonContainerPanel.cxx +++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonContainerPanel.cxx @@ -1,6 +1,6 @@ /*! * @file buttonGroup.cxx - * @brief This contains the ButtonGroup class implementation + * @brief Implements the ButtonGroup class. * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr) * @date 2011-05-19 */ diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonContainerPanel.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonContainerPanel.h index 65f3db3..c65c693 100644 --- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonContainerPanel.h +++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonContainerPanel.h @@ -46,79 +46,95 @@ namespace creaButtonContainer */ namespace view { + /*! @class ButtonContainerController buttonContainerController.h "buttonContainerController.h" + * @brief This class contains the ButtonContainerPanel controller. + * @details This class describes the button events, it derives from wxEvtHandler and it is the + * controller in the MVC. + * @see wxScrolledWindow + */ class ButtonContainerPanel : public wxScrolledWindow { public: //typedef definition - /*! @typedef creaButtonContainer::model::TFunctor TFunctor; - * @brief Defines the TFunctor type. + // ---------------------------------------------------------------------------------- + /*! @typedef creaButtonContainer::view::ButtonGroup ButtonGroup; + * @brief Defines the ButtonGroup type. */ typedef creaButtonContainer::view::ButtonGroup ButtonGroup; - /*! @typedef creaButtonContainer::model::TFunctor TFunctor; - * @brief Defines the TFunctor type. + // ---------------------------------------------------------------------------------- + /*! @typedef creaButtonContainer::view::GroupManager GroupManager; + * @brief Defines the GroupManager type. */ typedef creaButtonContainer::view::GroupManager GroupManager; - /*! @typedef creaButtonContainer::model::TFunctor TFunctor; - * @brief Defines the TFunctor type. + // ---------------------------------------------------------------------------------- + /*! @typedef std::list< ButtonGroup* > ButtonGroupList; + * @brief Defines the ButtonGroupList type. */ typedef std::list< ButtonGroup* > ButtonGroupList; - /*! @typedef creaButtonContainer::model::TFunctor TFunctor; - * @brief Defines the TFunctor type. + // ---------------------------------------------------------------------------------- + /*! @typedef std::map< long, GroupManager* > GroupManagerList; + * @brief Defines the GroupManagerList type. */ typedef std::map< long, GroupManager* > GroupManagerList; - /*! @typedef creaButtonContainer::model::TFunctor TFunctor; - * @brief Defines the TFunctor type. + // ---------------------------------------------------------------------------------- + /*! @typedef wxFlexGridSizer Sizer; + * @brief Defines the Sizer type. */ typedef wxFlexGridSizer Sizer; - /*! @typedef creaButtonContainer::model::TFunctor TFunctor; - * @brief Defines the TFunctor type. + // ---------------------------------------------------------------------------------- + /*! @typedef std::list< long > KeyList; + * @brief Defines the KeyList type. */ typedef std::list< long > KeyList; - /*! @typedef creaButtonContainer::model::TFunctor TFunctor; - * @brief Defines the TFunctor type. + // ---------------------------------------------------------------------------------- + /*! @typedef creaButtonContainer::model::ContainerSettings ButtonGroupSettings; + * @brief Defines the ButtonGroupSettings type. */ typedef creaButtonContainer::model::ContainerSettings ButtonGroupSettings; - /*! @typedef creaButtonContainer::model::TFunctor TFunctor; - * @brief Defines the TFunctor type. + // ---------------------------------------------------------------------------------- + /*! @typedef creaButtonContainer::model::ButtonGroupFactory ButtonGroupFactory; + * @brief Defines the ButtonGroupFactory type. */ typedef creaButtonContainer::model::ButtonGroupFactory ButtonGroupFactory; - /*! @typedef creaButtonContainer::model::TFunctor TFunctor; - * @brief Defines the TFunctor type. + // ---------------------------------------------------------------------------------- + /*! creaButtonContainer::controller::ButtonContainerController BCController; + * @brief Defines the BCController type. */ typedef creaButtonContainer::controller::ButtonContainerController BCController; + // ---------------------------------------------------------------------------------- //end of typedef definition public: /*! @fn ButtonContainerPanel( wxWindow* parent, ButtonGroupSettings* settings ); - * - * @param parent - * @param settings + * @brief This is the parameterized constructor. + * @param parent wxWindow pointer to parent. + * @param settings ButtonGroupSettings Pointer to button container settings. */ ButtonContainerPanel( wxWindow* parent, ButtonGroupSettings* settings ); // ---------------------------------------------------------------------------------- /*! @fn ~ButtonContainerPanel( ); - * + * @brief This is the destructor. */ virtual ~ButtonContainerPanel( ); // ---------------------------------------------------------------------------------- /*! @fn SetGroupContainer( ButtonGroupList groupContainer ); - * + * @brief This function sets the settings to the container. * @param groupContainer */ void SetGroupContainer( ButtonGroupList groupContainer ); // ---------------------------------------------------------------------------------- /*! @fn PanelInit( ); - * + * This function initializes the panel. */ void PanelInit( ); // ---------------------------------------------------------------------------------- /*! @fn FitSizer( ); - * + * This function fits and organizes the sizer. */ void FitSizer( ); @@ -126,10 +142,10 @@ namespace creaButtonContainer public: friend class creaButtonContainer::controller::ButtonContainerController; private: - GroupManagerList m_GroupManagerList; - ButtonGroupList m_ButtonGroupList; - BCController* m_ButtonCController; - Sizer* m_Sizer; + GroupManagerList m_GroupManagerList; //! ButtonContainer; + * @brief Defines the ButtonContainer type. */ typedef std::map< long, Button* > ButtonContainer; - /*! @typedef creaButtonContainer::model::TFunctor TFunctor; - * @brief Defines the TFunctor type. + // ---------------------------------------------------------------------------------- + /*! typedef std::list< long > IdButtonContainer; + * @brief Defines the IdButtonContainer type. */ typedef std::list< long > IdButtonContainer; public: // ---------------------------------------------------------------------------------- /*! @fn ButtonGroup( wxStaticText* groupName, ButtonContainer buttons ); - * - * @param groupName - * @param buttons + * @brief This is the parameterized constructor. + * @param groupName wxStatigText* with the name of the group. + * @param buttons A container with buttons. */ ButtonGroup( wxStaticText* groupName, ButtonContainer buttons ); // ---------------------------------------------------------------------------------- /*! @fn ~ButtonGroup( ); - * + * @brief This is the destructor. */ virtual ~ButtonGroup( ); // ---------------------------------------------------------------------------------- /*! @fn GetButton( long id ); - * - * @param id - * @return + * @brief This method returns a Button* + * @param id The ID of the button. + * @return Button* */ Button* GetButton( long id ); // ---------------------------------------------------------------------------------- /*! @fn GetButtonContainer( ); - * - * @return + * @brief This method returns the button container. + * @return ButtonContainer. */ ButtonContainer GetButtonContainer( ); // ---------------------------------------------------------------------------------- /*! @fn GetButtonIdContainer( ); - * + * @brief This method returns a list of button IDs. * @return */ IdButtonContainer GetButtonIdContainer( ); // ---------------------------------------------------------------------------------- /*! @fn GetGroupName( ); - * + * @brief This method returns the name of the group. * @return */ wxStaticText* GetGroupName( ); // ---------------------------------------------------------------------------------- private: - wxStaticText* m_GroupName; - ButtonContainer m_Buttons; + wxStaticText* m_GroupName; //!wxFlexGridSizer + */ class ButtonManager : public wxFlexGridSizer { public: //typedef definition. - /*! @typedef creaButtonContainer::model::TFunctor TFunctor; - * @brief Defines the TFunctor type. + /*! @typedef creaButtonContainer::view::Button Button; + * @brief Defines the Button type. */ typedef creaButtonContainer::view::Button Button; - /*! @typedef creaButtonContainer::model::TFunctor TFunctor; - * @brief Defines the TFunctor type. + // ---------------------------------------------------------------------------------- + /*! @typedef creaButtonContainer::view::ButtonGroup ButtonGroup; + * @brief Defines the ButtonGroup type. */ typedef creaButtonContainer::view::ButtonGroup ButtonGroup; - /*! @typedef creaButtonContainer::model::TFunctor TFunctor; - * @brief Defines the TFunctor type. + // ---------------------------------------------------------------------------------- + /*! @typedef std::map< long, Button* > ButtonContainer; + * @brief Defines the ButtonContainer type. */ typedef std::map< long, Button* > ButtonContainer; + // ---------------------------------------------------------------------------------- //end of typedef definition. public: // ---------------------------------------------------------------------------------- /*! @fn ButtonManager( ); - * + * @brief This is the default construuctor. */ ButtonManager( ); // ---------------------------------------------------------------------------------- /*! @fn ButtonManager( ButtonGroup* buttonGroup ); - * - * @param buttonGroup + * @brief This is the parameterized constructor + * @param buttonGroup The group of buttons. */ ButtonManager( ButtonGroup* buttonGroup ); // ---------------------------------------------------------------------------------- /*! @fn ~ButtonManager( ); - * + * @brief This is the destructor. */ virtual ~ButtonManager( ); // ---------------------------------------------------------------------------------- /*! @fn SetGroupName( wxStaticText* groupName ); - * + * @details Sets the groupName. * @param groupName */ void SetGroupName( wxStaticText* groupName ); // ---------------------------------------------------------------------------------- /*! @fn ShowButtonManager( ); - * + * @brief This function shows the ButtonManager */ void ShowButtonManager( ); // ---------------------------------------------------------------------------------- /*! @fn HideButtonManager( ); - * + * @brief This function hides the ButtonManager. */ void HideButtonManager( ); @@ -85,15 +94,15 @@ namespace creaButtonContainer private: // ---------------------------------------------------------------------------------- /*! @fn SetButtonManager( ButtonContainer buttonContainer ); - * + * @brief This function set the buttons and it is private. * @param buttonContainer */ void SetButtonManager( ButtonContainer buttonContainer ); // ---------------------------------------------------------------------------------- private: - wxStaticText* m_GroupName; - wxGridSizer* m_GridSizer; + wxStaticText* m_GroupName; //!