Add/correct description for writereplayline().

1 files changed, 7 insertions, 0 deletions

diff --git a/replay.h b/replay.h
index d2d2c6d..de0f3de 100644
--- a/replay.h
+++ b/replay.h
@@ -58,6 +58,13 @@ int doreplaytime(int sourcefd, int replayseconds, struct client *clients, struct
 // Returns 1 for success or 0 for failure.
 int doreplaylastspoke(int sourcefd, long linenumber, struct client *clients, struct settings *settings, struct ircdstate *ircdstate, struct channel *channels);
 
+// Write the line 'str' to the replay log file after prepending it with
+// the current unixtime timestamp.  'basedir' is the directory in which
+// to write to 'replay.log'.
+// Expects a string in the format:
+// :from!bar@baz PRIVMSG to :hello world
+// With the ":foo!bar@baz "prefix being important.
+// Returns the number of bytes written on success, or 0 on failure.
 int writereplayline(char *str, char *basedir);
 
 #endif