Improve Doxygen documentation on zombies. Re-insert documentation of LOG feature.

git-svn-id: file:///home/klmitch/undernet-ircu/undernet-ircu-svn/ircu2/trunk@1295 c9e4aea6-c8fd-4c43-8297-357d70d61c8c

diff --git a/ChangeLog b/ChangeLog
index 07410e6f861016740fb586f0b50ffad5318893d6..960f9fd1313ed5f050dd9ab0a93a03e41758bdd0 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2005-01-08  Michael Poole <mdpoole@troilus.org>
+
+       * ircd/channel.c (@page zombie): Add synopsis to explain what
+       zombies are supposed to do.
+
+       * doc/example.conf (Features): Transfer recommended LOG features
+       from 2.10.11 example.conf.
+
 2005-01-03  Michael Poole <mdpoole@troilus.org>
 
        * ircd/ircd.c (try_connections): Test Connect hold time before

diff --git a/doc/example.conf b/doc/example.conf
index bbd61b9f102d0cb1f52fa23034a4aed7bee0bbf9..ed11308980e02d02f69ef8f8c85cf6179db2a6dd 100644 (file)
--- a/doc/example.conf
+++ b/doc/example.conf
@@ -745,6 +745,11 @@ IAuth {
 #
 features
 {
+# These log features are the only way to get certain error messages
+# (such as when the server dies from being out of memory).  For more
+# explanation of how they work, see doc/readme.log.
+ "LOG" = "SYSTEM" "FILE" "ircd.log";
+ "LOG" = "SYSTEM" "LEVEL" "CRIT";
 #  "DOMAINNAME"="<obtained from /etc/resolv.conf by ./configure>";
 #  "RELIABLE_CLOCK"="FALSE";
 #  "BUFFERPOOL"="27000000";

diff --git a/ircd/channel.c b/ircd/channel.c
index e2a991fb0ca56d20c857a1b82403351eae03f900..a9968dc4a939107627a726f14d3a0428e3bd11cf 100644 (file)
--- a/ircd/channel.c
+++ b/ircd/channel.c
@@ -1399,7 +1399,15 @@ void del_invite(struct Client *cptr, struct Channel *chptr)
     }
 }
 
-/** @page zombie Explaination of Zombies
+/** @page zombie Explanation of Zombies
+ *
+ * Synopsis:
+ *
+ * A channel member is turned into a zombie when he is kicked from a
+ * channel but his server has not acknowledged the kick.  Servers that
+ * see the member as a zombie can accept actions he performed before
+ * being kicked, without allowing chanop operations from outsiders or
+ * desyncing the network.
  *
  * Consider:
  * <pre>