Add a comment on why topic change handlers return int.

src/hash.c (SetChannelTopic): Add the comment.

diff --git a/src/hash.c b/src/hash.c
index 5cb7b0c754459400ed0bd17d16a8ceb41d288cc6..a4dd6fb6fbc0b7ddfffbae5af600231cf0bd2f9b 100644 (file)
--- a/src/hash.c
+++ b/src/hash.c
@@ -702,6 +702,10 @@ SetChannelTopic(struct chanNode *channel, struct userNode *user, const char *top
         irc_topic(user, channel, topic);
     } else {
         for (n=0; n<tf_used; n++)
+            /* A topic change handler can return non-zero to indicate
+             * that it has reverted the topic change, and that further
+             * hooks should not be called.
+             */
             if (tf_list[n](user, channel, old_topic))
                 break;
     }