diff options
Diffstat (limited to 'examples/Simple/chat/Receiver_i.h')
-rw-r--r-- | examples/Simple/chat/Receiver_i.h | 61 |
1 files changed, 31 insertions, 30 deletions
diff --git a/examples/Simple/chat/Receiver_i.h b/examples/Simple/chat/Receiver_i.h index 5b07f53e877..9f0bde342c4 100644 --- a/examples/Simple/chat/Receiver_i.h +++ b/examples/Simple/chat/Receiver_i.h @@ -1,56 +1,57 @@ /* -*- C++ -*- */ -// $Id$ - -// =========================================================== -// -// = LIBRARY -// TAO/tests/Simple/chat -// -// = FILENAME -// Receiver_i.h -// -// = DESCRIPTION -// Defines the implementation header for the Receiver interface. -// -// = AUTHOR -// Pradeep Gore <pradeep@cs.wustl.edu> -// -// =========================================================== + +//============================================================================= +/** + * @file Receiver_i.h + * + * $Id$ + * + * Defines the implementation header for the Receiver interface. + * + * + * @author Pradeep Gore <pradeep@cs.wustl.edu> + */ +//============================================================================= + #ifndef RECEIVER_I_H #define RECEIVER_I_H #include "ReceiverS.h" +/** + * @class Receiver_i + * + * @brief Receiver object implementation + * + * This class has methods that are called by the chat server. + */ class Receiver_i : public POA_Receiver { - // = TITLE - // Receiver object implementation - // - // = DESCRIPTION - // This class has methods that are called by the chat server. public: // = Initialization and termination methods. + /// Constructor. Receiver_i (void); - // Constructor. + /// Destructor. virtual ~Receiver_i (void); - // Destructor. + /// Receives a message string. virtual void message (const char *msg); - // Receives a message string. + /** + * Called when the chat server is going away. The client + * implementation should shutdown the chat client in response to + * this. + */ virtual void shutdown (void); - // Called when the chat server is going away. The client - // implementation should shutdown the chat client in response to - // this. + /// Set the ORB pointer. void orb (CORBA::ORB_ptr o); - // Set the ORB pointer. private: + /// ORB pointer. CORBA::ORB_var orb_; - // ORB pointer. }; #endif /* RECEIVER_I_H */ |