Changeset 10393

Timestamp:

04/18/11 14:58:16 (14 years ago)

Author:

tbretz

Message:

Added descriptions for the virtual function.

File:

• trunk/FACT++/src/MessageImp.h (modified) (2 diffs)

trunk/FACT++/src/MessageImp.h

@@ -28 +28 @@
     MessageImp(std::ostream &out=std::cout);
 
-    virtual void IndicateStateChange(const Time &time, const std::string &server) { }
+    virtual void IndicateStateChange(const Time &, const std::string &) { }
     void StateChanged(const Time &time, const std::string &server, const std::string &msg, int state);
     virtual int Write(const Time &time, const std::string &txt, int qos=kInfo);
@@ -63 +63 @@
 
 #endif
+
+// ***************************************************************************
+/** @fn MessageImp::IndicateStateChange(const Time &time, const std::string &server)
+
+This function is called to indicate a state change by StateChanged() to
+derived classes.
+
+@param time
+   Time at which the state change happened
+
+@param server
+   Server which emitted the state change
+
+**/
+// ***************************************************************************