Error management -- Default attribute validator

[modules/shaper.git] / src / Config / Config_PointerMessage.h

diff --git a/src/Config/Config_PointerMessage.h b/src/Config/Config_PointerMessage.h
index 0e3c726caa094e05e0392032a357952e35b2fafb..872c4365509effdc6d0ae624337860874c6f77e4 100644 (file)
--- a/src/Config/Config_PointerMessage.h
+++ b/src/Config/Config_PointerMessage.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 /*
  * Config_PointerMessage.h
  *
@@ -11,20 +13,25 @@
 #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 Events_Message
+class CONFIG_EXPORT Config_PointerMessage : public Events_Message
 {
-public:
+ 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_ */