lib-login: Add comments to .h file headers explaining what they are doing

diff --git a/src/lib-login/login-client.h b/src/lib-login/login-client.h
index a6b038f0f5d934390c18cd3d22fb4d9335e51a00..345027ef8017d8edbc44e108fa634d97e52a812b 100644 (file)
--- a/src/lib-login/login-client.h
+++ b/src/lib-login/login-client.h
@@ -1,6 +1,10 @@
 #ifndef LOGIN_CLIENT_H
 #define LOGIN_CLIENT_H
 
+/* This login-client API is used by the untrusted pre-login processes (e.g.
+   login-common). It connects to the post-login process (e.g. imap), which uses
+   login-server API to handle the login request. */
+
 #include "net.h"
 
 struct master_service;

diff --git a/src/lib-login/login-server-auth.h b/src/lib-login/login-server-auth.h
index 9939ea93c71b089628fff9e657527eb83132688c..d243aa5c4d6437b3a02dc83e9de35de97b08b7e3 100644 (file)
--- a/src/lib-login/login-server-auth.h
+++ b/src/lib-login/login-server-auth.h
@@ -1,6 +1,10 @@
 #ifndef LOGIN_SERVER_AUTH_H
 #define LOGIN_SERVER_AUTH_H
 
+/* Used for connecting to auth process via auth-master socket and sending
+   REQUEST commands to finish login requests. FIXME: This should be moved
+   to lib-auth/auth-master. */
+
 struct login_request;
 
 typedef void

diff --git a/src/lib-login/login-server.h b/src/lib-login/login-server.h
index bc44dd345526844de336f920ac6bea82bbe46f52..3d459502c95afc68680bc1423449ae01c6253108 100644 (file)
--- a/src/lib-login/login-server.h
+++ b/src/lib-login/login-server.h
@@ -1,6 +1,9 @@
 #ifndef LOGIN_SERVER_H
 #define LOGIN_SERVER_H
 
+/* This login-server API is used by post-login processes (e.g. imap) to accept
+   a login request sent by the pre-login processes via login-client API. */
+
 #include "login-client.h"
 
 #define LOGIN_SERVER_POSTLOGIN_TIMEOUT_DEFAULT 60