Fixes in some comments

[bbtk.git] / packages / wx / src / bbwxColourSelector.h

diff --git a/packages/wx/src/bbwxColourSelector.h b/packages/wx/src/bbwxColourSelector.h
index 84d43187cd8c5fd9b699c1b4db0408245a66d25a..39f186e49164583ac3df4be0d89a75b9a3c16832 100644 (file)
--- a/packages/wx/src/bbwxColourSelector.h
+++ b/packages/wx/src/bbwxColourSelector.h
@@ -3,8 +3,8 @@
   Program:   bbtk
   Module:    $RCSfile: bbwxColourSelector.h,v $
   Language:  C++
-  Date:      $Date: 2008/04/18 12:59:52 $
-  Version:   $Revision: 1.3 $
+  Date:      $Date: 2008/09/10 12:01:47 $
+  Version:   $Revision: 1.6 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -14,8 +14,9 @@
      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
      PURPOSE.  See the above copyright notices for more information.
 
-=========================================================================*//**
- /**
+
+=========================================================================*/
+/**
  * \file 
  * \brief Short description in one line
  * 
@@ -31,10 +32,13 @@
 
 #ifdef _USE_WXWIDGETS_
 
-
+// Prevents multiple inclusions : use symbols of the form
+// __FILENAME_INCLUDED__ 
+// where FILENAME must be replaced by the actual file name
 #ifndef __bbWxColourSelector_h__
 #define __bbWxColourSelector_h__
 
+// Include wxBlackBox definition
 #include "bbtkWxBlackBox.h"
 
 // Namespace of the package "wx" is "bbwx" 
@@ -58,7 +62,6 @@ namespace bbwx
  // private:
  //   wxColourSelector* mColorDialog;
   };
-  //=================================================================
 
   //=================================================================
   // UserBlackBox description
@@ -67,13 +70,11 @@ namespace bbwx
   BBTK_NAME("ColourSelector");
   BBTK_AUTHOR("laurent.guigues@creatis.insa-lyon.fr");
   BBTK_DESCRIPTION("Colour Selector dialog (bbfication of wxColourSelector)");
-  BBTK_OUTPUT(ColourSelector,Out,"The colour selected by the user",std::string,"color");
+  BBTK_OUTPUT(ColourSelector,Out,"Colour choosen in format '[0,1] [0,1] [0,1]'",std::string,"colour");
   BBTK_END_DESCRIBE_BLACK_BOX(ColourSelector);
   //=================================================================
 
-}
-
-//namespace bbtk
-#endif  //__bbtkWxColourSelector_h__
+}//namespace bbtk
+#endif  // __bbtkWxColourSelector_h__
 
 #endif //_USE_WXWIDGETS_