X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=lib%2FmaracasVisuLib%2Fsrc%2Finterface%2FwxWindows%2Fwidgets%2FcreaButtonContainer%2Fmodel%2FbuttonGroupFactory.h;h=246a6f2b1c88f859e2faea5165d5671e60162f79;hb=f6c7b458a17b67950d1844d6a600683a99cb2b6d;hp=1dd7389f2dbe798d2e246d0bcf2e416cd1edbfa2;hpb=4b092ee0b1bcda4d298e5ffc3b58b599e273db20;p=creaMaracasVisu.git

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 1dd7389..246a6f2 100644
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/buttonGroupFactory.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/buttonGroupFactory.h
@@ -1,11 +1,9 @@
-/***************************************************************
- * Name:      @file ButtonGroupFactory.h
- * Purpose:   @brief This contains ButtonGroupFactory Class
- * Author:    @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * Modified:  2011-05-09
- * Copyright: Diego CACERES (http://www.creatis.insa-lyon.fr/~caceres/)
- * 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
@@ -13,6 +11,8 @@
 #include <wx/window.h>
 #include <list>
 #include <map>
+#include <iostream>
+#include <exception>
 
 #include "system.h"
 #include "button.h"
@@ -20,50 +20,81 @@
 #include "containerSettings.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
 	{
-		//typedef
-		typedef creaButtonContainer::view::Button Button;
-		typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
-		typedef creaButtonContainer::model::ContainerSettings ButtonGroupModel;
-		typedef std::list< ButtonGroup* > ButtonGroupContainer;
-		typedef std::map< long, Button* > ButtonContainer;
-		/// @class ButtonGroupFactory
-		/// @brief This class is the factory of a group of wxButtons
+
+		/*! @class ButtonGroupFactory buttonGroupFactory.h "buttonGroupFactory.h"
+		 *	@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
 		{
 			public:
-				//Constructors:
-				/*!
-				 * @brief This is the default constructor.
+				//typedef definition
+				/*!	@typedef creaButtonContainer::view::Button Button;
+				 *	@brief Defines the Button type.
+				 */
+				typedef creaButtonContainer::view::Button Button;
+				// ----------------------------------------------------------------------------------
+				/*!	@typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
+				 *	@brief Defines the ButtonGroup type.
+				 */
+				typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
+				// ----------------------------------------------------------------------------------
+				/*!	@typedef creaButtonContainer::model::ContainerSettings ButtonGroupModel;
+				 *	@brief Defines the ButtonGroupModel type.
+				 */
+				typedef creaButtonContainer::model::ContainerSettings ButtonGroupModel;
+				// ----------------------------------------------------------------------------------
+				/*!	@typedef std::list< ButtonGroup* > ButtonGroupContainer;
+				 *	@brief Defines the ButtonGroupContainer type.
+				 */
+				typedef std::list< ButtonGroup* > ButtonGroupContainer;
+				// ----------------------------------------------------------------------------------
+				/*!	@typedef std::map< long, Button* > ButtonContainer;
+				 *	@brief Defines the ButtonContainer type.
+				 */
+				typedef std::map< long, Button* > ButtonContainer;
+				// ----------------------------------------------------------------------------------
+				//end of typedef definition
+			public:
+				/*!	@fn ButtonGroupFactory::ButtonGroupFactory( );
+				 *	@brief This is the default constructor.
 				 */
 				ButtonGroupFactory( );
-				//Destructors:
-				/*!
-				 * @brief this is the destructor.
+				// -------------------------------------------------------------------------------
+				/*!	@fn virtual ButtonGroupFactory::~ButtonGroupFactory( );
+				 *	@brief This is the destructor.
 				 */
 				virtual
 				~ButtonGroupFactory( );
-				//Functions:
-				/*!
+				/*! @fn ButtonGroupContainer ButtonGroupFactory::CreateButtonGroupContainer( wxWindow* parent, ButtonGroupModel* settings );
 				 * @brief This function allows to create the ButtonGroupContainer.
-				 * @param the wxWindow* parent to be attached.
-				 * @param The Container settings.
-				 * @return The wx button group container.
+				 * @param parent the wxWindow* parent to be attached.
+				 * @param settings The Container settings.
+				 * @exception std::bad_alloc
+				 * @return ButtonGroupContainer The wx button group container.
 				 */
 				ButtonGroupContainer
 				CreateButtonGroupContainer( wxWindow* parent,
 				    ButtonGroupModel* settings );
 			private:
-				/*!
-				 * @brief This function allows to create a wx button container for a group.
-				 * @param the wxWindow* parent to be attached.
-				 * @param The button list with its own information.
-				 * @return The wx button container.
+				/*! @fn ButtonContainer ButtonGroupFactory::GetButtons( wxWindow* parent, ButtonList buttonModel );
+				 * @brief  This function allows to create a wx button container for a group.
+				 * @param parent the wxWindow* parent to be attached.
+				 * @param buttonModel The button list with its own information.
+				 * @exception std::bad_alloc
+				 * @return ButtonContainer The wx button container.
 				 */
 				ButtonContainer
 				GetButtons( wxWindow* parent, ButtonList buttonModel );