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=b12cfb5edcbfa7554b8253b88ea94dc5dd1b8dd8;hb=de7a931d43b373fdbaba530ae326a64d45148ae9;hp=61609108ec49e8fa87286dc1068a1df743915e8d;hpb=ae196719490130990cdde501c982c3370b46b21c;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 6160910..b12cfb5 100644
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/buttonGroupFactory.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/buttonGroupFactory.h
@@ -1,49 +1,40 @@
-/************************************************************************************//*!
- * Name:      @file buttonGroupFactory.h
- * Purpose:   @brief This contains ButtonGroupFactory class
- * Author:    @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * Modified:  2011-05-17
- * Copyright:
- * License:
- ***************************************************************************************/
+/*!
+ * @file buttonGroupFactory.h
+ * @brief Contains ButtonGroupFactory class
+ * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
+ * @date  2011-05-24
+ */
 
 #ifndef BUTTONGROUPFACTORY_H
 #define BUTTONGROUPFACTORY_H
 
-//! @include <wx/window.h>
 #include <wx/window.h>
-//! @include <list>
 #include <list>
-//! @include <map>
 #include <map>
-//! @include <iostream>
 #include <iostream>
-//! @include <exception>
 #include <exception>
 
-//! @include "system.h"
 #include "system.h"
-//! @include "button.h"
 #include "button.h"
-//! @include "buttonGroup.h"
 #include "buttonGroup.h"
-//! @include "containerSettings.h"
 #include "containerSettings.h"
-//! @include "functor.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
 	{
-		//! @class ButtonGroupFactory
-		//! @brief This class is the factory of a group of wxButtons.
-
 		/*! @class ButtonGroupFactory buttonGroupFactory.h "buttonGroupFactory.h"
-		 *	@brief This class contains the ButtonContainer factory.
-		 *  This class describes the factory of the ButtonContainer using design patterns.
+		 *	@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
 		{
@@ -74,19 +65,20 @@ namespace creaButtonContainer
 				 */
 				typedef std::map< long, Button* > ButtonContainer;
 				// ----------------------------------------------------------------------------------
+				//end of typedef definition
 			public:
-				/*!	@fn ButtonGroupFactory::ButtonGroupFactory( )
+				/*!	@fn ButtonGroupFactory::ButtonGroupFactory( );
 				 *	@brief This is the default constructor.
 				 */
 				ButtonGroupFactory( );
 				// -------------------------------------------------------------------------------
-				/*!	@fn virtual ButtonGroupFactory::~ButtonGroupFactory( )
+				/*!	@fn virtual ButtonGroupFactory::~ButtonGroupFactory( );
 				 *	@brief This is the destructor.
 				 */
 				virtual
 				~ButtonGroupFactory( );
 				/*! @fn ButtonGroupContainer ButtonGroupFactory::CreateButtonGroupContainer( wxWindow* parent, ButtonGroupModel* settings );
-				 * @brief This function allows to create the ButtonGroupContainer.
+				 * @brief This method allows to create the ButtonGroupContainer.
 				 * @param parent the wxWindow* parent to be attached.
 				 * @param settings The Container settings.
 				 * @exception std::bad_alloc
@@ -97,7 +89,7 @@ namespace creaButtonContainer
 				    ButtonGroupModel* settings );
 			private:
 				/*! @fn ButtonContainer ButtonGroupFactory::GetButtons( wxWindow* parent, ButtonList buttonModel );
-				 * @brief  This function allows to create a wx button container for a group.
+				 * @brief  This method 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