Salome HOME
Porting to SALOME_8.2.0 : Debug visualization selection for AIS_Trihedron axes.
[modules/shaper.git] / src / Config / Config_PointerMessage.h
index e0ac3e44094c5329969604194d2b4e869164f9c2..872c4365509effdc6d0ae624337860874c6f77e4 100644 (file)
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 /*
  * Config_PointerMessage.h
  *
 #ifndef PARTSET_MESSAGE_H_
 #define PARTSET_MESSAGE_H_
 
-#include <Config.h>
-#include <Event_Message.h>
+#include <Config_def.h>
+#include <Events_Message.h>
 
-/*
- * A general class to pass pointers over the event loop.
+/*!
+ * \class Config_PointerMessage
+ * \ingroup Config
+ * \brief A general class to pass pointers over the event loop.
  */
-class CONFIG_EXPORT Config_PointerMessage: public Event_Message
+class CONFIG_EXPORT Config_PointerMessage : public Events_Message
 {
-public:
-  Config_PointerMessage(const Event_ID theId, const void* theParent = 0);
+ public:
+  /// Constructor
+  Config_PointerMessage(const Events_ID theId, const void* theParent = 0);
   virtual ~Config_PointerMessage();
 
+  /// Returns pointer to an object
   void* pointer() const;
+  /// Sets pointer to an object
   void setPointer(void* pointer);
 
-private:
-  void* myPointer;
+ private:
+  void* myPointer; ///< Pointer to an object
 };
 
 #endif /* PARTSET_MESSAGE_H_ */