Add some missing source code documentation.

[paraslash.git] / afs.c

diff --git a/afs.c b/afs.c
index 9ae0650a2955f6683a94428df47ae2d6c836817e..b8acb53a9ffa2782e8fc0421a9a01f5642347eed 100644 (file)
--- a/afs.c
+++ b/afs.c
@@ -1175,6 +1175,16 @@ int com_check(int fd, int argc, char * const * const argv)
        return 1;
 }
 
+/**
+ * The afs event dispatcher.
+ *
+ * \param event Type of the event.
+ * \param pb May be \p NULL.
+ * \param data Type depends on \a event.
+ *
+ * This function calls the table handlers of all tables and passes \a pb and \a
+ * data verbatim. It's up to the handlers to interpret the \a data pointer.
+ */
 void afs_event(enum afs_events event, struct para_buffer *pb,
                void *data)
 {