From d737da9ceccc110ac86d48f7fe17cff70f265cbf Mon Sep 17 00:00:00 2001
From: chatty
Date: Mon, 29 Nov 1993 10:36:29 +0000
Subject: Fixed documentation

---
 comm/Message.cc | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

(limited to 'comm/Message.cc')

diff --git a/comm/Message.cc b/comm/Message.cc
index 54cd771..c116c51 100644
--- a/comm/Message.cc
+++ b/comm/Message.cc
@@ -17,15 +17,14 @@
 #include "Message.h"
 
 /*?class UchMessage
-\typ{UchMessage} is the virtual base class for messages.
-Each subclass must redefine the virtual functions \fun{WriteTo} and \fun{ReadFrom}.
-Messages can be added to buffers and can be retrieved from buffers.
+\typ{UchMessage} is the abstract base class for messages.
+Each subclass must redefine the virtual functions \fun{WriteTo} and \fun{ReadFrom},
+so that messages can be added to and retrieved from buffers.
 ?*/
 
 /*?nodoc?*/
 UchMessage :: UchMessage ()
 {
-	// nothing
 }
 
 /*?nodoc?*/
@@ -38,8 +37,9 @@ This virtual function must write a message into a buffer.
 Usually, the implementation of this function in a derived class starts by calling
 the same function of its base class, because a derived class inherits the fields
 of its base class and adds its own fields.
-Data is usually appended to the buffer by the \fun{UchMsgBuffer::Append} functions or operator <<.
-In class \typ{UchMessage}, this function does nothing.
+Data is usually appended to the buffer by the \fun{UchMsgBuffer::Append}
+functions or \fun{operator $<<$}.
+The default implementation does nothing.
 ?*/
 void
 UchMessage :: WriteTo (UchMsgBuffer&)
@@ -53,8 +53,9 @@ At most \var{len} bytes should be read from the buffer.
 Usually, the implementation of this function in a derived class starts by calling
 the same function of its base class, because a derived class inherits the fields
 of its base class and adds its own fields.
-Data is usually retrieved from the buffer by the \fun{UchMsgBuffer::Get} functions or operator >>.
-In class \typ{UchMessage}, this function does nothing.
+Data is usually retrieved from the buffer by the \fun{UchMsgBuffer::Get}
+functions or \fun{operator $>>$}.
+The default implementation does nothing.
 ?*/
 void
 UchMessage :: ReadFrom (UchMsgBuffer&, lword)
@@ -81,7 +82,7 @@ MyClient :: NewMessage (UchMsgBuffer& buffer, bool ask)
     }
     if (m) {
         buffer.Get (m);
-        m->Activate ();
+        m->Activate (*this);
         return TRUE;
     }
     return FALSE;
@@ -91,8 +92,7 @@ However, this virtual function is only provided as a facility and is not used
 by \uch. Redefining it is not mandatory.
 ?*/
 void
-UchMessage :: Activate ()
+UchMessage :: Activate (UchMsgStream&)
 {
 }
 
-
-- 
cgit v1.1