Commit 1058da5d authored by Joel Rosdahl's avatar Joel Rosdahl
Browse files

Documentation fixes.

parent 2508cec6
2001-09-06 Joel Rosdahl <joel@rosdahl.net>
* vars.el.in (lyskom-personal-message-hook): Fixed documentation.
* messages.el (lyskom-handle-personal-message): Ditto.
* async.el (lyskom-show-personal-message): Ditto.
(lyskom-insert-personal-message): Ditto.
(lyskom-format-as-personal-message): Ditto.
2001-08-31 Ulrik Haugen <qha@lysator.liu.se>
* review.el (kom-review-more): ignore prefix arg unless it's
......
......@@ -447,8 +447,7 @@ according to the value of FLAG."
(defun lyskom-show-personal-message (sender recipient message
&optional when nobeep)
"Insert a personal message into the lyskom buffer.
Args: SENDER: conf-stat for the person issuing the broadcast message or a
string that is the sender.
Args: SENDER: conf-stat for the person sending the message.
RECIPIENT: 0 if this message is for everybody, otherwise the conf-stat
of the recipient.
MESSAGE: A string containing the message.
......@@ -471,8 +470,9 @@ Args: SENDER: conf-stat for the person issuing the broadcast message or a
&optional when nobeep)
"Insert a personal message in the current buffer.
Arguments: SENDER RECIPIENT MESSAGE.
SENDER is a conf-stat (possibly nil) or a string.
RECIPIENT is 0 if the message is public, otherwise the pers-no of the user.
SENDER is a conf-stat (possibly nil).
RECIPIENT is 0 if the message is public, otherwise the conf-stat of the
recipient.
MESSAGE is a string containing the message.
WHEN, if given, is the time when the message arrived. It must be a lyskom
time structure.
......@@ -488,8 +488,9 @@ Non-nil NOBEEP means don't beep."
&optional when nobeep)
"Formats a personal message, returning it as a string.
Arguments: SENDER RECIPIENT MESSAGE.
SENDER is a conf-stat (possibly nil) or a string.
RECIPIENT is 0 if the message is public, otherwise the pers-no of the user.
SENDER is a conf-stat (possibly nil).
RECIPIENT is 0 if the message is public, otherwise the conf-stat of the
recipient.
MESSAGE is a string containing the message.
WHEN, if given, is the time when the message arrived. It must be a lyskom
time structure.
......
......@@ -64,9 +64,9 @@ handlers."
(defun lyskom-handle-personal-message (sender recipient text)
"Handle a personal message.
SENDER is the sender of the message (a conf-stat) RECIPIENT is the
recipient of the message (a conf-stat or zero for common
messages. TEXT is the text of the message."
SENDER is the sender of the message (a conf-stat). RECIPIENT is the
recipient of the message (a conf-stat or 0 for common messages).
TEXT is the text of the message."
(let ((message-type (cond ((eq recipient 0) 'common)
((= (conf-stat->conf-no recipient)
lyskom-pers-no) 'personal)
......
......@@ -2266,10 +2266,10 @@ in any conference other than the person's letterbox."
(def-kom-var lyskom-personal-message-hook nil
"*Hook to run when a personal message is received.
When the hook is run, 'sender' is bound to the pers-stat of the sender
When the hook is run, 'sender' is bound to the conf-stat of the sender
of the message (or possibly nil), 'recipient' is 0 if the message is a
public message and otherwise the pers-no of the user, and 'message' is
a string that holds the message."
public message and otherwise the conf-stat of the recipient, and
'message' is a string that holds the message."
local-hook)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment